[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
RE: [platform-releng-dev] Javadoc warnings in I20060216-0800
|
Is there a standard importable compiler options settings file somewhere that people can use when building the Eclipse project?
FWIW, there are some code formatter settings that the Platform/Core team uses here:
http://www.eclipse.org/eclipse/platform-core/documents/coding_conventions.html
> -----Original Message-----
> From: platform-releng-dev-bounces@xxxxxxxxxxx
> [mailto:platform-releng-dev-bounces@xxxxxxxxxxx] On Behalf Of
> Frederic Fusier
> Sent: Friday, February 17, 2006 8:40 AM
> To: Eclipse platform release engineering list.
> Subject: Re: [platform-releng-dev] Javadoc warnings in I20060216-0800
>
> Compiler Javadoc default options is "Process Javadoc
> comments" but ignore
> malformed and missing ones. That means Javadoc comments are
> only parsed to
> be
> able to find types/methods/fields references but *no error*
> is reported.
> This is the default behavior to avoid extra times penalties
> while compiling
> when we introduced these options in 3.0 (a long time ago...).
>
> So, I would advice to change this default behavior to report errors in
> malformed Javadoc comments (ie. set "Malformed Javadoc comments" to
> "Warning")
> and also report errors in tags (ie. check "Report errors in tags").
>
> The former option will report any syntax error in your
> javadoc (for example
> empty @see tag, missing closing brace in in-line tag, invalid
> reference as
> "java..lang.Object", etc.), the latter will report issues with unknown
> references (for example nonexistent types or methods, duplicate @param
> tags,
> unthrown exceptions in @throws tag, etc.)
>
>
> Cordialement/Regards,
>
> Frédéric
>
