Skip to content
Browse files

Fixed comment warnings for various objects.

  • Loading branch information...
1 parent 04344cc commit d6b842bd18bc239720440f57c648e62752868ca7 @tomaz committed
View
4 Application/GBApplicationSettingsProvider.h
@@ -156,7 +156,7 @@
If `YES`, HTML files from html subdirectory in `outputPath` are moved to proper subdirectory within docset output files, then helper files are generated from parsed data. Documentation set files are also indexed. If `NO`, HTML files are left in the output path.
- @see createHtml
+ @see createHTML
@see installDocSet
@see publishDocSet
*/
@@ -364,7 +364,7 @@
This is simply a helper method for `htmlReferenceForObject:fromSource:`, passing the given object as object parameter and `nil` as source.
- @pram object The object for which to generate the reference to.
+ @param object The object for which to generate the reference to.
@return Returns the reference string.
@exception NSException Thrown if object is `nil`.
@see htmlReferenceForObject:fromSource:
View
13 Application/GBCommentComponentsProvider.h
@@ -38,9 +38,6 @@
@warning *Important:* Note that the given string must contain exactly one `%@` marker. If none is included cross references will not be matched during runtime. If more than one is included, unpredicted behavior may occur. So take care!
@warning *Important:* This value must be set before accessing any cross reference regex property! The accessors prepare and cache the value on first usage. From then on, cached value is returned, so any change is not propagated!
-
- @param string The string containing cross reference markers template.
- @exception NSException Raised if the given string doesn't contain `%@` string.
*/
@property (copy) NSString *crossReferenceMarkersTemplate;
@@ -100,7 +97,7 @@
The result of the method depends on the templated value: if the value is `YES`, the string includes template from `crossReferenceMarkersTemplate`, otherwise it only contains "pure" regex. The first option should be used for in-text cross references detection, while the second for `crossReferenceRegex` matching.
- @param templates If `YES` templated regex is returned, otherwise pure one.
+ @param templated If `YES` templated regex is returned, otherwise pure one.
@return Returns the regex used for matching cross reference.
*/
- (NSString *)remoteMemberCrossReferenceRegex:(BOOL)templated;
@@ -109,7 +106,7 @@
The result of the method depends on the templated value: if the value is `YES`, the string includes template from `crossReferenceMarkersTemplate`, otherwise it only contains "pure" regex. The first option should be used for in-text cross references detection, while the second for `crossReferenceRegex` matching.
- @param templates If `YES` templated regex is returned, otherwise pure one.
+ @param templated If `YES` templated regex is returned, otherwise pure one.
@return Returns the regex used for matching cross reference.
*/
- (NSString *)localMemberCrossReferenceRegex:(BOOL)templated;
@@ -118,7 +115,7 @@
The result of the method depends on the templated value: if the value is `YES`, the string includes template from `crossReferenceMarkersTemplate`, otherwise it only contains "pure" regex. The first option should be used for in-text cross references detection, while the second for `crossReferenceRegex` matching.
- @param templates If `YES` templated regex is returned, otherwise pure one.
+ @param templated If `YES` templated regex is returned, otherwise pure one.
@return Returns the regex used for matching cross reference.
*/
- (NSString *)categoryCrossReferenceRegex:(BOOL)templated;
@@ -127,7 +124,7 @@
The result of the method depends on the templated value: if the value is `YES`, the string includes template from `crossReferenceMarkersTemplate`, otherwise it only contains "pure" regex. The first option should be used for in-text cross references detection, while the second for `crossReferenceRegex` matching.
- @param templates If `YES` templated regex is returned, otherwise pure one.
+ @param templated If `YES` templated regex is returned, otherwise pure one.
@return Returns the regex used for matching cross reference.
*/
- (NSString *)objectCrossReferenceRegex:(BOOL)templated;
@@ -136,7 +133,7 @@
The result of the method depends on the templated value: if the value is `YES`, the string includes template from `crossReferenceMarkersTemplate`, otherwise it only contains "pure" regex. The first option should be used for in-text cross references detection, while the second for `crossReferenceRegex` matching.
- @param templates If `YES` templated regex is returned, otherwise pure one.
+ @param templated If `YES` templated regex is returned, otherwise pure one.
@return Returns the regex used for matching cross reference.
*/
- (NSString *)urlCrossReferenceRegex:(BOOL)templated;
View
1 Common/NSException+GBException.h
@@ -34,7 +34,6 @@
@param format A human readable message string explaining the context of the error.
@param ... A comma separated list of arguments to substitute into the format.
@exception NSException Always thrown ;)
- @see exceptionWithError:format:
*/
+ (void)raise:(NSError *)error format:(NSString *)format, ...;
View
6 Common/NSString+GBString.h
@@ -55,18 +55,18 @@
@return Returns stripped description.
@see normalizedDescriptionWithMaxLength:
- @see maxNormalizedDescriptionLength
+ @see defaultNormalizedDescriptionLength
*/
- (NSString *)normalizedDescription;
/** Returns normalized description from the receiver.
The main purpose of this method is to strip and wordifiy long descriptions by making them suitable for logging and debug messages.
-
+
@param length Maximum length of the description.
@return Returns stripped description.
@see normalizedDescriptionWithMaxLength:
- @see maxNormalizedDescriptionLength
+ @see defaultNormalizedDescriptionLength
*/
- (NSString *)normalizedDescriptionWithMaxLength:(NSUInteger)length;
View
6 Generating/GBDictionaryTemplateLoader.h
@@ -21,7 +21,11 @@
/// @name Initialization & disposal
///---------------------------------------------------------------------------------------
-/** Returns a new autoreleased `GBDictionaryTemplateLoader` instance. */
+/** Returns a new autoreleased `GBDictionaryTemplateLoader` instance.
+
+ @param partials The dictionary of all partials.
+ @return Returns initialized instance.
+ */
+ (id)loaderWithDictionary:(NSDictionary *)partials;
/** Initializes the template loader with the given dictionary of partials.
View
5 Generating/GBOutputGenerator.h
@@ -86,6 +86,11 @@
/** Copies or moves directory or file from the given source path to the destination path.
This method takes into account `[GBApplicationSettings keepIntermediateFiles]` and either copies or moves files regarding it's value. The method is designed to be used from within subclasses.
+
+ @param source Source path to copy or move from.
+ @param destination Destination path to copy or move to.
+ @param error If copying fails, error description is returned here.
+ @return Returns `YES` if all files were succesfully copied, `NO` otherwise.
*/
- (BOOL)copyOrMoveItemFromPath:(NSString *)source toPath:(NSString *)destination error:(NSError **)error;
View
4 Generating/GBTemplateHandler.h
@@ -50,13 +50,13 @@
The results are parsed into `templateString` and `templateSections`. After reading the template from the file, you can re-use the class for generating all objects that need to be templated from read template. That is, there's no need of re-parsing the same template for each generation.
- @param path The template string to parse.
+ @param string The template string to parse.
@param error If parsing fails, error message is returned here.
@return Returns `YES` if parsing was sucesful, `NO` otherwise.
@see parseTemplateFromPath:error:
@see renderObject:
*/
-- (BOOL)parseTemplate:(NSString *)template error:(NSError **)error;
+- (BOOL)parseTemplate:(NSString *)string error:(NSError **)error;
///---------------------------------------------------------------------------------------
/// @name Rendering
View
6 Model/GBMethodArgument.h
@@ -31,7 +31,7 @@
@param macros Array of variable arg termination macros or `nil` if not variable arg.
@return Returns initialized object or `nil` if initialization fails.
@exception NSException Thrown if either of the given parameters is invalid.
- @see initWithName:types:var:
+ @see initWithName:types:var:terminationMacros:
*/
+ (id)methodArgumentWithName:(NSString *)name types:(NSArray *)types var:(NSString *)var terminationMacros:(NSArray *)macros;
@@ -44,7 +44,7 @@
@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.
@exception NSException Thrown if either of the given parameters is invalid.
- @see initWithName:types:var:
+ @see initWithName:types:var:terminationMacros:
*/
+ (id)methodArgumentWithName:(NSString *)name types:(NSArray *)types var:(NSString *)var;
@@ -55,7 +55,7 @@
@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:
+ @see initWithName:types:var:terminationMacros:
*/
+ (id)methodArgumentWithName:(NSString *)name;
View
2 Model/GBMethodsProvider.h
@@ -85,7 +85,7 @@
@see registerSectionWithName:
@see registerMethod:
@see methods
- @see hadSections
+ @see hasSections
*/
@property (readonly) NSArray *sections;
View
2 Model/GBModelBase.h
@@ -35,7 +35,7 @@
@see sourceInfos
@see registerSourceInfo:
- @see prefferedSourceInfo:
+ @see prefferedSourceInfo
*/
- (NSArray *)sourceInfosSortedByName;
View
2 Model/GBParagraphItem.h
@@ -50,8 +50,6 @@
By default this returns string value trimmed to a predefined maximum length, but subclasses can override to provide their specific implementation. This is only used for debugging purposes and should not be used for any output generation! See `description` method implementation for details.
Sending this message is equivalent to sending `descriptionForStringValue:` to receiver and passing it `stringValue` as the parameter.
-
- @see descriptionStringValueFromValue:
*/
@property (readonly) NSString *descriptionStringValue;
View
21 Parsing/GBTokenizer.h
@@ -63,8 +63,8 @@
/** Returns the current token.
- @see consume
- @see lookahead
+ @see consume:
+ @see lookahead:
*/
- (PKToken *)currentToken;
@@ -74,7 +74,7 @@
@param offset The offset from the current position.
@return Returns the token at the given offset or EOF token if offset point after EOF.
- @see consume
+ @see consume:
*/
- (PKToken *)lookahead:(NSUInteger)offset;
@@ -83,7 +83,8 @@
This effectively "moves" `currentToken` to the new position. If EOF is reached before consuming the given ammount of tokens, consuming stops at the end of stream and `currentToken` returns EOF token. If comment tokens are detected while consuming, they are not counted and consuming count continues with actual language tokens. However if there is a comment just before the next current token (i.e. after the last consumed token), the comment data is saved and is available through `lastCommentString`. Otherwise last comment data is cleared, even if a comment was detected in between.
@param count The number of tokens to consume.
- @see lastCommentString
+ @see lastComment
+ @see previousComment
*/
- (void)consume:(NSUInteger)count;
@@ -94,7 +95,8 @@
@param end Ending token.
@param block The block to be called for each token.
@exception NSException Thrown if the given end token is `nil`.
- @see lastCommentString
+ @see lastComment
+ @see previousComment
*/
- (void)consumeTo:(NSString *)end usingBlock:(void (^)(PKToken *token, BOOL *consume, BOOL *stop))block;
@@ -106,7 +108,8 @@
@param end Ending token.
@param block The block to be called for each token.
@exception NSException Thrown if the given end token is `nil`.
- @see lastCommentString
+ @see lastComment
+ @see previousComment
*/
- (void)consumeFrom:(NSString *)start to:(NSString *)end usingBlock:(void (^)(PKToken *token, BOOL *consume, BOOL *stop))block;
@@ -122,11 +125,11 @@
/** Returns `GBSourceInfo` for current token and filename.
- This is equivalent to sending `fileDataForToken:` and passing `currentToken` as the _token_ parameter.
+ This is equivalent to sending `sourceInfoForToken:` and passing `currentToken` as the _token_ parameter.
@return Returns declared file data.
@exception NSException Thrown if current token is `nil`.
- @see fileDataForToken:
+ @see sourceInfoForToken:
*/
- (GBSourceInfo *)sourceInfoForCurrentToken;
@@ -137,7 +140,7 @@
@param token The token for which to get file data.
@return Returns declared file data.
@exception NSException Thrown if the given token is `nil`.
- @see fileDataForCurrentToken
+ @see sourceInfoForCurrentToken
*/
- (GBSourceInfo *)sourceInfoForToken:(PKToken *)token;

0 comments on commit d6b842b

Please sign in to comment.
Something went wrong with that request. Please try again.