Skip to content

Commit

Permalink
(Maint) Only show YARD docs for methods tagged with @api
Browse files Browse the repository at this point in the history
Without this, docs are generated for any method with a comment before it. They
have the same appearance as methods marked public API. Rather than give the
appearance that these are public, this makes it so only methods that have been
given an explicit api classification are displayed. This will be very few at
first, but lets us grow our API specification in a more dependable way.

This also hides (void) on methods that don't return a meaningful value. Since
void is not a meaningful term in Ruby, this seemed to give the most intuitive
output.
  • Loading branch information
pcarlisle committed Jan 8, 2013
1 parent cdd6b87 commit 59c8729
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .yardopts
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@
--tag dsl:"DSL"
--no-transitive-tag api
--template-path yardoc/templates
--query has_tag?(:api)
--hide-void-return
lib/**/*.rb

0 comments on commit 59c8729

Please sign in to comment.