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

Bruno Oliveira bruno at abstractj.org
Fri Jul 19 08:57:36 EDT 2013


+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



More information about the aerogear-dev mailing list