.
We can use a tool like doxygen(i don’t know if available for java) to generate
documentation from source code. Infact, anyone interested can run the doxygen
build locally and use.
but, this tool is of no use if we don’t improve the code
documentation/standards.
~Rajani
On 13-Jun-2014, at 8
]
Sent: Friday, June 13, 2014 10:59 AM
To: dev@cloudstack.apache.org
Subject: Re: Code Documentation
On Wed, Jun 11, 2014 at 9:58 PM, Santhosh Edukulla <
santhosh.eduku...@citrix.com> wrote:
> Hi All,
>
> Many of code areas under CS, currently don't have enough documentation i
&g
de areas.
>
> We in one of our earlier project, used to enforce strictly a template for
> comments\documentation for every new function added. These comments were
> later retrieved automatically to build code documentation easily. This gets
> enforced during review itself, or othe
y new function added. These comments were later
retrieved automatically to build code documentation easily. This gets enforced
during review itself, or otherwise review wont be accepted. It will make the
flow lot easier to understand some times i believe.
Please add atleast basic descriptio
