Should I just continue to use the @param keyword? Yes. YARD recognizes keyword arguments. Use @param to document a single method parameter (either regular or keyword) with a given name, type and optional description: # @param query [String] The search string # @param exact_match [Boolean] whether to do an exact match # @param results_per_page [Integer] … Read more
Did you generate the docs? rvm docs generate https://rvm.io/rubies/docs/
Although this question is old, nobody has yet provided a proper solution. I just ran into the same issue, and found the solution: If you are using RVM: rvm docs generate-ri # <- Just the ri docs, much faster rvm docs generate # <- Everything (rdoc + ri) More info on managing RVM docs here: … Read more
RDoc [..] is the embedded documentation generator for the Ruby programming language. [..] RDoc is included as part of the Ruby core distribution. RDoc also provides the engine for creating Ruby ri data files. ri is (more or less) Ruby’s version of man pages, serving up API information from the command line. From: http://en.wikipedia.org/wiki/RDoc
A few things that have bitten me: :main: — RDoc uses only the last one evaluated; best to make sure there’s only one in your project and you don’t also use the –main command-line argument. same as previous, but for :title: :section: doesn’t work very well
An official rdoc example can be found here, with its GitHub source. The documentation at rdoc.rubyforge.org seems to be more complete than the version at rdoc.sourceforge.net (which incidentally has a 2003 modified date). Also, there is a great source of examples: the Ruby core and stdlib documentation. For example, take a look at one of … Read more