You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by bu...@apache.org on 2006/01/24 20:11:43 UTC

DO NOT REPLY [Bug 38370] New: - javadoc task fails if there are any non-directory components to a path structure

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370

           Summary: javadoc task fails if there are any non-directory
                    components to a path structure
           Product: Ant
           Version: 1.6.5
          Platform: PC
        OS/Version: Windows XP
            Status: NEW
          Severity: major
          Priority: P2
         Component: Core tasks
        AssignedTo: dev@ant.apache.org
        ReportedBy: george.dinwiddie@wellsfargo.com


I'm trying to have ant targets that build class diagrams using UmlGraph
(see http://www.spinellis.gr/sw/umlgraph/) Unfortunately, class diagrams
that include all of the classes in a given package are not the class
diagrams that best tell a story about the code.  Therefore I need
finer-grained control over the selection of files to diagram.

I can do this running javadoc from the command line, but then I need to
construct the appropriate classpath.

I cannot seem to get the required level of control with the ant javadoc
task because:

 * The javadoc task does not take filelists.

 * The javadoc task can take filesets, but a fileset only includes files
with a common root directory.  There seems to be no way to add filesets
together without using a path.

 * The javadoc task throws an exception if there are any non-directory
 components to a path structure.

This last fact is illustrated in these tests.

Also, the 'packagenames' attribute is required when using a path with
the javadoc task, contrary to the task documentation.

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370





------- Additional Comments From gudnabrsam@yahoo.com  2006-02-01 21:09 -------
looks like Stefan fixed this?

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370





------- Additional Comments From george.dinwiddie@wellsfargo.com  2006-01-24 20:50 -------
(In reply to comment #2)
> If this is what you wanted to do, did you try supplying >1 nested fileset to the
> javadoc task?

This would work if I only wanted to run the task for a single group of filesets,
generating a single class diagram.  But I really want to pass in the refid with
an antcall so that I only have to define the guts of the task once.  My task
involves running both the javadoc task, using the UmlGraph doclent, and the exec
task calling GraphViz (See http://www.graphviz.org/) to turn the
text-description of the class diagram into a graphical version.  That would be a
large amount of duplication, negating the usefulness of the capability.

Please take a look at the attached unit tests.  If the path contains any
non-directory elements, a BuildException is thrown.  If this is fixed, I could
live with that.

P.S.  I think it's significant that the javadoc task had no unit tests.

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


gudnabrsam@yahoo.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |NEEDINFO




------- Additional Comments From gudnabrsam@yahoo.com  2006-01-24 20:26 -------
(In reply to comment #0)
> I cannot seem to get the required level of control with the ant javadoc
> task because:
> 
>  * The javadoc task does not take filelists.

okay...
> 
>  * The javadoc task can take filesets, but a fileset only includes files
> with a common root directory.

So does a filelist.  :|

>  There seems to be no way to add filesets
> together without using a path.

If this is what you wanted to do, did you try supplying >1 nested fileset to the
javadoc task?

HTH,
Matt

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


bodewig@apache.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |dev@ant.apache.org




-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


bodewig@apache.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Target Milestone|---                         |1.7




------- Additional Comments From bodewig@apache.org  2006-02-02 05:51 -------
Sort of.

One test is still commented out (I ran out of time) and I intend to add
ResourceCollection support while I am at it.


-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370





------- Additional Comments From stevel@apache.org  2006-01-25 12:16 -------
>P.S.  I think it's significant that the javadoc task had no unit tests.

That will be historical. The core of ant predates junit, and as it mostly works
(using apache gump as the integration test suite), then we can get by without it.

However, the moment a task gets changed, if that task has no unit tests, then it
is time to write the tests. First the "before set" to formalise current
behavior, then the new tests to go with the new functionality.

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370





------- Additional Comments From george.dinwiddie@wellsfargo.com  2006-01-24 20:13 -------
Created an attachment (id=17493)
 --> (http://issues.apache.org/bugzilla/attachment.cgi?id=17493&action=view)
testcase illustrating the problems

The attachment contains a BuildFileTest illustrating the nature of the problem.

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


bodewig@apache.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         AssignedTo|dev@ant.apache.org          |bodewig@apache.org




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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


gudnabrsam@yahoo.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEEDINFO                    |NEW




------- Additional Comments From gudnabrsam@yahoo.com  2006-01-24 21:08 -------
I will look into this further.  Know also, that if you can build Ant from SVN
HEAD, there is a slew of resource collection stuff in there that should help
you.  If you want your path to be okay with non-directory elements, you should
be able to work around with this construct:

define your path you like... <path id="foopath">...</path>
use w/ javadoc:
<path>
  <restrict>
    <path refid="foopath" />
    <type type="dir"
          xmlns="antlib:org.apache.tools.ant.types.resources.selectors" />
  </restrict>
</path>

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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370





------- Additional Comments From gudnabrsam@yahoo.com  2006-02-02 05:59 -------
(In reply to comment #7)
> Sort of.
> One test is still commented out (I ran out of time) and I intend to add
> ResourceCollection support while I am at it.

I didn't bother to add ResourceCollection support to anything that was file-
centric and took <path>s anyway, since any all-FileResource collection can be 
added to a <path>.  I will concede that that's not necessarily intuitive, 
however... ;)

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


DO NOT REPLY [Bug 38370] - javadoc task fails if there are any non-directory components to a path structure

Posted by bu...@apache.org.
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=38370>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=38370


bodewig@apache.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED




------- Additional Comments From bodewig@apache.org  2006-04-06 19:37 -------
OK, finally got around to commit my final set of patches:

* javadoc has a new nested element sourcefiles that accepts arbitrary
  filesystem based resource collections, including filelist

* non-directories in srcpath are ignored

* packagesnames defaults to "*"

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org