UniversityRadioYork / ury-rapid

(obsolete) Radio API Daemon
BSD 2-Clause "Simplified" License
2 stars 0 forks source link

Convert documentation from TomDoc to YARD #14

Closed MattWindsor91 closed 10 years ago

MattWindsor91 commented 10 years ago

I've decided to switch to YARD because I can then make use of rubydoc.info and its GitHub service hooks.

Most of the comments in bra are in TomDoc format (any comment that begins with "Public:" or "Internal:", and as such need converting.

The YARD format is documented at http://yardoc.org/. bra's YARD documentation is at http://rubydoc.info/github/UniversityRadioYork/bra.

MattWindsor91 commented 10 years ago

Most things are YARD now, if not all. Closing.