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

Sync RDoc 6.14.0

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

[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

Merge rdoc-6.0.0.beta4 from upstream.

2017-11-27T10:45:24+00:00

  It version applied `frozen_string_literal: true`

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60920 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Merge rdoc-6.0.0.beta1.

2017-08-29T11:52:50+00:00

  This version fixed strange behavior of ruby code parser.
  We will list all of impromovement to Changelog when 6.0.0 releasing.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59686 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc/, test/rdoc/: Update rdoc-5.0.0.beta2

2016-09-07T22:23:38+00:00

  Fixed ri parse defect with left-hand matched classes.
  https://github.com/rdoc/rdoc/pull/420

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56097 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Add frozen_string_literal: false for all files

2015-12-16T05:07:31+00:00

When you change this to true, you may need to add more tests.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53141 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc: Update to RDoc 4.1.0.preview.1

2013-09-18T23:33:36+00:00

  RDoc 4.1.0 contains a number of enhancements including a new default
  style and accessibility support.  You can see the changelog here:

  https://github.com/rdoc/rdoc/blob/v4.1.0.preview.1/History.rdoc

* test/rdoc:  ditto.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42971 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc/servlet.rb: Fixed display of site and home documentation.

2013-01-23T01:02:24+00:00

  Fixes rdoc issue #170 by Thomas Leitner.
* test/rdoc/test_rdoc_servlet.rb:  Test for above.

* lib/rdoc/code_object.rb:  Split #initialize_visibility from
  #initialize for reuse when loading a stored object.
  Fixes rdoc issue #171 by Thomas Leitner.

* lib/rdoc/any_method.rb:  Initialize visibility for #display?  For
  rdoc issue #171
* lib/rdoc/attr.rb:  ditto.
* lib/rdoc/class_module.rb:  ditto.
* lib/rdoc/top_level.rb:  ditto.
* test/rdoc/test_rdoc_any_method.rb:  Test for above.
* test/rdoc/test_rdoc_attr.rb:  ditto.
* test/rdoc/test_rdoc_class_module.rb:  ditto.
* test/rdoc/test_rdoc_constant.rb:  ditto.
* test/rdoc/test_rdoc_top_level.rb:  ditto.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38899 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc*: Updated to RDoc 4.0 (pre-release)

2012-11-27T04:28:14+00:00

* bin/rdoc:  ditto
* test/rdoc:  ditto
* NEWS:  Updated with RDoc 4.0 information


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc: Update to RDoc 3.9. Fixed `ri []`, stopdoc creating an

2011-07-31T00:19:00+00:00

	  object reference, nodoc for class aliases, verbatim === lines.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32767 b2dd03c8-39d4-4d8f-98ff-823fe69b080e