ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 47730] New: javadoc for buildStarted() in org.apache.tools.ant.BuildListener should be updated.
Date Tue, 25 Aug 2009 03:34:00 GMT
https://issues.apache.org/bugzilla/show_bug.cgi?id=47730

           Summary: javadoc for buildStarted() in
                    org.apache.tools.ant.BuildListener should be updated.
           Product: Ant
           Version: 1.7.1
          Platform: PC
        OS/Version: Windows XP
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
        AssignedTo: notifications@ant.apache.org
        ReportedBy: goldflowersecret@yahoo.com


--- Comment #0 from Rob Justice <goldflowersecret@yahoo.com> 2009-08-24 20:33:59 PDT
---
The method-level documentation should note that the Properties object is not
yet instantiated, returns null, when this event fires.  Bug 35158 (build 1.6.4)
notes this as a core bug that will not be fixed, so the documentation should at
least make note of it.

The properties object is instantiated when the taskStarted event fires.  I'm
unsure which of the remaining build events would also return a null Properties
object.

A documentation  alternative would be to write this information once in the
Project.getProperties() javadoc, then add @see javadoc comments for this method
in all the javadoc for the build events, buildStarted included.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

Mime
View raw message