DO NOT REPLY [Bug 32927] New: - javadoc task: description required for tag element

[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=32927>.
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=32927

           Summary: javadoc task: description required for tag element
           Product: Ant
           Version: 1.6.2
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Core tasks
        AssignedTo: dev@ant.apache.org
        ReportedBy: petertje@luminis.nl


IMHO it seems a bit silly that the description parameter of the tag element of
the javadoc tag is required. Especially when you use the tag element to
_suppress_ processing of a custom tag (e.g. xdoclet tags when generating javadoc
docs), it is strange that you _have_ to specify a description (and moreover: it
fails without any message when you don't).
The javadoc tool itself does not require a 'taghead' (as it is called there): it
simply defaults to the tagname.
I would suggest a fix like (in the TagArgument inner class in Javadoc):

        public String getParameter () throws BuildException {
            if (name == null || name.equals("")) {
                throw new BuildException ("No name specified for custom tag.");
            }
            if (description != null) {
                return name + ":" + (enabled ? "" : "X")
                    + scope + ":" + description;
            } else {
                return name + ":" + (enabled ? "" : "X")
                    + scope + ":" + name;
            }
        }
    }

-- 
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