Opt out brief in enum item documetation

onevcat · onevcat · commit a7dfdb62816c · 2015-06-17T13:43:19.000+09:00
diff --git a/VVDocumenter-Xcode/Commenter/VVBaseCommenter.h b/VVDocumenter-Xcode/Commenter/VVBaseCommenter.h
@@ -29,6 +29,7 @@
 
 // Comment methods
 -(NSString *) startComment;
+-(NSString *) startCommentWithDescriptionTag:(NSString *)tag;
 -(NSString *) argumentsComment;
 -(NSString *) endComment;
 -(NSString *) returnComment;
diff --git a/VVDocumenter-Xcode/Commenter/VVBaseCommenter.m b/VVDocumenter-Xcode/Commenter/VVBaseCommenter.m
@@ -40,20 +40,16 @@ -(NSString *) returnSymbol {
     return self.forSwift ? @":returns:" : @"@return";
 }
 
--(NSString *) startComment
-{
-    NSString *descriptionTag =
-    [[VVDocumenterSetting defaultSetting] briefDescription] && !self.forSwift ? @"@brief  " : @"";
-
+-(NSString *) startCommentWithDescriptionTag:(NSString *)tag {
     NSString *authorInfo = @"";
-
+    
     if ([[VVDocumenterSetting defaultSetting] useAuthorInformation] && !self.forSwift) {
         NSMutableString *authorCotent = @"".mutableCopy;
         
         if ([[VVDocumenterSetting defaultSetting] authorInformation].length > 0) {
             [authorCotent appendString:[[VVDocumenterSetting defaultSetting] authorInformation]];
         }
-
+        
         if ([[VVDocumenterSetting defaultSetting] useDateInformation]) {
             NSString *formatString = [[VVDocumenterSetting defaultSetting] dateInformationFormat];
             if ([formatString length] <= 0) {
@@ -65,21 +61,28 @@ -(NSString *) startComment
             if (authorCotent.length > 0) {
                 [authorCotent appendString:@", "];
             }
-            [authorCotent appendString:[formatter stringFromDate:[NSDate date]]];            
+            [authorCotent appendString:[formatter stringFromDate:[NSDate date]]];
         }
-
+        
         authorInfo = [NSString stringWithFormat:@"%@@author %@\n%@\n", self.prefixString, authorCotent, self.prefixString];
     }
     
     if ([[VVDocumenterSetting defaultSetting] useHeaderDoc]) {
-        return [NSString stringWithFormat:@"%@/*!\n%@%@%@<#Description#>\n", self.indent, authorInfo, self.prefixString, descriptionTag];
+        return [NSString stringWithFormat:@"%@/*!\n%@%@%@<#Description#>\n", self.indent, authorInfo, self.prefixString, tag];
     } else if ([[VVDocumenterSetting defaultSetting] prefixWithSlashes]) {
-        return [NSString stringWithFormat:@"%@%@%@<#Description#>\n", self.prefixString, authorInfo, descriptionTag];
+        return [NSString stringWithFormat:@"%@%@%@<#Description#>\n", self.prefixString, authorInfo, tag];
     } else {
-        return [NSString stringWithFormat:@"%@/**\n%@%@%@<#Description#>\n", self.indent, authorInfo, self.prefixString, descriptionTag];
+        return [NSString stringWithFormat:@"%@/**\n%@%@%@<#Description#>\n", self.indent, authorInfo, self.prefixString, tag];
     }
 }
 
+-(NSString *) startComment
+{
+    NSString *descriptionTag =
+    [[VVDocumenterSetting defaultSetting] briefDescription] && !self.forSwift ? @"@brief  " : @"";
+    return [self startCommentWithDescriptionTag:descriptionTag];
+}
+
 -(NSString *) argumentsComment
 {
     if (self.arguments.count == 0)
diff --git a/VVDocumenter-Xcode/Commenter/VVEnumCommenter.m b/VVDocumenter-Xcode/Commenter/VVEnumCommenter.m
@@ -39,7 +39,7 @@ - (NSString *)document {
         NSString *trimmedPart = [part stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
         //Only append when there is a enum define. (In case of the last comma, followed no define)
         if (trimmedPart.length != 0) {
-            NSString *temp = [NSString stringWithFormat:@"%@%@%@", [self startComment],
+            NSString *temp = [NSString stringWithFormat:@"%@%@%@", [self startCommentWithDescriptionTag:@""],
                               [self sinceComment],
                               [self endComment]];
 
