rdoc
rdoc copied to clipboard
RDoc produces HTML and online documentation for Ruby projects.
1. Move the `[R]` part outside the underlined and linked `` tag 2. Add a `title` field to explain what `[R]`, `[W]` or `[RW]` mean. It's fairly self-explanatory if you...
`rdoc -C` can report undocumented items, but the output is not suitable to jump in editors. It would be nice to have an option to report in TAGS file style.
`rdoc` does not usefully document data classes defined the correct way: ```ruby # Documenting a class made with Data.define MyDataClass = Data.define :a do # Capitalize the value of +a+....
https://github.com/ruby/rdoc/pull/1433#issuecomment-3458963075
It'll prevent introducing breaking changes for SDoc. See also: https://github.com/ruby/rdoc/pull/1304#issuecomment-2749251458
At this time, `@yield`, `@private` and `@api private` are supported. Ref: #1344