Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slight omission when documenting variable arguments #98

Closed
timisted opened this issue Apr 25, 2011 · 3 comments
Closed

Slight omission when documenting variable arguments #98

timisted opened this issue Apr 25, 2011 · 3 comments
Labels

Comments

@timisted
Copy link

When documenting a method whose signature includes an ellipsis to indicate a variable number of arguments, the output omits the ellipsis at the end of the method signature.

Sorry for picking on something so minor, but this means the only indication in documentation that a method can take variable arguments is the presence of @param ....

Compare the Apple documentation of [NSString stringWithFormat:] and appledoc's own documentation for [GBTask runCommand:].

http://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSString_Class/Reference/NSString.html#//apple_ref/occ/clm/NSString/stringWithFormat:

stringWithFormat:

Returns a string created by using a given format string as a template into which the remaining argument values are substituted.

+ (id)stringWithFormat:(NSString *)format, ...
(note the ...)

http://www.gentlebytes.com/content/appledoc/exampledocv2/latest/Classes/GBTask.html#//api/name/runCommand:

runCommand:

Runs the command with optional arguments.

- (BOOL)runCommand:(NSString *)command
(note no ...)

@tomaz
Copy link
Owner

tomaz commented Apr 25, 2011

Got it, thanks for pointing it out. Looks like it should be minor change (but then you never know :))

@tomaz tomaz closed this as completed in 3d12257 Apr 25, 2011
@timisted
Copy link
Author

Wow - that was fast, thank you! Confirmed as working, even on my less-than-perfectly-marked-up source code.

@tomaz
Copy link
Owner

tomaz commented Apr 25, 2011

Glad my trying-to-cope-code got your less-than-perfectly-marked-up issue fixed - perfect match I guess ;)

I'm still quite busy with other projects, but got some time to cleanup some of the most "embarrassing" bugs (I'm thinking of you #77 :) and this one was really simple, so it sounded like a perfect choice for warming up :) Glad it works...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants