Permalink
Browse files

Appledoc

  • Loading branch information...
1 parent ce6b6d1 commit c2aedda55306981418e80efb3defd6f08216b3d1 @gabriel gabriel committed Aug 12, 2011
Showing with 2,421 additions and 2,594 deletions.
  1. +2 −2 .gitignore
  2. +3 −0 Classes-iOS/GHUnitIOSAppDelegate.h
  3. +3 −0 Classes-iOS/GHUnitIOSTableViewDataSource.h
  4. +3 −0 Classes-iOS/GHUnitIOSTestViewController.h
  5. +3 −1 Classes-iOS/GHUnitIOSView.h
  6. +4 −2 Classes-iOS/GHUnitIOSViewController.h
  7. +52 −44 Classes/GHAsyncTestCase.h
  8. +1 −1 Classes/GHTest/GHTest+JUnitXML.h
  9. +100 −13 Classes/GHTest/GHTest.h
  10. +23 −12 Classes/GHTest/GHTestGroup.h
  11. +5 −4 Classes/GHTest/GHTestOperation.h
  12. +77 −18 Classes/GHTest/GHTestRunner.h
  13. +3 −3 Classes/GHTest/GHTestSuite.h
  14. +1 −1 Classes/GHTest/GHTestSuite.m
  15. +14 −7 Classes/GHTest/GHTesting.h
  16. +48 −42 Classes/GHTestCase.h
  17. +50 −19 Classes/GHTestMacros.h
  18. +0 −668 Classes/GHUnit.h
  19. +2 −6 Classes/Mock/GHMockNSHTTPURLResponse.h
  20. +42 −48 Classes/Mock/GHMockNSURLConnection.h
  21. +14 −11 Classes/Mock/GHNSLocale+Mock.h
  22. +16 −9 Classes/Mock/GHUNSObject+Swizzle.h
  23. +58 −9 Classes/SharedUI/GHTestViewModel.h
  24. +30 −0 Documentation/appledoc_include/guide_ci-template.markdown
  25. +66 −0 Documentation/appledoc_include/guide_command_line-template.markdown
  26. +59 −0 Documentation/appledoc_include/guide_install_ios_4-template.markdown
  27. +15 −0 Documentation/appledoc_include/guide_install_macosx_4-template.markdown
  28. +43 −0 Documentation/appledoc_include/guide_install_old-template.markdown
  29. +234 −0 Documentation/appledoc_include/guide_testing-template.markdown
  30. BIN Documentation/{Installing → appledoc_include/images}/10_main.png
  31. BIN Documentation/{Installing → appledoc_include/images}/11_select_target.png
  32. BIN Documentation/{Installing → appledoc_include/images}/12_running.png
  33. BIN Documentation/{Installing → appledoc_include/images}/13_adding_test.png
  34. BIN Documentation/{Installing → appledoc_include/images}/14_running_with_test.png
  35. BIN Documentation/{Installing → appledoc_include/images}/1_add_target.png
  36. BIN Documentation/{Installing → appledoc_include/images}/2_select_application.png
  37. BIN Documentation/{Installing → appledoc_include/images}/3_name_it.png
  38. BIN Documentation/{Installing → appledoc_include/images}/6_add_framework.png
  39. BIN Documentation/{Installing → appledoc_include/images}/7_add_framework_dialog.png
  40. BIN Documentation/{Installing → appledoc_include/images}/8_other_linker_flags.png
  41. BIN Documentation/{Installing → appledoc_include/images}/9_remove_test_files.png
  42. BIN Documentation/{Installing → appledoc_include/images}/9b_fix_plist.png
  43. BIN Documentation/{Installing → appledoc_include/images}/9c_fixed_plist.png
  44. BIN Documentation/{ → appledoc_include/images}/GHUnit-0.4.18.png
  45. BIN Documentation/{ → appledoc_include/images}/GHUnit-IPhone-0.4.18.png
  46. BIN Documentation/{RunningCLI/2_add_build_phase.png → appledoc_include/images/cli_2_add_build_phase.png}
  47. BIN Documentation/{RunningCLI/3_configure_phase.png → appledoc_include/images/cli_3_configure_phase.png}
  48. +32 −0 Documentation/index-template.markdown
  49. +18 −0 Documentation/index_desc.txt
  50. +0 −1,661 Doxyfile
  51. +1 −1 Libraries/GTM/Foundation/GTMNSString+XML.h
  52. +1 −0 Libraries/appledoc/Templates/docset/Contents/Resources/Documents/documents-template
  53. +60 −0 Libraries/appledoc/Templates/docset/Contents/Resources/nodes-template.xml
  54. +61 −0 Libraries/appledoc/Templates/docset/Contents/Resources/tokens-template.xml
  55. +38 −0 Libraries/appledoc/Templates/docset/Contents/info-template.plist
  56. +535 −0 Libraries/appledoc/Templates/html/css/styles.css
  57. +22 −0 Libraries/appledoc/Templates/html/css/stylesPrint.css
  58. +52 −0 Libraries/appledoc/Templates/html/document-template.html
  59. +91 −0 Libraries/appledoc/Templates/html/hierarchy-template.html
  60. BIN Libraries/appledoc/Templates/html/img/button_bar_background.png
  61. BIN Libraries/appledoc/Templates/html/img/disclosure.png
  62. BIN Libraries/appledoc/Templates/html/img/disclosure_open.png
  63. BIN Libraries/appledoc/Templates/html/img/library_background.png
  64. BIN Libraries/appledoc/Templates/html/img/title_background.png
  65. +95 −0 Libraries/appledoc/Templates/html/index-template.html
  66. +421 −0 Libraries/appledoc/Templates/html/object-template.html
  67. BIN Libraries/appledoc/appledoc
  68. +16 −9 Makefile
  69. +7 −3 README.md
View
@@ -4,8 +4,8 @@ build
*.pbxuser
*.perspectivev3
.DS_Store
-Documentation/html
-Documentation/GHUnit.docset.tgz
+Documentation/appledoc
+Documentation/output
*.tm_build_errors
*.swp
*~.nib
@@ -29,6 +29,9 @@
#import <UIKit/UIKit.h>
+/*!
+ Application delegate for the iOS test application.
+ */
@interface GHUnitIOSAppDelegate : NSObject <UIApplicationDelegate> {
UIWindow *window_;
@@ -30,6 +30,9 @@
#import <UIKit/UIKit.h>
#import "GHTestViewModel.h"
+/*
+ Table view data source for iOS test application.
+ */
@interface GHUnitIOSTableViewDataSource : GHTestViewModel <UITableViewDataSource> {
}
@@ -30,6 +30,9 @@
#import <UIKit/UIKit.h>
#import "GHTestViewModel.h"
+/*
+ View controller for a test.
+ */
@interface GHUnitIOSTestViewController : UIViewController <GHTestRunnerDelegate> {
UITextView *textView_;
@@ -30,7 +30,9 @@
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
-
+/*
+ Main view for iOS test application.
+ */
@interface GHUnitIOSView : UIView {
UISearchBar *searchBar_;
@@ -32,17 +32,19 @@
#import "GHUnitIOSTableViewDataSource.h"
#import "GHUnitIOSTestViewController.h"
+/*
+ Main view controller for the iOS test application.
+ */
@interface GHUnitIOSViewController : UIViewController <UITableViewDelegate, GHTestRunnerDelegate, UISearchBarDelegate> {
GHUnitIOSView *view_;
- //! Data source for table view
GHUnitIOSTableViewDataSource *dataSource_;
GHTestSuite *suite_;
UIBarButtonItem *runButton_;
- //! If set then we will no longer auto scroll as tests are run
+ // If set then we will no longer auto scroll as tests are run
BOOL userDidDrag_;
}
@@ -29,12 +29,14 @@
#import "GHTestCase.h"
-// Some default statuses to use; Or define and use your own
+/*!
+ Common wait statuses to use with waitForStatus:timeout:.
+ */
enum {
- kGHUnitWaitStatusUnknown = 0, //!< Unknown wait status
- kGHUnitWaitStatusSuccess, //!< Wait status success
- kGHUnitWaitStatusFailure, //!< Wait status failure
- kGHUnitWaitStatusCancelled //!< Wait status cancelled
+ kGHUnitWaitStatusUnknown = 0, // Unknown wait status
+ kGHUnitWaitStatusSuccess, // Wait status success
+ kGHUnitWaitStatusFailure, // Wait status failure
+ kGHUnitWaitStatusCancelled // Wait status cancelled
};
/*!
@@ -45,31 +47,31 @@ enum {
Be sure to call prepare before the asynchronous method (otherwise an exception will raise).
- @code
-
- @interface MyAsyncTest : GHAsyncTestCase { }
- @end
-
- @implementation MyAsyncTest
-
- - (void)testSuccess {
- [self prepare];
-
- // Do asynchronous task here
- [self performSelector:@selector(_succeed) withObject:nil afterDelay:0.1];
-
- [self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
- }
-
- - (void)_succeed {
- // Notice the forSelector points to the test above. This is so that
- // stray notifies don't error or falsely succeed other tests.
- // To ignore the check, forSelector can be NULL.
- [self notify:kGHUnitWaitStatusSuccess forSelector:@selector(testSuccess)];
- }
-
- @end
- @endcode
+ @interface MyAsyncTest : GHAsyncTestCase { }
+ @end
+
+ @implementation MyAsyncTest
+
+ - (void)testSuccess {
+ // Prepare for asynchronous call
+ [self prepare];
+
+ // Do asynchronous task here
+ [self performSelector:@selector(_succeed) withObject:nil afterDelay:0.1];
+
+ // Wait for notify
+ [self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
+ }
+
+ - (void)_succeed {
+ // Notify the wait. Notice the forSelector points to the test above.
+ // This is so that stray notifies don't error or falsely succeed other tests.
+ // To ignore the check, forSelector can be NULL.
+ [self notify:kGHUnitWaitStatusSuccess forSelector:@selector(testSuccess)];
+ }
+
+ @end
+
*/
@interface GHAsyncTestCase : GHTestCase {
@@ -96,7 +98,8 @@ enum {
/*!
Prepare and specify the selector we will use in notify.
- @param selector
+
+ @param selector Selector
*/
- (void)prepare:(SEL)selector;
@@ -106,48 +109,53 @@ enum {
Be sure to prepare before calling your asynchronous method.
For example,
- @code
- - (void)testFoo {
- [self prepare];
- // Do asynchronous task here
- [self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
- }
- @endcode
+ - (void)testFoo {
+ [self prepare];
+
+ // Do asynchronous task here
+
+ [self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
+ }
@param status kGHUnitWaitStatusSuccess, kGHUnitWaitStatusFailure or custom status
@param timeout Timeout in seconds
*/
- (void)waitForStatus:(NSInteger)status timeout:(NSTimeInterval)timeout;
/*!
- @deprecated
+ @param status kGHUnitWaitStatusSuccess, kGHUnitWaitStatusFailure or custom status
+ @param timeout Timeout in seconds
+ @deprecated Use waitForTimeout:
*/
- (void)waitFor:(NSInteger)status timeout:(NSTimeInterval)timeout;
/*!
Wait for timeout to occur.
Fails if we did _NOT_ timeout.
- @param timeout
+
+ @param timeout Timeout
*/
- (void)waitForTimeout:(NSTimeInterval)timeout;
/*!
Notify waiting of status for test selector.
+
@param status Status, for example, kGHUnitWaitStatusSuccess
- @param selector If not NULL, then will verify this selector is where we are waiting.
- This prevents stray asynchronous callbacks to fail a later test
+ @param selector If not NULL, then will verify this selector is where we are waiting. This prevents stray asynchronous callbacks to fail a later test.
*/
- (void)notify:(NSInteger)status forSelector:(SEL)selector;
/*!
Notify waiting of status for any selector.
+
@param status Status, for example, kGHUnitWaitStatusSuccess
*/
- (void)notify:(NSInteger)status;
/*!
- Run the run loops for the specified interval.
- @param interval
+ Run the run loops for the specified interval.
+
+ @param interval Interval
@author Adapted from Robert Palmer, pauseForTimeout
*/
- (void)runForInterval:(NSTimeInterval)interval;
@@ -35,7 +35,7 @@
/*!
Return test results in JUnit XML format for external parsing use
- (such as a Continuous Integration system like Hudson)
+ (such as a Continuous Integration system like Jenkins).
*/
- (NSString *)JUnitXML;
Oops, something went wrong.

0 comments on commit c2aedda

Please sign in to comment.