Jessica Tomechak created CLOUDSTACK-1931:
--------------------------------------------
Summary: API Reference: need additional sections in each entry
Key: CLOUDSTACK-1931
URL: https://issues.apache.org/jira/browse/CLOUDSTACK-1931
Project: CloudStack
Issue Type: Improvement
Security Level: Public (Anyone can view this level - this is the default.)
Components: API, Doc
Reporter: Jessica Tomechak
We need sections like Requirements or Rules (things you have to do to avoid a
runtime error), Tips (things we advise you to do), Limitations (things it can't
do), Code Examples, and Related Commands. This is the minimum I'd expect to see
in an API reference, and we don't have it. First we'd need to add these fields
in the code for each API command and make the doc generator recognize them.
Expanding the command summary description and the parameter descriptions is
needed also, but is tracked in separate bugs. We already have the
infrastructure in the API code to support those.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
