rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
Hello, I think I found misleading comment or a bug. [Ri driver initialize method](https://github.com/ruby/rdoc/blob/0a3a67458381484d805687d422972c9ec92011a1/lib/rdoc/ri/driver.rb#L403) comment states that initial driver options come (partly) from result of `process_args` call. Thats not true...
The methods owned by the dynamically generated class inside the method are defined as the methods of the class outside of it. The explanation is a bit complicated, so please...
I have tried making the contents of README_FOR_APP the entry point for my RDoc as follows: ``` rdoc.main = 'doc/README_FOR_APP' # define README_FOR_APP as index rdoc.rdoc_files.include('doc/README_FOR_APP') ``` This seems to:...
If you document the ruby source code (e.g., with `rdoc -o ~/ruby-doc ~/ruby-src`), `BasicObject#singleton_method_removed` is shown as an alias of `BasicObject#singleton_method_added`, and its call-seq is present but empty. Same issue...
(@kou suggested this feature request.) An embedded directive :toc: is replaced by the table of contents (TOC) derived from the down-page headers: - If the headers are well-formed (see below),...
The class documentation does have code to identify `include`d and `extend`ed classes. However, `prepend`ed classes are not shown. See for example https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Encryption/FastAES.html and https://github.com/gettalong/hexapdf/blob/master/lib/hexapdf/encryption/fast_aes.rb#L54
gem install rails stops during the installation of ri documentation for rails-4.2.3 using windows 7 start edition
I think the following doc should ideally generate the same HTML: ```markdown ### Example doc Call Hash#transform_values to achieve something cool Call `Hash#transform_values` to achieve something cool ``` Currently the...
Here's a minimal example: ```shell $ exa -T . └── lib └── main.rb ``` ```ruby # lib/main.rb def aaa BBB ::CCC end ``` And then I run RDoc (`$ rdoc`)....
Hello rdoc-maintainers, I am creating a "pseudo" shell in ruby; actually it is embedded into a gtk-widget, and that part works fine on windows too (WSL + xming). One part...
