[undertow-dev] javadoc style

Stuart Douglas sdouglas at redhat.com
Tue Jun 10 08:53:15 EDT 2014

To be honest I have not really thought about it, I don't really have a 
strong preference either way, although it would be better if everything 
was consistent.

The reason why your PR has not been merged yet was because I have been 
really busy these last few days, nothing to do with the javadoc style :-)


Bernd Eckenfels wrote:
> Hallo,
> for the following minor JavaDoc pull request I wonder about the
> paragraph style:
> https://github.com/ecki/undertow/commit/9fae96a2d43dcd6de0be0755babd9c4620f8410b
> It seems that most, but not all other Javadocs use a "self closing"
> XHTML "<p/>", whereas Oracle seems to go the HTML route and javadoclint
> regards them as error.
> I have also seen some javadoc comments with empty lines and no<p>  at
> all. And finally there are some<p>line</p>, even for the first line.
> What is the prefered style? I personally like the html style:
> * First sentence.
> *<p>
> * More text on its own paragraph.
> * Can have line breaks which are ignored by Javadoc.
> *<p>
> * Just like this.
> *<p>
> * Linebreaks like these<br>
> * should be avoided.
> In case my<p>  style is the problem which blocks the PR from beeing
> merged, let me known.
> Gruss
> Bernd
> _______________________________________________
> undertow-dev mailing list
> undertow-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/undertow-dev

More information about the undertow-dev mailing list