initialize(options_Hash = {}){ |task_self| … }^?#⚙

Sets up a YARD task name, passing options, on the files listed in inventory or files, with globals set, optionally yields the task object for further customization, then #defines name.

The default for options is:

--no-private --protected --private --query \
  "(!object.docstring.blank?&&object.docstring.line)||object.root?" \
--markup markdown --no-stats

This’ll make YARD output documentation for all public, protected, and private objects not markes as @private that have documentation that hasn’t been automatically generated or is the top-level namespace using Markdown as the markup format and not outputting any statistics at the end of execution.

Options

:name_Symbol = :html

The name of the task to define

:options_{Array<String, Array<String>>} = …

The options to pass to YARD; will be passed to Shellwords.shelljoin

:inventory_Inventory = Inventory::Rake::Tasks.inventory

The inventory to use for files default

:files_{Array<String>} = FileList[ENV['FILES']] or inventory.lib_files

The files to process

:globals_Hash = {}

The globals to pass to YARD

define#⚙

Defines the following tasks (html is actually whatever #name has been set to):

.yardopts (file)

Create .yardopts file based on #options; depends on the file defining this task and Rakefile.

html

Generate documentation in HTML format for all #files, passing #globals to YARD; depends on .yardopts file.

name_Symbol#⚙

Returns the name to use for the task: VALUE.

name=(value_Symbol)_Symbol#⚙

Sets and returns the name to use for the task: value.

options_{Array<String, Array<String>>}#⚙

Returns the options to pass to YARD: VALUE.

options=(value_{Array<String, Array<String>>})_{Array<String, Array<String>>}#⚙

Sets and returns the options to pass to YARD: value.

inventory_Inventory#⚙

Returns the inventory to use: VALUE.

inventory=(value_Inventory)_Inventory#⚙

Sets and returns the inventory to use: value.

files_{Array<String>}#⚙

Returns the files to process: VALUE.

files=(value_{Array<String>})_{Array<String>}#⚙

Sets and returns the files to process: value.

globals_Hash#⚙

Returns the globals to pass to YARD: VALUE.

globals=(value_Hash)_Hash#⚙

Sets and returns the globals to pass to YARD: value.