luislee818/yard_doc_example

An example of documenting with YARD

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

• Getting Started guide with YARD
• YARD Tags
• YARD cheat sheet