search

josephholsten / rets4r

Bringing RETS to ruby
MIT License
52 stars 28 forks source link

convert docs to YARD style #1

Open josephholsten opened 14 years ago

josephholsten commented 14 years ago

Makes docs play nice with rdoc.info see http://rubydoc.info/gems/yard/file/docs/GettingStarted.md

jwhitehorn commented 9 years ago

What's the status of this? ;-)

josephholsten commented 9 years ago

yow, this is still pretty bad. Gotta love http://rubydoc.info/github/josephholsten/rets4r/RETS4R/Auth

The main reason for this is to document what the expected public interface is. At the moment, it's not clear where a user is supposed to start, and what methods are safe to call.

99% of the value would be from adding: