ruby.git/lib/rdoc/options.rb, branch v3_4_9

Sync RDoc 6.14.0

2025-05-22T22:04:47+00:00

[ruby/rdoc] Print warnings for rdoc-ref links that can't be resolved

2024-12-16T19:35:00+00:00

(https://github.com/ruby/rdoc/pull/1241)

https://github.com/ruby/rdoc/commit/4a5206ae56

[ruby/rdoc] feature: Render mixed-in methods and constants with

2024-10-17T20:40:34+00:00

`--embed-mixins`
(https://github.com/ruby/rdoc/pull/842)

* Embed mixed-in methods and constants with `--embed-mixins`

When `--embed-mixins` option is set:

- methods from an `extend`ed module are documented as singleton methods
- attrs from an `extend`ed module are documented as class attributes
- methods from an `include`ed module are documented as instance methods
- attrs from an `include`ed module are documented as instance attributes
- constants from an `include`ed module are documented

Sections are created when needed, and Darkfish's template annotates
each of these mixed-in CodeObjects. We also respect the mixin methods'
visibility.

This feature is inspired by Yard's option of the same name.

* Add comment to document why we set object visibility

Co-authored-by: Stan Lo 

* Add the mixin_from attribute to CodeObject's initializer

* Add test coverage for private mixed-in attributes.

---------

https://github.com/ruby/rdoc/commit/481c2ce660

Co-authored-by: Stan Lo

[ruby/rdoc] [DOC] Mods about markup formats

2024-07-29T13:16:18+00:00

(https://github.com/ruby/rdoc/pull/1143)

https://github.com/ruby/rdoc/commit/011de3f2fd

[ruby/rdoc] Improve rubocop setup

2024-07-17T20:43:08+00:00

(https://github.com/ruby/rdoc/pull/1139)

* Rename rake rubocop to rake format_generated_files

* Add rubocop rules to ensure spaces are applied consistently

* Improve rubocop related CI workflows

https://github.com/ruby/rdoc/commit/27932d001c

[ruby/rdoc] Ignore `locale` at `write_options`

2024-01-06T10:17:49+00:00

`@locale` is set from `@locale_name` and loaded from `@locale_dir`
after `write_options`, and `RDoc::I18n::Locale` does not seem to
expected to be loaded.

https://github.com/ruby/rdoc/commit/fd610f7023

[ruby/rdoc] Isolate root dir if specified

2023-05-06T07:39:24+00:00

This ensures only files from the root directory are chosen, in order to allow a clean build from outside the source directory.

https://github.com/ruby/rdoc/commit/f3b389aa9e

[ruby/rdoc] Add `--no-skipping-tests` option

2022-11-28T04:36:29+00:00

https://github.com/ruby/rdoc/commit/33925f885f

[ruby/rdoc] Dump plain objects as `RDoc::Options`

2022-02-12T07:15:08+00:00

So that the generated `.rdoc_options` file is loadable.

https://github.com/ruby/rdoc/commit/6cf6e1647b

[ruby/rdoc] Add tests for `--template-stylesheets` option

2021-09-03T10:13:15+00:00

Also flattens `@options.template_stylesheets` when parsing the
command lines.

Fixes #205
Fixes #828 too

https://github.com/ruby/rdoc/commit/857002a763