Permalink
Browse files

Fixed code documentation thanks to warnings from the appledoc...

  • Loading branch information...
1 parent c3639e5 commit a050b89c5e4f6d6b7865a5e1d24cc3949b2dcd49 @tomaz committed Sep 26, 2010
@@ -18,7 +18,7 @@
use specialized exception names, this makes sense...
@param format A human readable message string representing exception reason.
- @param ... Variable information to be inserted into the formatted reason.
+ @param ... A comma separated list of arguments to substitute into the format.
@exception NSException Always thrown ;)
*/
+ (void)raise:(NSString *)format, ...;
@@ -32,7 +32,7 @@
@param error The error that describes the reason.
@param format A human readable message string explaining the context of the error.
- @param ... Variable information to be inserted into the formatted reason.
+ @param ... A comma separated list of arguments to substitute into the format.
@exception NSException Always thrown ;)
@see exceptionWithError:format:
*/
@@ -31,7 +31,6 @@
The main purpose of this method is to strip and wordifiy long descriptions by making them suitable for logging and debug messages.
- @param string String to strip.
@return Returns stripped description.
@see normalizedDescriptionFromString:
@see maxNormalizedDescriptionLength
View
@@ -47,7 +47,7 @@
@warning *Note:* If another instance of the ivar with the same name is registered, an exception is thrown.
- @param protocol The ivar to register.
+ @param ivar The ivar to register.
@exception NSException Thrown if the given ivar is already registered.
*/
- (void)registerIvar:(GBIvarData *)ivar;
View
@@ -25,7 +25,7 @@
Internally this sends allocated instance `initWithName:types:var:terminationMacros:` message, so check it's documentation for details.
- @param argument The name of the method argument, part of method selector.
+ @param name The name of the method argument, part of method selector.
@param types Array of argument types in the form of `NSString` instances or `nil` if not used.
@param var Array of arguments in the form of `GBMethodArgument` instances or `nil` if not used.
@param macros Array of variable arg termination macros or `nil` if not variable arg.
@@ -39,7 +39,7 @@
Internally this sends allocated instance `initWithName:types:var:terminationMacros:` message, so check it's documentation for details.
- @param argument The name of the method argument, part of method selector.
+ @param name The name of the method argument, part of method selector.
@param types Array of argument types in the form of `NSString` instances or `nil` if not used.
@param var Array of arguments in the form of `GBMethodArgument` instances or `nil` if not used.
@return Returns initialized object or `nil` if initialization fails.
@@ -52,7 +52,7 @@
Internally this sends allocated instance `initWithName:types:var:terminationMacros:` message, so check it's documentation for details.
- @param argument The name of the method argument, part of method selector.
+ @param name The name of the method argument, part of method selector.
@return Returns initialized object or `nil` if initialization fails.
@exception NSException Thrown if the argument is `nil` or empty string.
@see initWithName:
View
@@ -56,7 +56,7 @@ typedef NSUInteger GBMethodType;
/** Returns autoreleased property data with the given parameters.
- @param type The type of method defined by `GBMethodType` enumeration.
+ @param attributes Array of property attributes in the form of `NSString` instances.
@param components Array of resulting types with last item as property name in the form of `NSString` instances.
@return Returns initialized object or `nil` if initialization fails.
@exception NSException Thrown if either of the given parameters is invalid.
View
@@ -22,11 +22,11 @@
/// @name Declared files handling
///---------------------------------------------------------------------------------------
-/** Registers the given `GBDeclaredFileData` to `sourceInfos` list.
+/** Registers the given `GBSourceInfo` to `sourceInfos` list.
If file data with the same filename already exists in the set, it is replaced with the given one.
- @param filename The name of the file to register.
+ @param data Source information data.
@exception NSException Thrown if the given filename is `nil` or empty.
*/
- (void)registerSourceInfo:(GBSourceInfo *)data;
@@ -38,7 +38,7 @@
*/
- (NSArray *)sourceInfosSortedByName;
-/** The list of all declared file data as `GBDeclaredFileData` objects.
+/** The list of all declared file data as `GBSourceInfo` objects.
@see registerSourceInfo:
@see sourceInfosSortedByName
View
@@ -18,7 +18,7 @@
/// @name Initialization & disposal
///---------------------------------------------------------------------------------------
-/** Returns a new autoreleased `GBDeclaredFileData` with the given values.
+/** Returns a new autoreleased `GBSourceInfo` with the given values.
@param filename The name of the file without path.
@param lineNumber Line number within the file.
@@ -37,7 +37,7 @@
@warning *Important:* Note that the given _data_ must not be `nil`. The behavior is undefined in such case!
- @param data `GBDeclaredFileData` to compare with.
+ @param data `GBSourceInfo` to compare with.
@return `NSOrderedAscending` if the value of _data_ is greater than the receiver, `NSOrderedSame` if they’re equal, and `NSOrderedDescending` if the _data_ is less than the receiver.
*/
- (NSComparisonResult)compare:(GBSourceInfo *)data;
View
@@ -58,7 +58,7 @@
@warning *Note:* If another instance of the protocol with the same name name is registered, an exception is thrown.
- @param category The category to register.
+ @param protocol The protocol to register.
@exception NSException Thrown if the given protocol is already registered.
@see registerClass:
@see registerCategory:
View
@@ -38,6 +38,7 @@
/** Returns initialized autoreleased instance using the given source `PKTokenizer`.
@param tokenizer The underlying (worker) tokenizer to use for actual splitting.
+ @param filename The name of the file without path used for generating source info.
@return Returns initialized instance or `nil` if failed.
@exception NSException Thrown if the given tokenizer or filename is `nil` or filename is empty string.
*/
@@ -117,7 +118,7 @@
/// @name Information handling
///---------------------------------------------------------------------------------------
-/** Returns `GBDeclaredFileData` for current token and filename.
+/** Returns `GBSourceInfo` for current token and filename.
This is equivalent to sending `fileDataForToken:` and passing `currentToken` as the _token_ parameter.
@@ -127,7 +128,7 @@
*/
- (GBSourceInfo *)fileDataForCurrentToken;
-/** Returns `GBDeclaredFileData` object describing the given token source information.
+/** Returns `GBSourceInfo` object describing the given token source information.
The method converts the given token's offset within the input string to line number and uses that information together with assigned `filename` to prepare the token info object.

0 comments on commit a050b89

Please sign in to comment.