Permalink
Browse files

Set up a task to generate documentation, fixed @name block format.

  • Loading branch information...
1 parent 328684d commit 2d2c969bd7a78641b51bfc195228867d4c06a5f1 @lukeredpath committed Jul 16, 2011
Showing with 31 additions and 21 deletions.
  1. +2 −0 .gitignore
  2. +25 −21 Classes/LRMocky/LRMockery.h
  3. +4 −0 Rakefile
  4. 0 docs/.empty
View
@@ -10,6 +10,8 @@
*.pbxuser
*.xcodeproj/project.xcworkspace/xcuserdata/*.xcuserdatad/*.xcuserstate
+docs/generated
+
# Generated files
VersionX-revision.h
@@ -15,14 +15,18 @@
@class LRMockyStateMachine;
@class LRMockObject;
+
+/** Represents a context in which mocks are created and verified.
+
+ */
@interface LRMockery : NSObject {
NSMutableArray *expectations;
id<LRTestCaseNotifier> testNotifier;
}
-/*--------------------------------------------------------------------------------------
- * @name Creating and initializing Mockeries
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Creating and initializing Mockeries
+///------------------------------------------------------------------------------------/
/** Creates a mocking context for a generic test case.
@@ -53,9 +57,9 @@
*/
- (id)initWithNotifier:(id<LRTestCaseNotifier>)aNotifier;
-/*--------------------------------------------------------------------------------------
- * @name Creating mocks
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Creating mocks
+///------------------------------------------------------------------------------------/
/** Creates a new class mock object.
@@ -87,9 +91,9 @@
*/
- (id)protocolMock:(Protocol *)protocol;
-/*--------------------------------------------------------------------------------------
- * @name Expecting NSNotifications
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Expecting NSNotifications
+///------------------------------------------------------------------------------------/
/** Sets an expectation that a NSNotification will be posted.
@@ -112,9 +116,9 @@
*/
- (void)expectNotificationNamed:(NSString *)name fromObject:(id)sender;
-/*--------------------------------------------------------------------------------------
- * @name Creating state machines
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Creating state machines
+///------------------------------------------------------------------------------------/
/** Creates a new state machine.
@@ -134,9 +138,9 @@
*/
- (LRMockyStateMachine *)states:(NSString *)name defaultTo:(NSString *)defaultState;
-/*--------------------------------------------------------------------------------------
- * @name Setting up expectations
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Setting up expectations
+///------------------------------------------------------------------------------------/
/** Starts a new expectation checking block.
@@ -163,9 +167,9 @@
*/
- (void)addExpectation:(id<LRExpectation>)expectation;
-/*--------------------------------------------------------------------------------------
- * @name Checking expectations
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Checking expectations
+///------------------------------------------------------------------------------------/
/** Evaluates all expectations to check that they are satisfied.
@@ -182,9 +186,9 @@
*/
- (void)assertSatisfied;
-/*--------------------------------------------------------------------------------------
- * @name Resetting the current context
- *-------------------------------------------------------------------------------------*/
+///------------------------------------------------------------------------------------/
+/// @name Resetting the current context
+///------------------------------------------------------------------------------------/
/** Removes all expectations from the current context. */
- (void)reset;
View
@@ -0,0 +1,4 @@
+desc "Generate documentation"
+task :docs do
+ system("appledoc --no-search-undocumented-doc --keep-intermediate-files --verbose 1 --output docs/generated --project-name Mocky Classes/")
+end
View
No changes.

0 comments on commit 2d2c969

Please sign in to comment.