Hi,
do we use code, tt or {...@code}? I found all three version. Is there a
Checkstyle for that?
Do we introduce a newline between the Javadoc body and the @param,
@return or @throws clause? Again I see both:
/**
* create the /Font object
*
* @param fontname the internal name
Hi Alexander,
Alexander Kiel wrote:
Hi,
do we use code, tt or {...@code}? I found all three version. Is there a
Checkstyle for that?
Use {...@code}. HTML tags should be avoided as much as possible.
Do we introduce a newline between the Javadoc body and the @param,
@return or @throws
On 01.10.2009 15:08:55 Vincent Hennebert wrote:
Hi Alexander,
Alexander Kiel wrote:
Hi,
do we use code, tt or {...@code}? I found all three version. Is there a
Checkstyle for that?
Use {...@code}. HTML tags should be avoided as much as possible.
Do we introduce a newline
Hi Jeremias,
there is a JavadocStyleCheck. I have it includes in my
checkstyle-5.0.xml for testing. I use the standard settings. It tests
for empty JavaDoc and missing points in the first line.
I didn't found anything which checks for {...@code} instead of tt and
code. Can we add the use of
Hi Jeremias,
Jeremias Maerki wrote:
On 01.10.2009 15:08:55 Vincent Hennebert wrote:
Hi Alexander,
Alexander Kiel wrote:
Hi,
do we use code, tt or {...@code}? I found all three version. Is there a
Checkstyle for that?
Use {...@code}. HTML tags should be avoided as much as possible.
Do
On 01.10.2009 15:55:57 Alexander Kiel wrote:
Hi Jeremias,
there is a JavadocStyleCheck. I have it includes in my
checkstyle-5.0.xml for testing. I use the standard settings. It tests
for empty JavaDoc and missing points in the first line.
Yes, but it can't check for that mandatory line
Hi Jeremias,
there is a JavadocStyleCheck. I have it includes in my
checkstyle-5.0.xml for testing. I use the standard settings. It tests
for empty JavaDoc and missing points in the first line.
Yes, but it can't check for that mandatory line between the body and the
parameters, right?
On 01.10.2009 16:44:13 Alexander Kiel wrote:
Hi Jeremias,
there is a JavadocStyleCheck. I have it includes in my
checkstyle-5.0.xml for testing. I use the standard settings. It tests
for empty JavaDoc and missing points in the first line.
Yes, but it can't check for that mandatory
Hi Jeremias,
While researching I found that I seem to have used @code accidentally in
some places but with the actual intention of using @link (see
IFDocumentHandler, for example). What a mess. :-( I'll fix that.
I've already fixed the obvious mistakes.
There are only 23 other
On 01.10.2009 17:09:48 Alexander Kiel wrote:
Hi Jeremias,
While researching I found that I seem to have used @code accidentally in
some places but with the actual intention of using @link (see
IFDocumentHandler, for example). What a mess. :-( I'll fix that.
I've already fixed
10 matches
Mail list logo
