EricFromCanada
20167e5f1b
Adjust comments to tidy API docs output.
2018-10-18 21:42:43 -04:00
Mike McQuaid
2c959a7d58
More API documentation.
...
And remove the documented stuff from the `example-formula.rb`.
Closes Homebrew/homebrew#43241 .
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-29 15:43:16 +01:00
Xu Cheng
3e8be58cdf
yardopts: stop documenting compat codes
...
Closes Homebrew/homebrew#42243 .
Signed-off-by: Xu Cheng <xucheng@me.com>
2015-07-29 20:42:25 +08:00
Mike McQuaid
858f7fb529
Document Formula attributes.
...
The beginnings of some decent API documentation.
Also, tweak `.yardopts` to better fix our internal style.
2014-12-08 12:41:50 +00:00
Mike McQuaid
7b02304b64
Improve API documentation output.
...
And include more files.
2014-10-26 15:42:41 +00:00
Loren Segal
bb167ef902
yardopts: specify "extra" files.
...
The current .yardopts is treating extra .md files as source code rather
than registering them as "extra files". YARD needs a "-" to separate
source from non-source files.
Closes Homebrew/homebrew#33362 .
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-10-20 08:24:06 +01:00
Mike McQuaid
5f1a18c3ae
yardopts: look for more Markdown files.
...
But exclude vendored stuff.
2014-10-19 17:23:08 +01:00
Mike McQuaid
93c71bafca
Use YARD for API documentation.
...
Massive TODO.
We'll get there eventually...
2014-10-18 11:19:36 +01:00
