Tag argument/javadoc question

View: New views
4 Messages — Rating Filter:   Alert me  

Tag argument/javadoc question

by William Press :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Some parts of this message have been removed. Learn more about Nabble's security policy.

Greetings,

 

I would like to compile annotations that take multiple arguments, such as

 

/**

 * @com.foo.bar(arg1=“value 1”, arg2=”value 2”)

 **/

void noop() {

}

 

I compile my original java source using ant, and when I invoke the <javadoc> task on the source, it gives me a warning about the unidentified tag.  When I use the <tag> nested tag to specify “@com.foo.bar”, it still gives me a warning, and the presence of quotes/spaces are taken kindly by <javadoc>.

 

Can I use the tag alias file with tag arguments?  Or does this only allow for specifying the tag name, itself?

 

Thanks,

Bill


Re: Tag argument/javadoc question

by Jonas Bonér-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

> Greetings,
>
>
>
> I would like to compile annotations that take multiple arguments, such as
>
>
>
> /**
>
>  * @com.foo.bar(arg1="value 1", arg2="value 2")
>
>  **/
>
> void noop() {
>
> }
>
>
>
> I compile my original java source using ant, and when I invoke the <javadoc>
> task on the source, it gives me a warning about the unidentified tag.  When
> I use the <tag> nested tag to specify "@com.foo.bar", it still gives me a
> warning, and the presence of quotes/spaces are taken kindly by <javadoc>.

Is this a problem? We do not use JavaDoc but have our own parser (and
is using QDox).

>
>
>
> Can I use the tag alias file with tag arguments?  Or does this only allow
> for specifying the tag name, itself?
>

No, it is very simplistic, only tag names for convenience. Like
'imports' or 'aliases'.

/Jonas

>
>
> Thanks,
>
> Bill


--
Jonas Bonér
Terracotta, Inc.

http://jonasboner.com
http://www.terracottatech.com

Parent Message unknown RE: Tag argument/javadoc question

by William Press :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Thanks for the info on the aliases file.

FWIW, the warnings are a problem because we need our javadocs to be clean/correct, and we get *a lot* of unnecessary warnings that make it difficult to find real problems in our API documentation.

Any other thoughts would be appreciated.

- Bill

-----Original Message-----
From: jboner@... [mailto:jboner@...] On Behalf Of Jonas Bonér
Sent: Tuesday, June 06, 2006 9:04 AM
To: user@...
Subject: Re: [backport175-user] Tag argument/javadoc question

> Greetings,
>
>
>
> I would like to compile annotations that take multiple arguments, such as
>
>
>
> /**
>
>  * @com.foo.bar(arg1="value 1", arg2="value 2")
>
>  **/
>
> void noop() {
>
> }
>
>
>
> I compile my original java source using ant, and when I invoke the <javadoc>
> task on the source, it gives me a warning about the unidentified tag.  When
> I use the <tag> nested tag to specify "@com.foo.bar", it still gives me a
> warning, and the presence of quotes/spaces are taken kindly by <javadoc>.

Is this a problem? We do not use JavaDoc but have our own parser (and
is using QDox).

>
>
>
> Can I use the tag alias file with tag arguments?  Or does this only allow
> for specifying the tag name, itself?
>

No, it is very simplistic, only tag names for convenience. Like
'imports' or 'aliases'.

/Jonas

>
>
> Thanks,
>
> Bill


--
Jonas Bonér
Terracotta, Inc.

http://jonasboner.com
http://www.terracottatech.com
_______________________________________________________________________
Notice:  This email message, together with any attachments, may contain
information  of  BEA Systems,  Inc.,  its subsidiaries  and  affiliated
entities,  that may be confidential,  proprietary,  copyrighted  and/or
legally privileged, and is intended solely for the use of the individual
or entity named in this message. If you are not the intended recipient,
and have received this message in error, please immediately return this
by email and then delete it.

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email


Re: Tag argument/javadoc question

by Alexandre Vasseur :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

I think you can use a java taglet (doclet - can't remember the exact
name given) to do as if the @com.foo.bar was a know javadoc doclet
this is odd, but I don't see other ways.
Alex

On 6/6/06, William Press <wpress@...> wrote:

> Thanks for the info on the aliases file.
>
> FWIW, the warnings are a problem because we need our javadocs to be clean/correct, and we get *a lot* of unnecessary warnings that make it difficult to find real problems in our API documentation.
>
> Any other thoughts would be appreciated.
>
> - Bill
>
> -----Original Message-----
> From: jboner@... [mailto:jboner@...] On Behalf Of Jonas Bonér
> Sent: Tuesday, June 06, 2006 9:04 AM
> To: user@...
> Subject: Re: [backport175-user] Tag argument/javadoc question
>
> > Greetings,
> >
> >
> >
> > I would like to compile annotations that take multiple arguments, such as
> >
> >
> >
> > /**
> >
> >  * @com.foo.bar(arg1="value 1", arg2="value 2")
> >
> >  **/
> >
> > void noop() {
> >
> > }
> >
> >
> >
> > I compile my original java source using ant, and when I invoke the <javadoc>
> > task on the source, it gives me a warning about the unidentified tag.  When
> > I use the <tag> nested tag to specify "@com.foo.bar", it still gives me a
> > warning, and the presence of quotes/spaces are taken kindly by <javadoc>.
>
> Is this a problem? We do not use JavaDoc but have our own parser (and
> is using QDox).
>
> >
> >
> >
> > Can I use the tag alias file with tag arguments?  Or does this only allow
> > for specifying the tag name, itself?
> >
>
> No, it is very simplistic, only tag names for convenience. Like
> 'imports' or 'aliases'.
>
> /Jonas
>
> >
> >
> > Thanks,
> >
> > Bill
>
>
> --
> Jonas Bonér
> Terracotta, Inc.
>
> http://jonasboner.com
> http://www.terracottatech.com
> _______________________________________________________________________
> Notice:  This email message, together with any attachments, may contain
> information  of  BEA Systems,  Inc.,  its subsidiaries  and  affiliated
> entities,  that may be confidential,  proprietary,  copyrighted  and/or
> legally privileged, and is intended solely for the use of the individual
> or entity named in this message. If you are not the intended recipient,
> and have received this message in error, please immediately return this
> by email and then delete it.
>
> ---------------------------------------------------------------------
> To unsubscribe from this list please visit:
>
>    http://xircles.codehaus.org/manage_email
>
>

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email