Correct... the JDK doclet tool does not know about these tags and so it
complains about them via a warning.

"what to do" depends on what you want to do :)

How do you want these tags handled in the resulting javadocs?  Silently
ignore them?  Add them to the resulting output?

See the doclet[1] and taglet[2] overviews for complete reference.

Probably the "simplest" approach is to tell the standard doclet tool to
ignore these tags, which can unfortunately get verbose as it must be
done tag by tag:

javadoc ... -tag hibernate.property:X -tag hibernate.id:X ...

Pretty sure I remembered seeing tag support in the Gradle javadoc task,
but I do not remember the details off hand.

[1]
http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/doclet/overview.html
[2]
http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/taglet/overview.html



On Fri, 2010-07-23 at 17:47 +0200, Levi Hoogenberg wrote:
> I'm not sure about that - if Javadoc hasn't changed in this regard, then 
> unknown tags (such as XDoclet or Commons Attributes ones) have to be 
> registered before they are recognised. Gradle's Javadoc task probably 
> supports this.
> 
> Op 23 jul. 2010 om 17:25 heeft Jason Porter <[email protected]> het 
> volgende geschreven:
> 
> > On Fri, Jul 23, 2010 at 02:35, Neeraj Malik <[email protected]> wrote:
> >> 
> >> Hi,
> >> 
> >> In build.gradle I have -
> >> 
> >> 
> >> def projectsForDoc = [project(':core'), project(':web')] // the set of
> >> projects to
> >> 
> >> aggregate
> >> task javadocFull(type: Javadoc) {
> >>     source projectsForDoc.collect { project ->
> >>         project.sourceSets.main.allJava
> >>     }
> >>     classpath = files(
> >>             projectsForDoc.collect { project ->
> >>                 project.sourceSets.main.compileClasspath})
> >>     destinationDir = new File(buildDir, 'javadoc')
> >>     optionsFile = new File( 'build/tmp/javadoc.txt' )
> >> }
> >> 
> >> 
> >> 
> >> 
> >> But I get lots of warnings like -
> >> 
> >> @hibernate.property is an unknown tag.
> >> @hibernate.id is an unknown tag.
> >> @hibernate.generator-param is an unknown tag.
> >> @hibernate.subclass is an unknown tag.
> >> @hibernate.class is an unknown tag.
> >> @hibernate.component is an unknown tag.
> >> @hibernate.many-to-one is an unknown tag.
> >> @hibernate.list is an unknown tag.
> >> @hibernate.collection-one-to-many is an unknown tag.
> >> @hibernate.collection-index is an unknown tag.
> >> @hibernate.collection-key is an unknown tag.
> >> @hibernate.discriminator is an unknown tag.
> >> @hibernate.query is an unknown tag.
> >> @hibernate.discriminator is an unknown tag.
> >> 
> >> @spring.bean is an unknown tag.
> >> @spring.property is an unknown tag.
> >> 
> >> @see: can't find execute(com.search.Template) in com.search.QueryBuilder
> >> 
> >> @link: reference not found:
> >> 
> >> @inheritDoc#FlowExecutionListner.sessionStarting is an unknown tag.
> >> 
> >> 
> >> 
> >> Please advice.
> >> 
> >> Thanks.
> >> 
> >> Regards
> >> Neeraj
> >> 
> >> 
> >> 
> >> 
> > 
> > Sounds like you're missing jars on the javadoc classpath.
> > 
> > -- 
> > Jason Porter
> > http://lightguard-jp.blogspot.com
> > http://twitter.com/lightguardjp
> > 
> > Software Engineer
> > Open Source Advocate
> > 
> > PGP key id: 926CCFF5
> > PGP key available at: keyserver.net, pgp.mit.edu
> > 
> > ---------------------------------------------------------------------
> > 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
> 
> 

-- 
Steve Ebersole <[email protected]>
http://hibernate.org


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

    http://xircles.codehaus.org/manage_email


Reply via email to