YARD Doc Example

Simple examples of documenting with YARD.

Examples

Please see lib/yard_doc_example.rb file.

Generated docs

  • View the docs locally: open the doc/index.html file in browser
  • View the docs on rubydoc.info

References