Skip to content

Commit ef18864

Browse files
ahtiahti
committed
added option to turn of prefixing each comment line with a star
1 parent 61b0dc7 commit ef18864

6 files changed

Lines changed: 139 additions & 25 deletions

File tree

‎VVDocumenter-Xcode.xcodeproj/project.pbxproj‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
D1C462F617999CEC00EB7B23 /* NSString+VVSyntax.m in Sources */ = {isa = PBXBuildFile; fileRef = D1C462F417999CEC00EB7B23 /* NSString+VVSyntax.m */; };
3939
D1C462F717999D0600EB7B23 /* NSString+PDRegex.m in Sources */ = {isa = PBXBuildFile; fileRef = D114BEDE179644D00043FA65 /* NSString+PDRegex.m */; };
4040
D1D66CA817A2AEF000E62F99 /* VVKeyboardEventSender.m in Sources */ = {isa = PBXBuildFile; fileRef = D1D66CA717A2AEF000E62F99 /* VVKeyboardEventSender.m */; };
41+
E19E073A17B57D2800F048C2 /* VVDocumenterSetting.m in Sources */ = {isa = PBXBuildFile; fileRef = D124614317AC16820095F9D6 /* VVDocumenterSetting.m */; };
4142
/* End PBXBuildFile section */
4243

4344
/* Begin PBXFileReference section */
@@ -453,6 +454,7 @@
453454
D1C462F117999CA200EB7B23 /* SyntaxTests.m in Sources */,
454455
D1C462F617999CEC00EB7B23 /* NSString+VVSyntax.m in Sources */,
455456
D1986F74179A12BD00EA6643 /* CommenterTests.m in Sources */,
457+
E19E073A17B57D2800F048C2 /* VVDocumenterSetting.m in Sources */,
456458
);
457459
runOnlyForDeploymentPostprocessing = 0;
458460
};

‎VVDocumenter-Xcode/Commenter/VVBaseCommenter.m‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,29 @@ -(id) initWithIndentString:(NSString *)indent codeString:(NSString *)code
2929

3030
-(NSString *) startComment
3131
{
32-
return [NSString stringWithFormat:@"%@/**\n%@ *%@<#%@#>\n",self.indent,self.indent,self.space,@"Description"];
32+
return [NSString stringWithFormat:@"%@/**\n%@<#Description#>\n", self.indent, self.prefixString];
3333
}
3434

3535
-(NSString *) argumentsComment
3636
{
37-
NSMutableString *result = [NSMutableString stringWithString:@""];
37+
if (self.arguments.count == 0)
38+
return @"";
39+
40+
// start of with an empty line
41+
NSMutableString *result = [NSMutableString stringWithFormat:@"%@", self.emptyLine];
42+
3843
for (VVArgument *arg in self.arguments) {
39-
if (result.length == 0) {
40-
[result appendFormat:@"%@ *\n",self.indent];
41-
}
42-
[result appendFormat:@"%@ *%@@param%@%@%@<#%@ description#>\n",self.indent,self.space,self.space,arg.name,self.space,arg.name];
44+
[result appendFormat:@"%@@param %@ <#%@ description#>\n", self.prefixString, arg.name, arg.name];
4345
}
4446
return result;
4547
}
4648

4749
-(NSString *) returnComment
48-
4950
{
5051
if (!self.hasReturn) {
5152
return @"";
5253
} else {
53-
return [NSString stringWithFormat:@"%@ *\n%@ *%@@return%@<#return value description#>\n",self.indent,self.indent,self.space,self.space];
54+
return [NSString stringWithFormat:@"%@%@@return <#return value description#>\n", self.emptyLine, self.prefixString];
5455
}
5556
}
5657

@@ -67,6 +68,21 @@ -(NSString *) document
6768
[self endComment]];
6869
}
6970

71+
-(NSString *) emptyLine
72+
{
73+
return [NSString stringWithFormat:@"%@\n", self.prefixString];
74+
}
75+
76+
-(NSString *) prefixString
77+
{
78+
if ([[VVDocumenterSetting defaultSetting] prefixWithStar]) {
79+
return [NSString stringWithFormat:@"%@ * ", self.indent];
80+
}
81+
else {
82+
return [NSString stringWithFormat:@"%@ ", self.indent];
83+
}
84+
}
85+
7086
-(void) parseArguments
7187
{
7288
[self.arguments removeAllObjects];

‎VVDocumenter-Xcode/Setting/VVDSettingPanelWindowController.m‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ @interface VVDSettingPanelWindowController ()<NSTextFieldDelegate>
1717

1818
@property (assign) IBOutlet NSStepper *stepperCount;
1919

20+
@property (assign) IBOutlet NSButton *btnPrefixWithStar;
21+
2022
@end
2123

2224
@implementation VVDSettingPanelWindowController
@@ -39,6 +41,8 @@ - (void)windowDidLoad
3941
[self.tfTrigger setStringValue:[[VVDocumenterSetting defaultSetting] triggerString]];
4042
self.btnUseSpaces.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] useSpaces];
4143

44+
self.btnPrefixWithStar.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] prefixWithStar];
45+
4246
[self updateUseSpace:self.btnUseSpaces.state];
4347
[self syncSpaceCount];
4448

@@ -69,6 +73,10 @@ - (IBAction)btnUseSpacesPressed:(id)sender {
6973
[self updateUseSpace:self.btnUseSpaces.state];
7074
}
7175

76+
- (IBAction)btnPrefixWithStarPressed:(id)sender {
77+
[[VVDocumenterSetting defaultSetting] setPrefixWithStar:self.btnPrefixWithStar.state];
78+
}
79+
7280
-(void) syncSpaceCount
7381
{
7482
NSInteger spaceCount = [[VVDocumenterSetting defaultSetting] spaceCount];

‎VVDocumenter-Xcode/Setting/VVDSettingPanelWindowController.xib‎

Lines changed: 84 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<object class="NSWindowTemplate" id="1005">
4242
<int key="NSWindowStyleMask">3</int>
4343
<int key="NSWindowBacking">2</int>
44-
<string key="NSWindowRect">{{508, 391}, {460, 176}}</string>
44+
<string key="NSWindowRect">{{508, 391}, {460, 195}}</string>
4545
<int key="NSWTFlags">544735232</int>
4646
<string key="NSWindowTitle">VVDocumenter Setting</string>
4747
<string key="NSWindowClass">NSWindow</string>
@@ -54,7 +54,7 @@
5454
<object class="NSButton" id="126835082">
5555
<reference key="NSNextResponder" ref="1006"/>
5656
<int key="NSvFlags">268</int>
57-
<string key="NSFrame">{{68, 59}, {212, 35}}</string>
57+
<string key="NSFrame">{{68, 78}, {212, 35}}</string>
5858
<reference key="NSSuperview" ref="1006"/>
5959
<reference key="NSWindow"/>
6060
<reference key="NSNextKeyView" ref="22971616"/>
@@ -73,11 +73,11 @@
7373
<reference key="NSControlView" ref="126835082"/>
7474
<int key="NSButtonFlags">1211912448</int>
7575
<int key="NSButtonFlags2">2</int>
76-
<object class="NSCustomResource" key="NSNormalImage">
76+
<object class="NSCustomResource" key="NSNormalImage" id="375391960">
7777
<string key="NSClassName">NSImage</string>
7878
<string key="NSResourceName">NSSwitch</string>
7979
</object>
80-
<object class="NSButtonImageSource" key="NSAlternateImage">
80+
<object class="NSButtonImageSource" key="NSAlternateImage" id="998663687">
8181
<string key="NSImageName">NSSwitch</string>
8282
</object>
8383
<string key="NSAlternateContents"/>
@@ -90,10 +90,10 @@
9090
<object class="NSTextField" id="837322658">
9191
<reference key="NSNextResponder" ref="1006"/>
9292
<int key="NSvFlags">268</int>
93-
<string key="NSFrame">{{330, 68}, {60, 17}}</string>
93+
<string key="NSFrame">{{330, 87}, {60, 17}}</string>
9494
<reference key="NSSuperview" ref="1006"/>
9595
<reference key="NSWindow"/>
96-
<reference key="NSNextKeyView" ref="860271950"/>
96+
<reference key="NSNextKeyView" ref="23105601"/>
9797
<string key="NSReuseIdentifierKey">_NS:1535</string>
9898
<bool key="NSEnabled">YES</bool>
9999
<object class="NSTextFieldCell" key="NSCell" id="756277908">
@@ -127,7 +127,7 @@
127127
<object class="NSTextField" id="287259983">
128128
<reference key="NSNextResponder" ref="1006"/>
129129
<int key="NSvFlags">268</int>
130-
<string key="NSFrame">{{280, 65}, {37, 22}}</string>
130+
<string key="NSFrame">{{280, 84}, {37, 22}}</string>
131131
<reference key="NSSuperview" ref="1006"/>
132132
<reference key="NSWindow"/>
133133
<reference key="NSNextKeyView" ref="645523021"/>
@@ -165,7 +165,6 @@
165165
<string key="NSFrame">{{14, 13}, {113, 32}}</string>
166166
<reference key="NSSuperview" ref="1006"/>
167167
<reference key="NSWindow"/>
168-
<reference key="NSNextKeyView"/>
169168
<string key="NSReuseIdentifierKey">_NS:9</string>
170169
<bool key="NSEnabled">YES</bool>
171170
<object class="NSButtonCell" key="NSCell" id="238216401">
@@ -187,7 +186,7 @@
187186
<object class="NSTextField" id="972045408">
188187
<reference key="NSNextResponder" ref="1006"/>
189188
<int key="NSvFlags">268</int>
190-
<string key="NSFrame">{{67, 139}, {107, 17}}</string>
189+
<string key="NSFrame">{{67, 158}, {107, 17}}</string>
191190
<reference key="NSSuperview" ref="1006"/>
192191
<reference key="NSWindow"/>
193192
<reference key="NSNextKeyView" ref="79895721"/>
@@ -208,7 +207,7 @@
208207
<object class="NSTextField" id="79895721">
209208
<reference key="NSNextResponder" ref="1006"/>
210209
<int key="NSvFlags">268</int>
211-
<string key="NSFrame">{{280, 136}, {96, 22}}</string>
210+
<string key="NSFrame">{{280, 155}, {96, 22}}</string>
212211
<reference key="NSSuperview" ref="1006"/>
213212
<reference key="NSWindow"/>
214213
<reference key="NSNextKeyView" ref="126835082"/>
@@ -230,7 +229,7 @@
230229
<object class="NSTextField" id="22971616">
231230
<reference key="NSNextResponder" ref="1006"/>
232231
<int key="NSvFlags">268</int>
233-
<string key="NSFrame">{{79, 93}, {295, 38}}</string>
232+
<string key="NSFrame">{{79, 112}, {295, 38}}</string>
234233
<reference key="NSSuperview" ref="1006"/>
235234
<reference key="NSWindow"/>
236235
<reference key="NSNextKeyView" ref="287259983"/>
@@ -264,7 +263,7 @@
264263
<object class="NSStepper" id="645523021">
265264
<reference key="NSNextResponder" ref="1006"/>
266265
<int key="NSvFlags">268</int>
267-
<string key="NSFrame">{{313, 62}, {19, 27}}</string>
266+
<string key="NSFrame">{{313, 81}, {19, 27}}</string>
268267
<reference key="NSSuperview" ref="1006"/>
269268
<reference key="NSWindow"/>
270269
<reference key="NSNextKeyView" ref="837322658"/>
@@ -281,13 +280,40 @@
281280
</object>
282281
<bool key="NSAllowsLogicalLayoutDirection">NO</bool>
283282
</object>
283+
<object class="NSButton" id="23105601">
284+
<reference key="NSNextResponder" ref="1006"/>
285+
<int key="NSvFlags">268</int>
286+
<string key="NSFrame">{{68, 58}, {252, 18}}</string>
287+
<reference key="NSSuperview" ref="1006"/>
288+
<reference key="NSWindow"/>
289+
<reference key="NSNextKeyView" ref="860271950"/>
290+
<string key="NSReuseIdentifierKey">_NS:9</string>
291+
<bool key="NSEnabled">YES</bool>
292+
<object class="NSButtonCell" key="NSCell" id="732408271">
293+
<int key="NSCellFlags">-2080374784</int>
294+
<int key="NSCellFlags2">268435456</int>
295+
<string key="NSContents">Prefix each comment line with a star</string>
296+
<reference key="NSSupport" ref="45273652"/>
297+
<string key="NSCellIdentifier">_NS:9</string>
298+
<reference key="NSControlView" ref="23105601"/>
299+
<int key="NSButtonFlags">1211912448</int>
300+
<int key="NSButtonFlags2">2</int>
301+
<reference key="NSNormalImage" ref="375391960"/>
302+
<reference key="NSAlternateImage" ref="998663687"/>
303+
<string key="NSAlternateContents"/>
304+
<string key="NSKeyEquivalent"/>
305+
<int key="NSPeriodicDelay">200</int>
306+
<int key="NSPeriodicInterval">25</int>
307+
</object>
308+
<bool key="NSAllowsLogicalLayoutDirection">NO</bool>
309+
</object>
284310
</array>
285-
<string key="NSFrameSize">{460, 176}</string>
311+
<string key="NSFrameSize">{460, 195}</string>
286312
<reference key="NSSuperview"/>
287313
<reference key="NSWindow"/>
288314
<reference key="NSNextKeyView" ref="972045408"/>
289315
</object>
290-
<string key="NSScreenRect">{{0, 0}, {1440, 878}}</string>
316+
<string key="NSScreenRect">{{0, 0}, {1680, 1028}}</string>
291317
<string key="NSMaxSize">{10000000000000, 10000000000000}</string>
292318
<bool key="NSWindowIsRestorable">YES</bool>
293319
</object>
@@ -366,6 +392,22 @@
366392
</object>
367393
<int key="connectionID">58</int>
368394
</object>
395+
<object class="IBConnectionRecord">
396+
<object class="IBOutletConnection" key="connection">
397+
<string key="label">btnPrefixWithStar</string>
398+
<reference key="source" ref="1001"/>
399+
<reference key="destination" ref="23105601"/>
400+
</object>
401+
<int key="connectionID">61</int>
402+
</object>
403+
<object class="IBConnectionRecord">
404+
<object class="IBActionConnection" key="connection">
405+
<string key="label">btnPrefixWithStarPressed:</string>
406+
<reference key="source" ref="1001"/>
407+
<reference key="destination" ref="23105601"/>
408+
</object>
409+
<int key="connectionID">62</int>
410+
</object>
369411
<object class="IBConnectionRecord">
370412
<object class="IBOutletConnection" key="connection">
371413
<string key="label">delegate</string>
@@ -417,10 +459,11 @@
417459
<reference ref="79895721"/>
418460
<reference ref="972045408"/>
419461
<reference ref="22971616"/>
420-
<reference ref="860271950"/>
421462
<reference ref="287259983"/>
422463
<reference ref="837322658"/>
423464
<reference ref="645523021"/>
465+
<reference ref="23105601"/>
466+
<reference ref="860271950"/>
424467
</array>
425468
<reference key="parent" ref="1005"/>
426469
</object>
@@ -529,6 +572,19 @@
529572
<reference key="object" ref="1001770692"/>
530573
<reference key="parent" ref="645523021"/>
531574
</object>
575+
<object class="IBObjectRecord">
576+
<int key="objectID">59</int>
577+
<reference key="object" ref="23105601"/>
578+
<array class="NSMutableArray" key="children">
579+
<reference ref="732408271"/>
580+
</array>
581+
<reference key="parent" ref="1006"/>
582+
</object>
583+
<object class="IBObjectRecord">
584+
<int key="objectID">60</int>
585+
<reference key="object" ref="732408271"/>
586+
<reference key="parent" ref="23105601"/>
587+
</object>
532588
</array>
533589
</object>
534590
<dictionary class="NSMutableDictionary" key="flattenedProperties">
@@ -556,25 +612,32 @@
556612
<string key="31.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
557613
<string key="54.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
558614
<string key="55.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
615+
<string key="59.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
616+
<string key="60.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
559617
<string key="9.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
560618
</dictionary>
561619
<dictionary class="NSMutableDictionary" key="unlocalizedProperties"/>
562620
<nil key="activeLocalization"/>
563621
<dictionary class="NSMutableDictionary" key="localizations"/>
564622
<nil key="sourceID"/>
565-
<int key="maxID">58</int>
623+
<int key="maxID">62</int>
566624
</object>
567625
<object class="IBClassDescriber" key="IBDocument.Classes">
568626
<array class="NSMutableArray" key="referencedPartialClassDescriptions">
569627
<object class="IBPartialClassDescription">
570628
<string key="className">VVDSettingPanelWindowController</string>
571629
<string key="superclassName">NSWindowController</string>
572630
<dictionary class="NSMutableDictionary" key="actions">
631+
<string key="btnPrefixWithStarPressed:">id</string>
573632
<string key="btnResetPressed:">id</string>
574633
<string key="btnUseSpacesPressed:">id</string>
575634
<string key="stepperPressed:">id</string>
576635
</dictionary>
577636
<dictionary class="NSMutableDictionary" key="actionInfosByName">
637+
<object class="IBActionInfo" key="btnPrefixWithStarPressed:">
638+
<string key="name">btnPrefixWithStarPressed:</string>
639+
<string key="candidateClassName">id</string>
640+
</object>
578641
<object class="IBActionInfo" key="btnResetPressed:">
579642
<string key="name">btnResetPressed:</string>
580643
<string key="candidateClassName">id</string>
@@ -589,13 +652,18 @@
589652
</object>
590653
</dictionary>
591654
<dictionary class="NSMutableDictionary" key="outlets">
655+
<string key="btnPrefixWithStar">NSButton</string>
592656
<string key="btnUseSpaces">NSButton</string>
593657
<string key="stepperCount">NSStepper</string>
594658
<string key="tfSpaceCount">NSTextField</string>
595659
<string key="tfSpaceLabel">NSTextField</string>
596660
<string key="tfTrigger">NSTextField</string>
597661
</dictionary>
598662
<dictionary class="NSMutableDictionary" key="toOneOutletInfosByName">
663+
<object class="IBToOneOutletInfo" key="btnPrefixWithStar">
664+
<string key="name">btnPrefixWithStar</string>
665+
<string key="candidateClassName">NSButton</string>
666+
</object>
599667
<object class="IBToOneOutletInfo" key="btnUseSpaces">
600668
<string key="name">btnUseSpaces</string>
601669
<string key="candidateClassName">NSButton</string>

‎VVDocumenter-Xcode/Setting/VVDocumenterSetting.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ extern NSString *const VVDDefaultTriggerString;
2222
-(NSString *) triggerString;
2323
-(void) setTriggerString:(NSString *)triggerString;
2424

25+
-(BOOL) prefixWithStar;
26+
-(void) setPrefixWithStar:(BOOL)prefix;
27+
2528
-(NSString *) spacesString;
2629

2730
@end

0 commit comments

Comments
 (0)