Page 1 of 1

Cobra Enhancement Proposal: Documentation

PostPosted: Sat Jun 20, 2009 1:10 am
by todd.a
Like the title? CEPs :)

Our discussions on IRC earlier brought up questions regarding documentation. Python uses reStructuredText; however, this may be limiting since Cobra has support for static typing. We decided it would be best to borrow ideas from C#'s XML Docs, Doxygen, Pydoc, Javadoc, etc. Below is an example of what it can look like:
Summary goes right at the start of the string

Further descriptions go in here. Paragraphs are separated by a blank line.
Classes methods and interfaces can probably be reflected. Could use Markdown
or Textile syntax in here.

foo = Bar()

@exceptions (classes and methods only)
@deprecated some deprecation information
@param (methods only)
@return (methods only)

@see FooException BarException IFooBar
class Foo

Any ideas for additional parameters or syntax?