Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed warnings due to invalid cross references in various comments.

  • Loading branch information...
commit e2c8832263c6dedbf6974dc3f903102cd8784d29 1 parent c68cb86
@tomaz authored
View
10 Application/GBApplicationSettingsProvider.h
@@ -154,7 +154,7 @@
/// @name Behavior handling
///---------------------------------------------------------------------------------------
-/** Indicates whether HTML files should be generated or not.
+/* Indicates whether HTML files should be generated or not.
If `YES`, HTML files are generated in `outputPath` from parsed and processed data. If `NO`, input files are parsed and processed, but nothing is generated.
@@ -212,7 +212,7 @@
*/
@property (assign) BOOL repeatFirstParagraphForMemberDescription;
-/* Indicates whether undocumented classes, categories or protocols should be kept or ignored when generating output.
+/** Indicates whether undocumented classes, categories or protocols should be kept or ignored when generating output.
If `YES` undocumented objects are kept and are used for output generation. If `NO`, these objects are ignored, but only if all their members are also not documented - as soon as a single member is documented, the object is included in output together with all of it's documented members.
@@ -228,7 +228,7 @@
*/
@property (assign) BOOL keepUndocumentedObjects;
-/* Indicates whether undocumented methods or properties should be processed or not.
+/** Indicates whether undocumented methods or properties should be processed or not.
If `YES`, undocumented members are still used for output generation. If `NO`, these members are ignored, as if they are not part of the object. Note that this only affects documented objects: if an object is not documented and none of it's members is documented, the object is not processed for output, even if this value is `YES`!
@@ -488,7 +488,7 @@
@param path The path to convert.
@return Returns filename that can be used for output.
- @see isPathRepresentingTemplateFile
+ @see isPathRepresentingTemplateFile:
@see templateFilenameForOutputPath:
*/
- (NSString *)outputFilenameForTemplatePath:(NSString *)path;
@@ -499,7 +499,7 @@
@param path The path to convert.
@return Returns template filename.
- @see isPathRepresentingTemplateFile
+ @see isPathRepresentingTemplateFile:
@see outputFilenameForTemplatePath:
*/
- (NSString *)templateFilenameForOutputPath:(NSString *)path;
View
2  Common/NSString+GBString.h
@@ -17,7 +17,7 @@
/** Trims all characters from the given set from the string end.
- Works the same way as `[NSString stringByTrimmingCharactersInSetFromEnd:]` except it trims from end only.
+ Works the same way as `[NSString(GBString) stringByTrimmingCharactersInSetFromEnd:]` except it trims from end only.
@param set The set of characters to trim.
@return Returns trimmed string.
View
5 Generating/GBOutputGenerator.h
@@ -72,7 +72,7 @@
/** 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.
+ This method takes into account `[GBApplicationSettingsProvider 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.
@@ -87,7 +87,6 @@
@param store The `GBStore` object that holds the store with all parsed and processed data.
@param error If generation fails, error description is returned here.
- @see copyTemplateFilesToOutputPath:
@see writeString:toFile:error:
@see store
*/
@@ -138,8 +137,6 @@
/** Returns the path relative to main output path, where all generated data is stored.
At the same this, this also defines the path relative to main templates path, where all template files for this output generator are stored. Default implementation simply returns empty string, each subclass is supposed to override and return prover value.
-
- @see copyTemplateFilesToOutputPath:
*/
@property (readonly) NSString *outputSubpath;
View
1  Generating/GBTemplateFilesHandler.h
@@ -30,7 +30,6 @@
@param error If copying fails, error description is returned here.
@return Returns `YES` if all files were succesfully copied, `NO` otherwise.
- @see generateOutputWithStore:error:
*/
- (BOOL)copyTemplateFilesToOutputPath:(NSError **)error;
View
4 Model/GBCommentComponent.h
@@ -32,7 +32,7 @@
@param value String value to set.
@return Returns initialized object or `nil` if initialization fails.
- @see commentWithStringValue:sourceInfo:
+ @see componentWithStringValue:sourceInfo:
*/
+ (id)componentWithStringValue:(NSString *)value;
@@ -43,7 +43,7 @@
@param value String value to set.
@param info Source info to set.
@return Returns initialized object or `nil` if initialization fails.
- @see commentWithStringValue:
+ @see componentWithStringValue:
*/
+ (id)componentWithStringValue:(NSString *)value sourceInfo:(GBSourceInfo *)info;
View
2  Model/GBStore.h
@@ -89,7 +89,7 @@
@param document The document to register.
@exception NSException Thrown if the given document is already registered.
- @see documentWithPath:
+ @see documentWithName:
@see documents
*/
- (void)registerDocument:(GBDocumentData *)document;
View
2  Processing/GBCommentsProcessor.h
@@ -52,7 +52,7 @@
@param context The object identifying current context for handling links or `nil`.
@param store The store to process against.
@exception NSException Thrown if any of the given parameters is invalid or processing encounters unexpected error.
- @see repeatFirstParagraph
+ @see alwaysRepeatFirstParagraph
*/
- (void)processComment:(GBComment *)comment withContext:(id)context store:(id)store;
Please sign in to comment.
Something went wrong with that request. Please try again.