Add the ability to suppress warnings for undocumented parameters

tomaz · Nov 25, 2012 · 1558b36 · 1558b36
1 parent 3d23114
commit 1558b36
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/Application/GBAppledocApplication.m b/Application/GBAppledocApplication.m
@@ -61,6 +61,7 @@
 static NSString *kGBArgWarnOnMissingCompanyIdentifier = @"warn-missing-company-id";
 static NSString *kGBArgWarnOnUndocumentedObject = @"warn-undocumented-object";
 static NSString *kGBArgWarnOnUndocumentedMember = @"warn-undocumented-member";
+static NSString *kGBArgWarnOnUndocumentedParam = @"warn-undocumented-param";
 static NSString *kGBArgWarnOnEmptyDescription = @"warn-empty-description";
 static NSString *kGBArgWarnOnUnknownDirective = @"warn-unknown-directive";
 static NSString *kGBArgWarnOnInvalidCrossReference = @"warn-invalid-crossref";
@@ -301,6 +302,7 @@ - (void)application:(DDCliApplication *)app willParseOptions:(DDGetoptLongParser
 		{ kGBArgWarnOnMissingCompanyIdentifier,								0,		DDGetoptNoArgument },
 		{ kGBArgWarnOnUndocumentedObject,									0,		DDGetoptNoArgument },
 		{ kGBArgWarnOnUndocumentedMember,									0,		DDGetoptNoArgument },
+		{ kGBArgWarnOnUndocumentedParam,									0,		DDGetoptNoArgument },
 		{ kGBArgWarnOnEmptyDescription,										0,		DDGetoptNoArgument },
 		{ kGBArgWarnOnUnknownDirective,										0,		DDGetoptNoArgument },
 		{ kGBArgWarnOnInvalidCrossReference,								0,		DDGetoptNoArgument },
@@ -925,6 +927,7 @@ - (void)printSettingsAndArguments:(NSArray *)arguments {
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnMissingCompanyIdentifier, PRINT_BOOL(self.settings.warnOnMissingCompanyIdentifier));
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnUndocumentedObject, PRINT_BOOL(self.settings.warnOnUndocumentedObject));
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnUndocumentedMember, PRINT_BOOL(self.settings.warnOnUndocumentedMember));
+	ddprintf(@"--%@ = %@\n", kGBArgWarnOnUndocumentedParam, PRINT_BOOL(self.settings.warnOnUndocumentedParam));
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnEmptyDescription, PRINT_BOOL(self.settings.warnOnEmptyDescription));
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnUnknownDirective, PRINT_BOOL(self.settings.warnOnUnknownDirective));
 	ddprintf(@"--%@ = %@\n", kGBArgWarnOnInvalidCrossReference, PRINT_BOOL(self.settings.warnOnInvalidCrossReference));
@@ -993,6 +996,7 @@ - (void)printHelp {
 	PRINT_USAGE(@"   ", kGBArgWarnOnMissingCompanyIdentifier, @"", @"[b] Warn if company ID is not given");
 	PRINT_USAGE(@"   ", kGBArgWarnOnUndocumentedObject, @"", @"[b] Warn on undocumented object");
 	PRINT_USAGE(@"   ", kGBArgWarnOnUndocumentedMember, @"", @"[b] Warn on undocumented member");
+	PRINT_USAGE(@"   ", kGBArgWarnOnUndocumentedParam, @"", @"[b] Warn on undocumented method parameter");
 	PRINT_USAGE(@"   ", kGBArgWarnOnEmptyDescription, @"", @"[b] Warn on empty description block");
 	PRINT_USAGE(@"   ", kGBArgWarnOnUnknownDirective, @"", @"[b] Warn on unknown directive or format");
 	PRINT_USAGE(@"   ", kGBArgWarnOnInvalidCrossReference, @"", @"[b] Warn on invalid cross reference");

diff --git a/Application/GBApplicationSettingsProvider.h b/Application/GBApplicationSettingsProvider.h
@@ -391,6 +391,12 @@ extern id kGBCustomDocumentIndexDescKey;
  */
 @property (assign) BOOL warnOnUndocumentedMember;
 
+/** Indicates whether appledoc will warn if it encounters an undocumented method parameter
+ 
+ @see warnOnUndocumentedMember
+ */
+@property (assign) BOOL warnOnUndocumentedParam;
+
 /** Indicates whether appledoc will warn if it encounters an empty description (@bug, @warning, example section etc.).
  */
 @property (assign) BOOL warnOnEmptyDescription;

diff --git a/Processing/GBProcessor.m b/Processing/GBProcessor.m
@@ -196,7 +196,7 @@ - (void)processParametersFromComment:(GBComment *)comment matchingMethod:(GBMeth
 	[names enumerateObjectsUsingBlock:^(NSString *name, NSUInteger idx, BOOL *stop) {
 		GBCommentArgument *parameter = [parameters objectForKey:name];
 		if (!parameter) {
-            if (method.includeInOutput)
+            if (self.settings.warnOnUndocumentedParam && method.includeInOutput)
                 GBLogXWarn(comment.sourceInfo, @"%@: Description for parameter '%@' missing for %@!", comment.sourceInfo, name, method);
 			return;
 		}