incubator-deltacloud-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject Tool for generating API documentation
Date Tue, 14 Sep 2010 13:03:03 GMT

I created a small but usefull tool to generate static HTML
documentation for API. This tool use Rabbit DSL to get
information about collections and operations under collections.
Usage is simple:

cd core/server
support/tools/generate_documentation.rb > docs.html

Documentation includes information about collection, operation,
and URIs. I hope this can be extra usefull for those people who
are implementing deltacloud API natively. Let me know if you
are missing some info in generated docs.

  -- Michal

PS: For sample output:

View raw message