Bugs item #1228207, was opened at 2005-06-27 14:47
Message generated for change (Comment added) made by michael6666
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=1228207&group_id=29721
Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Core Framework
Group: release 4.1
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Ronald Wildenberg (rwwilden)
Assigned to: Nobody/Anonymous (nobody)
Summary: package-info.java ignored by PackageHtml module
Initial Comment:
New for Java 5.0 is the ability to provide
package-level annotations and documentation in a file
called package-info.java. The JavaDoc tool prefers
using package-info.java over package.html for
package-level documentation
(http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment).
However, the PackageHtml module explicitly requires a
package.html file. If only package-info.java is present
and the package is properly documented, PackageHtml
should not complain (or maybe it should be able to
configure it with some parameter called
'packageInfoIsAlsoOK').
----------------------------------------------------------------------
Comment By: Michael (michael6666)
Date: 2007-12-18 14:41
Message:
Logged In: YES
user_id=1958403
Originator: NO
I would like to vote for this issue.
----------------------------------------------------------------------
Comment By: Lars Kühne (lkuehne)
Date: 2007-11-03 07:53
Message:
Logged In: YES
user_id=401384
Originator: NO
Bug #1824916 has been closed as a duplicate of this bug.
----------------------------------------------------------------------
Comment By: Lars Kühne (lkuehne)
Date: 2006-05-19 20:28
Message:
Logged In: YES
user_id=401384
RFE #1490325 has been closed as a duplicate of this bug.
----------------------------------------------------------------------
Comment By: Christian Spreuer (chsp-at-siemens)
Date: 2005-08-04 11:48
Message:
Logged In: YES
user_id=1227261
As PackageHtml is not at all checking the contents of
package.html, I think it would be fully sufficient to check for
existence of package-info.java.
I can think of scenarios where either file is not yet or no more
accepted, so two Boolean bean attributes should be there,
indicating which file will silent the check.
Lars, I wish you and the rest of your family can sleep well at
nights ;-)
----------------------------------------------------------------------
Comment By: Lars Kühne (lkuehne)
Date: 2005-06-30 06:26
Message:
Logged In: YES
user_id=401384
RFE #1175642 has been closed as a duplicate of this bug.
From
http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html:
-- snip --
package-info.java: You can now create a source file
with this name to store package comments and
annotations. It can be used in place of package.html
(which supports only comments, not annotations). If
package-info.java is present, javadoc should ignore
package.html and look instead for the package doc
comment immediately preceding the (possibly annotated)
package declaration. The javadoc tool handles the
selection and parsing of package-info.java and
package.html and passes the doc comments to the doclet.
-- snip --
Note that this means that simply checking for existence of
package-info.java is not enough, the file needs to be parsed
and analysed.
Unfortunately I currently don't have the time to work on
this issue (newborn baby), assigning to 'None'. And yes, I'd
like to meet that 'None' guy and ask him how he achieves
infinite capacity.
----------------------------------------------------------------------
Comment By: Oleg Sukhodolsky (o_sukhodolsky)
Date: 2005-06-28 15:00
Message:
Logged In: YES
user_id=746148
the same as RFE 1175642 (PackageHtml should support
package-info.java). Assigned to Lars since he is
responsible engineer for that rfe.
Lars if you do not have a time, feel free to reassign these
bug and rfe to "none" (who always has time :)
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=1228207&group_id=29721
-------------------------------------------------------------------------
SF.Net email is sponsored by:
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services
for just about anything Open Source.
http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
_______________________________________________
Checkstyle-devel mailing list
Checkstyle-devel@xxxxxxxxxxxxxxxxxxxxx
https://lists.sourceforge.net/lists/listinfo/checkstyle-devel
|
