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

Sync RDoc 6.14.0

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

[ruby/rdoc] ClassModule#superclass= accepts a ClassModule as an

2024-12-02T22:07:31+00:00

argument
(https://github.com/ruby/rdoc/pull/1222)

It is necessary for ClassModule's instance variable @superclass to
always be a String (or nil) so that the class can be saved with
`#marshal_dump` and loaded with `#marshal_load`.

However, there's no type checking being done, which allows a bug like
the one reported in #1221 (which was introduced in #1217) that sets
superclass to a ClassModule. That bug requires:

- setting a superclass to a NormalClass
- marshal_save
- marshal_load (which raises an exception)

With this change, passing a ClassModule to ClassModule#superclass= is
explicitly allowed by saving the full name of the ClassModule in the
@superclass instance variable.

https://github.com/ruby/rdoc/commit/9ced6d534c

[ruby/rdoc] Display class ancestors in the sidebar #1183

2024-11-04T17:34:27+00:00

https://github.com/ruby/rdoc/commit/50dda13426

[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] Group code object files into the same directory

2024-07-02T10:15:00+00:00

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

It's hard to distinguish code object classes by their file names alone.
And given that we have 18 such classes, it'd make the codebase a lot
easier to understand if we grouped them into a single directory.

Given that these classes are all autoloaded in `lib/rdoc.rb` instead
of required individually, this change should have minimum impact on
projects using RDoc as they generally just require `rdoc`, not individual
files. An example is Rails' `sdoc`:
https://github.com/rails/sdoc/blob/main/lib/sdoc/rdoc_monkey_patches.rb

https://github.com/ruby/rdoc/commit/4211292ffe