mirror of
https://github.com/ruby/ruby.git
synced 2025-08-27 23:16:42 +02:00
0b38e18488
`--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 <stan001212@gmail.com>
* Add the mixin_from attribute to CodeObject's initializer
* Add test coverage for private mixed-in attributes.
---------
|
||
|---|---|---|
| .. | ||
| css | ||
| fonts | ||
| images | ||
| js | ||
| .document | ||
| _footer.rhtml | ||
| _head.rhtml | ||
| _sidebar_classes.rhtml | ||
| _sidebar_extends.rhtml | ||
| _sidebar_in_files.rhtml | ||
| _sidebar_includes.rhtml | ||
| _sidebar_installed.rhtml | ||
| _sidebar_methods.rhtml | ||
| _sidebar_navigation.rhtml | ||
| _sidebar_pages.rhtml | ||
| _sidebar_parent.rhtml | ||
| _sidebar_search.rhtml | ||
| _sidebar_sections.rhtml | ||
| _sidebar_table_of_contents.rhtml | ||
| _sidebar_toggle.rhtml | ||
| _sidebar_VCS_info.rhtml | ||
| class.rhtml | ||
| index.rhtml | ||
| page.rhtml | ||
| servlet_not_found.rhtml | ||
| servlet_root.rhtml | ||
| table_of_contents.rhtml | ||