[aerogear-dev] Adding JavaDocs, while hacking on code

[Sebastien Blanc]

+1
Matzew suggestion/rule seems good : each time you touch a file =>
create/update javadoc. It is a good start



On Fri, Jul 19, 2013 at 2:57 PM, Bruno Oliveira <bruno at abstractj.org> wrote:

> +1 Is not necessary to be a huge text, just a short explanation what
> that class does.
>
> I fail at Javadocs, so you guys are free to remind me about the same thing.
>
> Christos Vasilakis wrote:
> > Hi,
> >
> > in a recent PR for the UnifiedPush server Bruno made a good point:
> >
> > ==> Add more JavaDoc!
> >
> > IMO it helps others (contributors and project members) to understand the
> > code better.
> >
> >
> > I think there is no need to submit a 'gigantic' "JavaDoc overhaul" PR,
> > but I will do the following:
> > For every change that I make, I will add more/polished JavaDoc to the
> > touched classes.
> >
> > -Matthias
>
> --
> abstractj
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20130719/b9f9b33a/attachment.html