rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
I'm documenting a C file, say I leave a comment like this, ``` c /* * call-seq: * Math.tan(Numeric : x) -> Float * ``` It gets parsed correctly, but...
Hi there, RDoc's help states this: ``` Options can be specified via the RDOCOPT environment variable, which functions similar to the RUBYOPT environment variable for ruby. $ export RDOCOPT="--show-hash" will...
Use the following example: ``` ruby # foo.rb module Foo BAR = "omg" end ``` `$ rdoc -ro tmp foo.rb` Now try to read `Foo::BAR` with ri: `$ ri -d...
see this code-snipped: ``` # ansi console color constants COLOR_BLACK = 0 COLOR_RED = 1 COLOR_GREEN = 2 COLOR_YELLOW = 3 COLOR_BLUE = 4 COLOR_MAGENTA = 5 COLOR_CYAN = 6...
Some libraries like io/console and e.g. the extra methods in date are hard to search for because they don't define their own namespace, and aren't distributed as separate libraries. To...
When a *.c file describes a class, with methods, etc., and a *.rb exists owning the same class name, then the *.rb wins completely. Example: ext/fiddle/closure.c and ext/fiddle/lib/fiddle/closure.rb The *.c...
As requested, I'm opening an issue based upon this ruby forum thread: http://www.ruby-forum.com/topic/931304#976952 This is kinda going to be a slippery slope I'm afraid. I guess you could do a...
The lack of section comments has been annoying me for couple of years, and this was my first attempt at figuring out why it is broken. This fixes it! 🎉...
If the GitHub pages source is set to the "gh-pages" branch and the "/doc" folder, then this should get everything back up-to-date. The older version should probably work, too. But...
Make verbatims text or newline only, and simplify `build_verbatim`.
