Skip to content

Commit 28c87e3

Browse files
onevcatonevcat
committed
Merge pull request onevcat#47 from antons/disable-argument-padding
Added an option to avoid aligning argument comments
2 parents afea45e + 7035028 commit 28c87e3

5 files changed

Lines changed: 115 additions & 21 deletions

File tree

‎VVDocumenter-Xcode/Commenter/VVBaseCommenter.m‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,13 @@ -(NSString *) argumentsComment
5050
int longestNameLength = [[self.arguments valueForKeyPath:@"@max.name.length"] intValue];
5151

5252
for (VVArgument *arg in self.arguments) {
53-
NSString *paddedName = [arg.name stringByPaddingToLength:longestNameLength withString:@" " startingAtIndex:0];
53+
NSString *name = arg.name;
5454

55-
[result appendFormat:@"%@@param %@ <#%@ description#>\n", self.prefixString, paddedName, arg.name];
55+
if ([[VVDocumenterSetting defaultSetting] alignArgumentComments]) {
56+
name = [name stringByPaddingToLength:longestNameLength withString:@" " startingAtIndex:0];
57+
}
58+
59+
[result appendFormat:@"%@@param %@ <#%@ description#>\n", self.prefixString, name, arg.name];
5660
}
5761
return result;
5862
}

‎VVDocumenter-Xcode/Setting/VVDSettingPanelWindowController.m‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ @interface VVDSettingPanelWindowController ()<NSTextFieldDelegate>
2424
@property (assign) IBOutlet NSButton *btnAddSinceToComment;
2525
@property (weak) IBOutlet NSButton *btnUseHeaderDoc;
2626
@property (weak) IBOutlet NSButton *btnBlankLinesBetweenSections;
27+
@property (weak) IBOutlet NSButton *btnAlightArgumentComments;
2728
@end
2829

2930
@implementation VVDSettingPanelWindowController
@@ -49,6 +50,7 @@ - (void)windowDidLoad
4950
self.btnAddSinceToComment.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] addSinceToComments];
5051
self.btnUseHeaderDoc.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] useHeaderDoc];
5152
self.btnBlankLinesBetweenSections.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] blankLinesBetweenSections];
53+
self.btnAlightArgumentComments.state = (NSCellStateValue)[[VVDocumenterSetting defaultSetting] alignArgumentComments];
5254

5355
if ([[VVDocumenterSetting defaultSetting] prefixWithStar]) {
5456
[self.mtxPrefixOptions selectCell:self.btnPrefixWithStar];
@@ -83,6 +85,7 @@ - (IBAction)btnResetPressed:(id)sender {
8385
[[VVDocumenterSetting defaultSetting] setAddSinceToComments:NO];
8486
[[VVDocumenterSetting defaultSetting] setUseHeaderDoc:NO];
8587
[[VVDocumenterSetting defaultSetting] setBlankLinesBetweenSections:YES];
88+
[[VVDocumenterSetting defaultSetting] setAlignArgumentComments:YES];
8689

8790
self.btnUseSpaces.state = NSOnState;
8891
[self updateUseSpace:self.btnUseSpaces.state];
@@ -93,6 +96,7 @@ - (IBAction)btnResetPressed:(id)sender {
9396
[self.tfTrigger setStringValue:VVDDefaultTriggerString];
9497
self.btnUseHeaderDoc.state = NSOffState;
9598
self.btnBlankLinesBetweenSections.state = NSOnState;
99+
self.btnAlightArgumentComments.state = NSOnState;
96100

97101
self.btnPrefixWithSlashes.enabled = YES;
98102

@@ -166,4 +170,9 @@ - (IBAction)useHeaderDoc:(id)sender {
166170
- (IBAction)blankLinesBetweenSections:(id)sender {
167171
[[VVDocumenterSetting defaultSetting] setBlankLinesBetweenSections:self.btnBlankLinesBetweenSections.state];
168172
}
173+
174+
- (IBAction)alignArgumentComments:(id)sender {
175+
[[VVDocumenterSetting defaultSetting] setAlignArgumentComments:self.btnAlightArgumentComments.state];
176+
}
177+
169178
@end

‎VVDocumenter-Xcode/Setting/VVDSettingPanelWindowController.xib‎

Lines changed: 88 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
<archive type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="8.00">
33
<data>
44
<int key="IBDocument.SystemTarget">1080</int>
5-
<string key="IBDocument.SystemVersion">13B42</string>
6-
<string key="IBDocument.InterfaceBuilderVersion">4514</string>
7-
<string key="IBDocument.AppKitVersion">1265</string>
8-
<string key="IBDocument.HIToolboxVersion">696.00</string>
5+
<string key="IBDocument.SystemVersion">13C64</string>
6+
<string key="IBDocument.InterfaceBuilderVersion">5056</string>
7+
<string key="IBDocument.AppKitVersion">1265.19</string>
8+
<string key="IBDocument.HIToolboxVersion">697.40</string>
99
<object class="NSMutableDictionary" key="IBDocument.PluginVersions">
1010
<string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin</string>
11-
<string key="NS.object.0">4514</string>
11+
<string key="NS.object.0">5056</string>
1212
</object>
1313
<array key="IBDocument.IntegratedClassDependencies">
1414
<string>NSBox</string>
@@ -43,7 +43,7 @@
4343
<object class="NSWindowTemplate" id="1005">
4444
<int key="NSWindowStyleMask">3</int>
4545
<int key="NSWindowBacking">2</int>
46-
<string key="NSWindowRect">{{508, 391}, {460, 377}}</string>
46+
<string key="NSWindowRect">{{508, 391}, {460, 407}}</string>
4747
<int key="NSWTFlags">544735232</int>
4848
<string key="NSWindowTitle">VVDocumenter Setting</string>
4949
<string key="NSWindowClass">NSWindow</string>
@@ -56,7 +56,7 @@
5656
<object class="NSButton" id="126835082">
5757
<reference key="NSNextResponder" ref="1006"/>
5858
<int key="NSvFlags">268</int>
59-
<string key="NSFrame">{{67, 251}, {212, 35}}</string>
59+
<string key="NSFrame">{{67, 281}, {212, 35}}</string>
6060
<reference key="NSSuperview" ref="1006"/>
6161
<reference key="NSWindow"/>
6262
<reference key="NSNextKeyView" ref="287259983"/>
@@ -92,7 +92,7 @@
9292
<object class="NSTextField" id="837322658">
9393
<reference key="NSNextResponder" ref="1006"/>
9494
<int key="NSvFlags">268</int>
95-
<string key="NSFrame">{{329, 260}, {60, 17}}</string>
95+
<string key="NSFrame">{{329, 290}, {60, 17}}</string>
9696
<reference key="NSSuperview" ref="1006"/>
9797
<reference key="NSWindow"/>
9898
<reference key="NSNextKeyView" ref="899742890"/>
@@ -130,7 +130,7 @@
130130
<object class="NSTextField" id="287259983">
131131
<reference key="NSNextResponder" ref="1006"/>
132132
<int key="NSvFlags">268</int>
133-
<string key="NSFrame">{{279, 257}, {37, 22}}</string>
133+
<string key="NSFrame">{{279, 287}, {37, 22}}</string>
134134
<reference key="NSSuperview" ref="1006"/>
135135
<reference key="NSWindow"/>
136136
<reference key="NSNextKeyView" ref="645523021"/>
@@ -190,7 +190,7 @@
190190
<object class="NSTextField" id="972045408">
191191
<reference key="NSNextResponder" ref="1006"/>
192192
<int key="NSvFlags">268</int>
193-
<string key="NSFrame">{{66, 338}, {107, 17}}</string>
193+
<string key="NSFrame">{{66, 368}, {107, 17}}</string>
194194
<reference key="NSSuperview" ref="1006"/>
195195
<reference key="NSWindow"/>
196196
<reference key="NSNextKeyView" ref="79895721"/>
@@ -212,7 +212,7 @@
212212
<object class="NSTextField" id="79895721">
213213
<reference key="NSNextResponder" ref="1006"/>
214214
<int key="NSvFlags">268</int>
215-
<string key="NSFrame">{{279, 335}, {96, 22}}</string>
215+
<string key="NSFrame">{{279, 365}, {96, 22}}</string>
216216
<reference key="NSSuperview" ref="1006"/>
217217
<reference key="NSWindow"/>
218218
<reference key="NSNextKeyView" ref="22971616"/>
@@ -235,7 +235,7 @@
235235
<object class="NSTextField" id="22971616">
236236
<reference key="NSNextResponder" ref="1006"/>
237237
<int key="NSvFlags">268</int>
238-
<string key="NSFrame">{{78, 292}, {295, 38}}</string>
238+
<string key="NSFrame">{{78, 322}, {295, 38}}</string>
239239
<reference key="NSSuperview" ref="1006"/>
240240
<reference key="NSWindow"/>
241241
<reference key="NSNextKeyView" ref="126835082"/>
@@ -270,7 +270,7 @@
270270
<object class="NSStepper" id="645523021">
271271
<reference key="NSNextResponder" ref="1006"/>
272272
<int key="NSvFlags">268</int>
273-
<string key="NSFrame">{{312, 254}, {19, 27}}</string>
273+
<string key="NSFrame">{{312, 284}, {19, 27}}</string>
274274
<reference key="NSSuperview" ref="1006"/>
275275
<reference key="NSWindow"/>
276276
<reference key="NSNextKeyView" ref="837322658"/>
@@ -290,7 +290,7 @@
290290
<object class="NSButton" id="899742890">
291291
<reference key="NSNextResponder" ref="1006"/>
292292
<int key="NSvFlags">268</int>
293-
<string key="NSFrame">{{67, 230}, {201, 18}}</string>
293+
<string key="NSFrame">{{67, 260}, {201, 18}}</string>
294294
<reference key="NSSuperview" ref="1006"/>
295295
<reference key="NSWindow"/>
296296
<reference key="NSNextKeyView" ref="565957479"/>
@@ -317,7 +317,7 @@
317317
<object class="NSButton" id="565957479">
318318
<reference key="NSNextResponder" ref="1006"/>
319319
<int key="NSvFlags">268</int>
320-
<string key="NSFrame">{{67, 200}, {272, 18}}</string>
320+
<string key="NSFrame">{{67, 230}, {272, 18}}</string>
321321
<reference key="NSSuperview" ref="1006"/>
322322
<reference key="NSWindow"/>
323323
<reference key="NSNextKeyView" ref="176216819"/>
@@ -344,10 +344,10 @@
344344
<object class="NSButton" id="176216819">
345345
<reference key="NSNextResponder" ref="1006"/>
346346
<int key="NSvFlags">268</int>
347-
<string key="NSFrame">{{67, 172}, {272, 18}}</string>
347+
<string key="NSFrame">{{67, 202}, {272, 18}}</string>
348348
<reference key="NSSuperview" ref="1006"/>
349349
<reference key="NSWindow"/>
350-
<reference key="NSNextKeyView" ref="633252326"/>
350+
<reference key="NSNextKeyView" ref="656911203"/>
351351
<string key="NSReuseIdentifierKey">_NS:9</string>
352352
<bool key="NSEnabled">YES</bool>
353353
<object class="NSButtonCell" key="NSCell" id="185874400">
@@ -574,13 +574,40 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
574574
<int key="NSTitlePosition">0</int>
575575
<bool key="NSTransparent">NO</bool>
576576
</object>
577+
<object class="NSButton" id="656911203">
578+
<reference key="NSNextResponder" ref="1006"/>
579+
<int key="NSvFlags">268</int>
580+
<string key="NSFrame">{{67, 170}, {272, 18}}</string>
581+
<reference key="NSSuperview" ref="1006"/>
582+
<reference key="NSWindow"/>
583+
<reference key="NSNextKeyView" ref="633252326"/>
584+
<string key="NSReuseIdentifierKey">_NS:9</string>
585+
<bool key="NSEnabled">YES</bool>
586+
<object class="NSButtonCell" key="NSCell" id="416924661">
587+
<int key="NSCellFlags">-2080374784</int>
588+
<int key="NSCellFlags2">268435456</int>
589+
<string key="NSContents">Align argument comments</string>
590+
<reference key="NSSupport" ref="45273652"/>
591+
<string key="NSCellIdentifier">_NS:9</string>
592+
<reference key="NSControlView" ref="656911203"/>
593+
<int key="NSButtonFlags">1211912448</int>
594+
<int key="NSButtonFlags2">2</int>
595+
<reference key="NSNormalImage" ref="375391960"/>
596+
<reference key="NSAlternateImage" ref="998663687"/>
597+
<string key="NSAlternateContents"/>
598+
<string key="NSKeyEquivalent"/>
599+
<int key="NSPeriodicDelay">200</int>
600+
<int key="NSPeriodicInterval">25</int>
601+
</object>
602+
<bool key="NSAllowsLogicalLayoutDirection">NO</bool>
603+
</object>
577604
</array>
578-
<string key="NSFrameSize">{460, 377}</string>
605+
<string key="NSFrameSize">{460, 407}</string>
579606
<reference key="NSSuperview"/>
580607
<reference key="NSWindow"/>
581608
<reference key="NSNextKeyView" ref="972045408"/>
582609
</object>
583-
<string key="NSScreenRect">{{0, 0}, {1920, 1058}}</string>
610+
<string key="NSScreenRect">{{0, 0}, {2560, 1418}}</string>
584611
<string key="NSMaxSize">{10000000000000, 10000000000000}</string>
585612
<bool key="NSWindowIsRestorable">YES</bool>
586613
</object>
@@ -748,6 +775,22 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
748775
</object>
749776
<string key="id">vCY-7n-Xqh</string>
750777
</object>
778+
<object class="IBConnectionRecord">
779+
<object class="IBActionConnection" key="connection">
780+
<string key="label">alignArgumentComments:</string>
781+
<reference key="source" ref="1001"/>
782+
<reference key="destination" ref="656911203"/>
783+
</object>
784+
<string key="id">o62-1G-Tta</string>
785+
</object>
786+
<object class="IBConnectionRecord">
787+
<object class="IBOutletConnection" key="connection">
788+
<string key="label">btnAlightArgumentComments</string>
789+
<reference key="source" ref="1001"/>
790+
<reference key="destination" ref="656911203"/>
791+
</object>
792+
<string key="id">l9g-ge-CwY</string>
793+
</object>
751794
<object class="IBConnectionRecord">
752795
<object class="IBOutletConnection" key="connection">
753796
<string key="label">delegate</string>
@@ -808,6 +851,7 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
808851
<reference ref="899742890"/>
809852
<reference ref="565957479"/>
810853
<reference ref="176216819"/>
854+
<reference ref="656911203"/>
811855
</array>
812856
<reference key="parent" ref="1005"/>
813857
</object>
@@ -991,6 +1035,19 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
9911035
<reference key="object" ref="185874400"/>
9921036
<reference key="parent" ref="176216819"/>
9931037
</object>
1038+
<object class="IBObjectRecord">
1039+
<string key="id">g3M-cK-u5v</string>
1040+
<reference key="object" ref="656911203"/>
1041+
<array class="NSMutableArray" key="children">
1042+
<reference ref="416924661"/>
1043+
</array>
1044+
<reference key="parent" ref="1006"/>
1045+
</object>
1046+
<object class="IBObjectRecord">
1047+
<string key="id">5tp-ni-55q</string>
1048+
<reference key="object" ref="416924661"/>
1049+
<reference key="parent" ref="656911203"/>
1050+
</object>
9941051
</array>
9951052
</object>
9961053
<dictionary class="NSMutableDictionary" key="flattenedProperties">
@@ -1018,6 +1075,7 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
10181075
<string key="31.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10191076
<string key="54.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10201077
<string key="55.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
1078+
<string key="5tp-ni-55q.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10211079
<string key="6ax-Nw-Bq5.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10221080
<string key="9.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10231081
<string key="9MP-VX-rsW.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
@@ -1028,6 +1086,7 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
10281086
<string key="YoT-Nd-Bhd.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10291087
<string key="bgb-aQ-BAa.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10301088
<string key="eH9-9F-VR9.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
1089+
<string key="g3M-cK-u5v.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10311090
<string key="mxJ-X3-ycD.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10321091
<string key="vMT-lx-3Ep.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
10331092
<string key="wZv-eZ-WK7.IBPluginDependency">com.apple.InterfaceBuilder.CocoaPlugin</string>
@@ -1043,6 +1102,7 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
10431102
<string key="className">VVDSettingPanelWindowController</string>
10441103
<string key="superclassName">NSWindowController</string>
10451104
<dictionary class="NSMutableDictionary" key="actions">
1105+
<string key="alignArgumentComments:">id</string>
10461106
<string key="blankLinesBetweenSections:">id</string>
10471107
<string key="btnAddSinceToCommentsPressed:">id</string>
10481108
<string key="btnResetPressed:">id</string>
@@ -1052,6 +1112,10 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
10521112
<string key="useHeaderDoc:">id</string>
10531113
</dictionary>
10541114
<dictionary class="NSMutableDictionary" key="actionInfosByName">
1115+
<object class="IBActionInfo" key="alignArgumentComments:">
1116+
<string key="name">alignArgumentComments:</string>
1117+
<string key="candidateClassName">id</string>
1118+
</object>
10551119
<object class="IBActionInfo" key="blankLinesBetweenSections:">
10561120
<string key="name">blankLinesBetweenSections:</string>
10571121
<string key="candidateClassName">id</string>
@@ -1083,6 +1147,7 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
10831147
</dictionary>
10841148
<dictionary class="NSMutableDictionary" key="outlets">
10851149
<string key="btnAddSinceToComment">NSButton</string>
1150+
<string key="btnAlightArgumentComments">NSButton</string>
10861151
<string key="btnBlankLinesBetweenSections">NSButton</string>
10871152
<string key="btnPrefixWithSlashes">NSButtonCell</string>
10881153
<string key="btnPrefixWithStar">NSButtonCell</string>
@@ -1100,6 +1165,10 @@ y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp2
11001165
<string key="name">btnAddSinceToComment</string>
11011166
<string key="candidateClassName">NSButton</string>
11021167
</object>
1168+
<object class="IBToOneOutletInfo" key="btnAlightArgumentComments">
1169+
<string key="name">btnAlightArgumentComments</string>
1170+
<string key="candidateClassName">NSButton</string>
1171+
</object>
11031172
<object class="IBToOneOutletInfo" key="btnBlankLinesBetweenSections">
11041173
<string key="name">btnBlankLinesBetweenSections</string>
11051174
<string key="candidateClassName">NSButton</string>

‎VVDocumenter-Xcode/Setting/VVDocumenterSetting.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ extern NSString *const VVDDefaultTriggerString;
2222
@property BOOL addSinceToComments;
2323
@property BOOL useHeaderDoc;
2424
@property BOOL blankLinesBetweenSections;
25+
@property BOOL alignArgumentComments;
2526
@property (readonly) NSString *spacesString;
2627
@end

‎VVDocumenter-Xcode/Setting/VVDocumenterSetting.m‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
NSString *const kVVDAddSinceToComments = @"com.onevcat.VVDocumenter.addSinceToComments";
2020
NSString *const kVVDUserHeaderDoc = @"com.onevcat.VVDocumenter.useHeaderDoc";
2121
NSString *const kVVDNoBlankLinesBetweenFields = @"com.onevcat.VVDocumenter.noBlankLinesBetweenFields";
22+
NSString *const kVVDNoArgumentPadding = @"com.onevcat.VVDocumenter.noArgumentPadding";
2223
@implementation VVDocumenterSetting
2324

2425
+ (VVDocumenterSetting *)defaultSetting
@@ -150,6 +151,16 @@ -(void) setBlankLinesBetweenSections:(BOOL)blankLinesBetweenFields
150151
[[NSUserDefaults standardUserDefaults] synchronize];
151152
}
152153

154+
-(BOOL) alignArgumentComments
155+
{
156+
return ![[NSUserDefaults standardUserDefaults] boolForKey:kVVDNoArgumentPadding];
157+
}
158+
-(void) setAlignArgumentComments:(BOOL)alignArgumentComments
159+
{
160+
[[NSUserDefaults standardUserDefaults] setBool:!alignArgumentComments forKey:kVVDNoArgumentPadding];
161+
[[NSUserDefaults standardUserDefaults] synchronize];
162+
}
163+
153164
-(NSString *) spacesString
154165
{
155166
if ([self useSpaces]) {

0 commit comments

Comments
 (0)