@@ -154,10 +154,10 @@ def hide_objc?
154
154
config_attr :hide_declarations ,
155
155
command_line : '--hide-declarations [objc|swift] ' ,
156
156
description : 'Hide declarations in the specified language. Given that ' \
157
- 'generating Swift docs only generates Swift declarations, ' \
158
- 'this is useful for hiding a specific interface for ' \
159
- 'either Objective-C or mixed Objective-C and Swift ' \
160
- 'projects.' ,
157
+ 'generating Swift docs only generates Swift declarations, ' \
158
+ 'this is useful for hiding a specific interface for ' \
159
+ 'either Objective-C or mixed Objective-C and Swift ' \
160
+ 'projects.' ,
161
161
default : ''
162
162
163
163
config_attr :keep_property_attributes ,
@@ -174,7 +174,7 @@ def hide_objc?
174
174
config_attr :build_tool_arguments ,
175
175
command_line : [ '-b' , '--build-tool-arguments arg1,arg2,…argN' , Array ] ,
176
176
description : 'Arguments to forward to xcodebuild, swift build, or ' \
177
- 'sourcekitten.' ,
177
+ 'sourcekitten.' ,
178
178
default : [ ]
179
179
180
180
alias_config_attr :xcodebuild_arguments , :build_tool_arguments ,
@@ -196,7 +196,7 @@ def hide_objc?
196
196
config_attr :excluded_files ,
197
197
command_line : [ '-e' , '--exclude filepath1,filepath2,…filepathN' , Array ] ,
198
198
description : 'Source file pathnames to be excluded from documentation. ' \
199
- 'Supports wildcards.' ,
199
+ 'Supports wildcards.' ,
200
200
default : [ ] ,
201
201
parse : -> ( files ) do
202
202
Array ( files ) . map { |f | expand_glob_path ( f ) . to_s }
@@ -205,7 +205,7 @@ def hide_objc?
205
205
config_attr :included_files ,
206
206
command_line : [ '-i' , '--include filepath1,filepath2,…filepathN' , Array ] ,
207
207
description : 'Source file pathnames to be included in documentation. ' \
208
- 'Supports wildcards.' ,
208
+ 'Supports wildcards.' ,
209
209
default : [ ] ,
210
210
parse : -> ( files ) do
211
211
Array ( files ) . map { |f | expand_glob_path ( f ) . to_s }
@@ -229,9 +229,9 @@ def hide_objc?
229
229
config_attr :swift_build_tool ,
230
230
command_line : "--swift-build-tool #{ SWIFT_BUILD_TOOLS . join ( ' | ' ) } " ,
231
231
description : 'Control whether Jazzy uses Swift Package Manager, ' \
232
- 'xcodebuild, or swift-symbolgraph to build the module ' \
233
- 'to be documented. By default it uses xcodebuild if ' \
234
- 'there is a .xcodeproj file in the source directory.' ,
232
+ 'xcodebuild, or swift-symbolgraph to build the module ' \
233
+ 'to be documented. By default it uses xcodebuild if ' \
234
+ 'there is a .xcodeproj file in the source directory.' ,
235
235
parse : -> ( tool ) do
236
236
return tool . to_sym if SWIFT_BUILD_TOOLS . include? ( tool )
237
237
@@ -260,13 +260,13 @@ def hide_objc?
260
260
config_attr :version ,
261
261
command_line : '--module-version VERSION' ,
262
262
description : 'Version string to use as part of the default docs ' \
263
- 'title and inside the docset.' ,
263
+ 'title and inside the docset.' ,
264
264
default : '1.0'
265
265
266
266
config_attr :title ,
267
267
command_line : '--title TITLE' ,
268
268
description : 'Title to display at the top of each page, overriding the ' \
269
- 'default generated from module name and version.' ,
269
+ 'default generated from module name and version.' ,
270
270
default : ''
271
271
272
272
config_attr :copyright ,
@@ -291,16 +291,16 @@ def hide_objc?
291
291
config_attr :podspec ,
292
292
command_line : '--podspec FILEPATH' ,
293
293
description : 'A CocoaPods Podspec that describes the Swift library to ' \
294
- 'document' ,
294
+ 'document' ,
295
295
parse : -> ( ps ) { PodspecDocumenter . create_podspec ( Pathname ( ps ) ) if ps } ,
296
296
default : Dir [ '*.podspec{,.json}' ] . first
297
297
298
298
config_attr :pod_sources ,
299
299
command_line : [ '--pod-sources url1,url2,…urlN' , Array ] ,
300
300
description : 'A list of sources to find pod dependencies. Used only ' \
301
- 'with --podspec when the podspec contains references to ' \
302
- 'privately hosted pods. You must include the default pod ' \
303
- 'source if public pods are also used.' ,
301
+ 'with --podspec when the podspec contains references to ' \
302
+ 'privately hosted pods. You must include the default pod ' \
303
+ 'source if public pods are also used.' ,
304
304
default : [ ]
305
305
306
306
config_attr :docset_icon ,
@@ -322,7 +322,7 @@ def hide_objc?
322
322
config_attr :dash_url ,
323
323
command_line : [ '-d' , '--dash_url URL' ] ,
324
324
description : 'Location of the dash XML feed ' \
325
- 'e.g. https://realm.io/docsets/realm.xml)' ,
325
+ 'e.g. https://realm.io/docsets/realm.xml)' ,
326
326
parse : -> ( d ) { URI ( d ) }
327
327
328
328
SOURCE_HOSTS = %w[ github gitlab bitbucket ] . freeze
@@ -365,13 +365,13 @@ def hide_objc?
365
365
config_attr :docset_playground_url ,
366
366
command_line : '--docset-playground-url URL' ,
367
367
description : 'URL of an interactive playground to demonstrate the ' \
368
- 'framework, linked to from the docset.'
368
+ 'framework, linked to from the docset.'
369
369
370
370
# ──────── Doc generation options ────────
371
371
config_attr :disable_search ,
372
372
command_line : '--disable-search' ,
373
373
description : 'Avoid generating a search index. ' \
374
- 'Search is available in some themes.' ,
374
+ 'Search is available in some themes.' ,
375
375
default : false
376
376
377
377
config_attr :skip_documentation ,
@@ -391,7 +391,7 @@ def hide_objc?
391
391
config_attr :skip_undocumented ,
392
392
command_line : '--[no-]skip-undocumented' ,
393
393
description : "Don't document declarations that have no documentation " \
394
- 'comments.' ,
394
+ 'comments.' ,
395
395
default : false
396
396
397
397
config_attr :hide_documentation_coverage ,
@@ -401,21 +401,21 @@ def hide_objc?
401
401
402
402
config_attr :custom_categories ,
403
403
description : 'Custom navigation categories to replace the standard ' \
404
- "'Classes', 'Protocols', etc. Types not explicitly named " \
405
- 'in a custom category appear in generic groups at the ' \
406
- 'end. Example: https://git.io/v4Bcp' ,
404
+ "'Classes', 'Protocols', etc. Types not explicitly named " \
405
+ 'in a custom category appear in generic groups at the ' \
406
+ 'end. Example: https://git.io/v4Bcp' ,
407
407
default : [ ]
408
408
409
409
config_attr :custom_categories_unlisted_prefix ,
410
410
description : "Prefix for navigation section names that aren't " \
411
- 'explicitly listed in `custom_categories`.' ,
411
+ 'explicitly listed in `custom_categories`.' ,
412
412
default : 'Other '
413
413
414
414
config_attr :hide_unlisted_documentation ,
415
415
command_line : '--[no-]hide-unlisted-documentation' ,
416
416
description : "Don't include documentation in the sidebar from the " \
417
- "`documentation` config value that aren't explicitly " \
418
- 'listed in `custom_categories`.' ,
417
+ "`documentation` config value that aren't explicitly " \
418
+ 'listed in `custom_categories`.' ,
419
419
default : false
420
420
421
421
config_attr :custom_head ,
@@ -429,9 +429,9 @@ def hide_objc?
429
429
config_attr :theme_directory ,
430
430
command_line : "--theme [#{ BUILTIN_THEMES . join ( ' | ' ) } | DIRPATH]" ,
431
431
description : "Which theme to use. Specify either 'apple' (default), " \
432
- 'one of the other built-in theme names, or the path to ' \
433
- 'your mustache templates and other assets for a custom ' \
434
- 'theme.' ,
432
+ 'one of the other built-in theme names, or the path to ' \
433
+ 'your mustache templates and other assets for a custom ' \
434
+ 'theme.' ,
435
435
default : 'apple' ,
436
436
parse : -> ( t ) do
437
437
if BUILTIN_THEMES . include? ( t )
@@ -444,9 +444,9 @@ def hide_objc?
444
444
config_attr :use_safe_filenames ,
445
445
command_line : '--use-safe-filenames' ,
446
446
description : 'Replace unsafe characters in filenames with an encoded ' \
447
- 'representation. This will reduce human readability of ' \
448
- 'some URLs, but may be necessary for projects that ' \
449
- 'expose filename-unfriendly functions such as /(_:_:)' ,
447
+ 'representation. This will reduce human readability of ' \
448
+ 'some URLs, but may be necessary for projects that ' \
449
+ 'expose filename-unfriendly functions such as /(_:_:)' ,
450
450
default : false
451
451
452
452
config_attr :template_directory ,
@@ -466,14 +466,14 @@ def hide_objc?
466
466
config_attr :undocumented_text ,
467
467
command_line : '--undocumented-text UNDOCUMENTED_TEXT' ,
468
468
description : 'Default text for undocumented symbols. The default ' \
469
- 'is "Undocumented", put "" if no text is required' ,
469
+ 'is "Undocumented", put "" if no text is required' ,
470
470
default : 'Undocumented'
471
471
472
472
config_attr :separate_global_declarations ,
473
473
command_line : '--[no-]separate-global-declarations' ,
474
474
description : 'Create separate pages for all global declarations ' \
475
- "(classes, structures, enums etc.) even if they don't " \
476
- 'have children.' ,
475
+ "(classes, structures, enums etc.) even if they don't " \
476
+ 'have children.' ,
477
477
default : false
478
478
479
479
# rubocop:enable Layout/ArgumentAlignment
0 commit comments