Methods missing from appledoc #208

Open
drekka opened this Issue Apr 7, 2012 · 2 comments

Comments

Projects
None yet
2 participants
@drekka

drekka commented Apr 7, 2012

I'm not sure exactly what is happening, but in a particular header file, appledoc is skipping over the documentation of a number of methods, removing it and the methods themselves, and the @name sections from the output. I've included the offending header file below so this can be analysed. \n\nIn the docset I get, only the 'Properties' and 'Pauses and waits' @name tags are outputted to the html. It also appears to be ignore the following method declarations:\n\n\n+(SIUIApplication *) application;\n-(NSArray *) findViewsWithQuery:(NSString *) query;\n-(void) logUITree;\n-(UIView *) tapViewWithQuery:(NSString *) query;\n-(UIView *) swipeView:(UIView *) view inDirection:(SIUISwipeDirection) swipeDirection forDistance:(int) distance;\n-(void) enterText:(NSString *) text intoView:(UIView *) view;\n\n\nHere is the header file:\n\n\n\/\/\n\/\/ SIUIUtils.h\n\/\/ Simon\n\/\/\n\/\/ Created by Derek Clarkson on 7\/23\/11.\n\/\/ Copyright 2011. All rights reserved.\n\/\/\n\n#import <UIKit\/UIKit.h>\n#import \"SIUIConstants.h\"\n#import \"SIUIViewHandlerFactory.h\"\n#import \"SIUIViewDescriptionVisitorDelegate.h\"\n\n\/**\n Provides tools for accessing the UI of a running application.\n *\/\n@interface SIUIApplication : NSObject<SIUIViewDescriptionVisitorDelegate> \n\n\/\/\/ @name Properties\n\n\/\/\/ Factory which is used to generate view handlers for talking to UIView objects returned from queries. You can set this to a custom factory for implementing your own view handlers.\n@property (retain, nonatomic) SIUIViewHandlerFactory *viewHandlerFactory;\n\n\/\/\/ If set to YES, disables the auto correction of entered text via the keyboard when using the enterText:intoField: method. This is useful for testing.\n@property (nonatomic) BOOL disableKeyboardAutocorrect;\n\n#pragma mark - Accessors\n\n\/** @name Singleton accessors *\/\n\n\/**\n Accesses the SIUIApplication singleton.\n *\/\n+(SIUIApplication *) application;\n\n#pragma mark - Finding\n\n\/** @name Finding things *\/\n\n\/**\n Executes the given query against the current window to locate one or more UIViews. Given that all interface controls inherit from UIView, this gives us the ability to locate any control on the display.\n \n This maps the xpath to the UI display by using class names of the controls as the xpath node names. \n \n @param query an xpath as decribed by the dXpath static library.\n *\/\n-(NSArray *) findViewsWithQuery:(NSString *) query;\n\n\/**\n Override of findViewsWithQuery: which expects to return only a single view.\n This is more strict because it will generate errors if 0 or multiple controls are found instead of the expected control.\n \n @param query an xpath as decribed by the dXpath static library.\n *\/\n-(UIView *) findViewWithQuery:(NSString *) query;\n\n\/**\n returns YES if the query returns one or more UIViews. \n \n @param query an xpath as decribed by the dXpath static library.\n *\/\n-(BOOL) isViewPresent:(NSString *) query;\n\n#pragma mark - Logging\n\n\/\/\/ @name Logging\n\n\/**\n Simple method which prints a tree view of the current UI to the console.\n *\/\n-(void) logUITree;\n\n#pragma mark - Tapping\n\n\/\/\/ @name Tapping\n\n\/**\n Locates a single UIView based on the passed query and taps at the exact center of that view.\n \n @param query the query that will locate the view. Zero or multiple returns from that query will trigger an error.\n @return the view that was tapped.\n *\/\n-(UIView *) tapViewWithQuery:(NSString *) query;\n\n\/**\n Locates a single UIView based on the passed query and taps at the specified location.\n \n @param query the query that will locate the view. Zero or multiple returns from that query will trigger an error.\n @param atPoint where to tap the view.\n @return the view that was tapped.\n *\/\n-(UIView *) tapViewWithQuery:(NSString *) query atPoint:(CGPoint) atPoint;\n\n\/**\n Searches for a button with a specific label taps it.\n \n @param label the text label of the icon we want to tap.\n *\/\n-(void) tapButtonWithLabel:(NSString *) label;\n\n\/**\n Taps the specified view.\n \n @param view the UIView to be tapped.\n @return the view that was tapped.\n *\/\n-(UIView *) tapView:(UIView *) view;\n\n\/**\n Taps the specified view at the specified location.\n \n @param view the UIView to be tapped.\n @param atPoint where to tap the view.\n @return the view that was tapped.\n *\/\n-(UIView *) tapView:(UIView *) view atPoint:(CGPoint) atPoint;\n\n\/**\n Searches for a button with a specific label taps it, then waits for the specified period of time before returning. \n \n @param label the text label of the icon we want to tap.\n @param seconds how many seconds or partial seconds to wait before continuing the current thread.\n *\/\n-(void) tapButtonWithLabel:(NSString *) label andWait:(NSTimeInterval) seconds;\n\n\/**\n Searches for a tab bar and taps the button with the passed label.\n \n @param label the text label of the icon we want to tap.\n *\/\n-(void) tapTabBarButtonWithLabel:(NSString *) label;\n\n#pragma mark - Swiping\n\n\/\/\/ @name Swiping\n\n\/**\n Performs a swipe on the specified UIView. Currently there are 4 basic directions.\n \n @param view a UIView we want to swipe. The swipe will start from the center of that UIView.\n @param swipeDirection a value from SIUISwipeDirection indicting the direction to swipe in.\n @param distance how far to swipe in the given direction.\n @return the swiped view.\n *\/\n-(UIView *) swipeView:(UIView *) view inDirection:(SIUISwipeDirection) swipeDirection forDistance:(int) distance;\n\n\/**\n Performs a swipe on the UIView returned from the query. Currently there are 4 basic directions.\n \n @param query a string containing the DNodi query that will locate the UIView we want to swipe. The swipe will start from the center of that UIView.\n @param swipeDirection a value from SIUISwipeDirection indicting the direction to swipe in.\n @param distance how far to swipe in the given direction.\n @return the swiped view.\n *\/\n-(UIView *) swipeViewWithQuery:(NSString *) query inDirection:(SIUISwipeDirection) swipeDirection forDistance:(int) distance;\n\n#pragma mark - Waiting and holding\n\n\/\/\/ @name Pauses and waits\n\n\/**\n Pauses the current thread for the specified time. Use this to hold a background test thread whilst waiting for the UI to update.\n \n @param duration how long to hold the current thread for.\n *\/\n-(void) pauseFor:(NSTimeInterval) duration;\n\n\/**\n Examines the UI using the query. It the query sucessfully returns a single view, then this method ends and returns the view. If the query is not successful, the the method sleeps for the specified time interval and tries again. If the the maximum number of retries is reached doing this, an exception is raised.\n \n This method is of most use when there are animations involved in the display.\n \n @param query the query that should find the control.\n @param interval the time interval between attemts to find the control.\n @param maxRetrieves hows many times to attempt to find the control before giving up.\n @return the control if found.\n *\/\n-(UIView *) waitForViewWithQuery:(NSString *) query retryInterval:(NSTimeInterval) interval maxRetries:(int) maxRetries;\n\n\/**\n Waits for an animation to finish before returning. If the control is not present this method will first wait for it to appear by calling \n waitFirViewWithQuery:retryInterval:maxRetries using the same retryInterval and a maxRetries of 20.\n \n The process of assessing if an animation is finished is not simple. To achieve it we access the views CALayer and check it for animation\n keys. If there are none, we assume the animations have finished. Note that this takes into account any animations running on super views as well. So you can check a control which is on a view which is sliding on and it will be regarded as being animated even though the control itself is not.\n\n @param query the query that should find the control.\n @param interval the time interval between animation checks.\n*\/ \n-(void) waitForAnimationEndOnViewWithQuery:(NSString *) query retryInterval:(NSTimeInterval) interval;\n\n#pragma mark - Text\n\n\/\/\/ @name Text\n\n\/**\n Ensures that the specified view has focus and then enters the text into it.\n \n @param text the text we want to enter.\n @param view the view to enter the text into.\n *\/\n-(void) enterText:(NSString *) text intoView:(UIView *) view;\n\n\/**\n Ensures that the specified view based on a query has focus and then enters the text into it.\n \n @param text the text we want to enter.\n @param query the query that should find the control.\n *\/\n-(void) enterText:(NSString *) text intoViewWithQuery:(NSString *) query;\n\n@end\n\n\n

@tomaz

This comment has been minimized.

Show comment Hide comment
@tomaz

tomaz Apr 7, 2012

Owner

Will take a look. I remember seing this bug before, but can't find the issue right now.

Owner

tomaz commented Apr 7, 2012

Will take a look. I remember seing this bug before, but can't find the issue right now.

@drekka

This comment has been minimized.

Show comment Hide comment
@drekka

drekka Apr 7, 2012

Thanks Tomaz, I have about 30 or 40 headers in the project and this is the only one I've noticed with a problem.

drekka commented Apr 7, 2012

Thanks Tomaz, I have about 30 or 40 headers in the project and this is the only one I've noticed with a problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment