Monday, December 24, 2012

Ruby - Notes on using Yardoc

List Options
$> yard help doc

Add additional tags:


>$ yardoc --tag data_source:"Data Source"
where data_source is the tag in comment.  e.g.  # @datasource The data is gathered by client collection.
"Data Source" is the string that appears on the generated document.

OR

Create a .yardopts file in project root, add the line --tag data_source:"Data Source"
Then >$yardoc

https://rubydoc.tenderapp.com/kb/getting-started-with-rubydocinfo/setting-up-a-yardopts-file





No comments:

Post a Comment

Note: Only a member of this blog may post a comment.