Fixed comment and code newline separation issues when using slash prefixes or when the original enum contains multiple newlines between each item.

idpaterson · idpaterson · commit 14dcf69f0697 · 2013-10-15T08:59:29.000-04:00
diff --git a/VVDocumenter-Xcode/Commenter/VVEnumCommenter.m b/VVDocumenter-Xcode/Commenter/VVEnumCommenter.m
@@ -12,10 +12,14 @@ @implementation VVEnumCommenter
 
 - (NSString *)document {
     //Regular comment documentation
-    NSString *finalString = [NSString stringWithFormat:@"%@%@%@\n", [self startComment],
-                                                                    [self sinceComment],
-                                                                    [self endComment]];
-    
+    NSString *finalString = [NSString stringWithFormat:@"%@%@%@", [self startComment],
+                                                                  [self sinceComment],
+                                                                  [self endComment]];
+
+    if (![finalString hasSuffix:@"\n"]) {
+        finalString = [finalString stringByAppendingString:@"\n"];
+    }
+
     // Grab everything from the start of the line to the opening brace, which
     // may be on a different line.
     NSString *enumDefinePattern = @"^\\s*(\\w+\\s+)?NS_(ENUM|OPTIONS)[\\s\\S]*?\\{";
@@ -32,14 +36,28 @@ - (NSString *)document {
     NSArray *enumParts = [enumPartsString componentsSeparatedByString:@","];
     
     for (NSString *part in enumParts) {
+        NSString *trimmedPart = [part stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
         //Only append when there is a enum define. (In case of the last comma, followed no define)
-        if ([part stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]].length != 0) {
-            NSString *temp = [NSString stringWithFormat:@"%@%@%@%@", [self startComment],
+        if (trimmedPart.length != 0) {
+            NSString *temp = [NSString stringWithFormat:@"%@%@%@", [self startComment],
                               [self sinceComment],
-                              [self endComment],
-                              part];
+                              [self endComment]];
+
+            if ([temp hasSuffix:@"\n"]) {
+                // comment has a newline suffix, so trimmedPart will go on
+                // the next line
+                temp = [temp stringByAppendingString:trimmedPart];
+            } else {
+                // comment does not have a newline suffix, so trimmedPart
+                // needs to be moved to the next line
+                temp = [temp stringByAppendingFormat:@"\n%@", trimmedPart];
+            }
+
             if (part != [enumParts lastObject]) {
                 temp = [temp stringByAppendingString:@",\n"];
+            } else {
+                // since trimmedPart was used there is no trailing newline
+                temp = [temp stringByAppendingString:@"\n"];
             }
             finalString = [finalString stringByAppendingString:temp];
         }
