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
From YARD documentation: In the Getting Started Guide with YARD section under Using YARD to Generate Documentation, check out Documenting Extra Files or Adding Meta-Data to Extra Files. It might help.
YARD now supports param defaults automatically. YARD automatically figures out the default value based on the method definition. Sweedish! For example, the following code documentation will produce the subsequent YARD doc: Code Documentation # Squares a number. # # @param number [Integer] The number to square. # def square_a_number(number = 2) number * number end … Read more
You can specifically list all undocumented objects (and their file locations) with the –list-undoc option. yard stats –list-undoc or even yard –list-undoc