https://bugzilla.novell.com/show_bug.cgi?id=300970 https://bugzilla.novell.com/show_bug.cgi?id=300970#c6 --- Comment #6 from Sascha Peilicke <speilicke@suse.com> 2011-11-22 08:34:03 UTC --- (In reply to comment #5)
Later in the description Cornelius said, "There might be more [that are wrong]," and he's right. I've been working to find a way to keep the API doc up-to-date automatically each time a change is made to the API. Automated doc mechanisms such as RDoc (and doxygen) don't handle Rails well. Still working on this. You're right, rdoc isn't the best tool for documenting the HTTP API. There are some tools that try to automate parts of it:
http://code.google.com/p/rapidoc/ http://everydayrails.com/2010/10/16/rails-documentation-tools.html But that would just be about replacing our own mechanism with another one. Ideally, Rails would (and could) generate this automatically because it has knowledge about the models, controllers and the (HTTP) routes map. Maybe there are other gems for doing that ;-) Though I fear that all the custom, hand-crafted code in the OBS api isn't that discoverable for standard Rails mechanisms. You can try this with 'rake routes'. -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug.