lib/jazzy/config.rb in jazzy-0.9.0 vs lib/jazzy/config.rb in jazzy-0.9.1
- old
+ new
@@ -90,11 +90,11 @@
Pathname(path).expand_path(base_path) # nil means Pathname.pwd
end
# ──────── Build ────────
- # rubocop:disable Style/AlignParameters
+ # rubocop:disable Layout/AlignParameters
config_attr :output,
description: 'Folder to output the HTML docs to',
command_line: ['-o', '--output FOLDER'],
default: 'docs',
@@ -125,10 +125,19 @@
config_attr :sdk,
command_line: '--sdk [iphone|watch|appletv][os|simulator]|macosx',
description: 'The SDK for which your code should be built.',
default: 'macosx'
+ config_attr :hide_declarations,
+ command_line: '--hide-declarations [objc|swift] ',
+ description: 'Hide declarations in the specified language. Given that ' \
+ 'generating Swift docs only generates Swift declarations, ' \
+ 'this is only really useful to display just the Swift ' \
+ 'declarations & names when generating docs for an ' \
+ 'Objective-C framework.',
+ default: ''
+
config_attr :config_file,
command_line: '--config PATH',
description: ['Configuration file (.yaml or .json)',
'Default: .jazzy.yaml in source directory or ancestor'],
parse: ->(cf) { expand_path(cf) }
@@ -326,10 +335,16 @@
description: 'DEPRECATED: Use --theme instead.',
parse: ->(_) do
raise '--assets-directory is deprecated: use --theme instead.'
end
- # rubocop:enable Style/AlignParameters
+ config_attr :undocumented_text,
+ command_line: '--undocumented-text UNDOCUMENTED_TEXT',
+ description: 'Default text for undocumented symbols. The default '\
+ 'is "Undocumented", put "" if no text is required',
+ default: 'Undocumented'
+
+ # rubocop:enable Style/AlignParameter
def initialize
self.class.all_config_attrs.each do |attr|
attr.set_to_default(self)
end