Skip to Main Content

Java APIs

Announcement

For appeals, questions and feedback about Oracle Forums, please email oracle-forums-moderators_us@oracle.com. Technical questions should be asked in the appropriate category. Thank you!

How to ignore xdoclet tags when generating javadoc?

843810Apr 7 2004 — edited Apr 20 2004
I'm using xdoclet tags to generate my hibernate mappings. When I generate my javadoc, it prints warnings about unknown tags.

I adapted my ant build script (see below) to ignore all hibernate related tags. But it seems that the javadoc tool cannot handle hyphens (-) in tag names.
For example: A class using the @hibernate.many-to-one tag gives the following warning:
     [javadoc] D:\eclipse\workspace\peter.de.bruycker\SupportingClasses\src\com\swp\supporting\entity\unit\UnitFactor.java:75: warning - @hibernate.many-to-one is an unknown tag.
...
     [javadoc] Note: Custom tags that were not seen:  @hibernate.joined, @hibernate.many, @hibernate.collection, @hibernate.index, @hibernate.one
Any ideas?
    <target name="make-docs" description="Generates JavaDoc.">
        <mkdir dir="${javadoc.source}"/>
        <javadoc sourcepath="${javadoc.source}" 
				 destdir="${javadoc.dest}" 
				 packagenames="${javadoc.packages}" 
				 classpathref="project.class.path" 
				 private="true"   
				 author="true">
			<tag name="hibernate.class" description="hibernate.class" enabled="false"/>
			<tag name="hibernate.subclass" description="hibernate.subclass" enabled="false"/>
			<tag name="hibernate.discriminator" description="hibernate.discriminator" enabled="false"/>
			<tag name="hibernate.joined-subclass" description="hibernate.joined-subclass" enabled="false"/>
			<tag name="hibernate.joined-subclass-key" description="hibernate.joined-subclass-key" enabled="false"/>
			<tag name="hibernate.cache" description="hibernate.cache" enabled="false"/>
			<tag name="hibernate.jcs-cache" description="hibernate.jcs-cache" enabled="false"/>
			<tag name="hibernate.query" description="hibernate.query" enabled="false"/>
			<tag name="hibernate.id" description="hibernate.id" enabled="false"/>
			<tag name="hibernate.generator-param" description="hibernate.generator-param" enabled="false"/>
			<tag name="hibernate.property" description="hibernate.property" enabled="false"/>
			<tag name="hibernate.component" description="hibernate.component" enabled="false"/>
			<tag name="hibernate.version" description="hibernate.version" enabled="false"/>
			<tag name="hibernate.timestamp" description="hibernate.timestamp" enabled="false"/>
			<tag name="hibernate.many-to-one" description="hibernate.many-to-one" enabled="false"/>
			<tag name="hibernate.one-to-one" description="hibernate.one-to-one" enabled="false"/>
			<tag name="hibernate.column" description="hibernate.column" enabled="false"/>
			<tag name="hibernate.set" description="hibernate.set" enabled="false"/>
			<tag name="hibernate.bag" description="hibernate.bag" enabled="false"/>
			<tag name="hibernate.list" description="hibernate.list" enabled="false"/>
			<tag name="hibernate.map" description="hibernate.map" enabled="false"/>
			<tag name="hibernate.array" description="hibernate.array" enabled="false"/>
			<tag name="hibernate.primitive-array" description="hibernate.primitive-array" enabled="false"/>
			<tag name="hibernate.collection-key" description="hibernate.collection-key" enabled="false"/>
			<tag name="hibernate.collection-index" description="hibernate.collection-index" enabled="false"/>
			<tag name="hibernate.index-many-to-many" description="hibernate.index-many-to-many" enabled="false"/>
			<tag name="hibernate.collection-element" description="hibernate.collection-element" enabled="false"/>
			<tag name="hibernate.collection-composite-element" description="hibernate.collection-composite-element" enabled="false"/>
			<tag name="hibernate.collection-many-to-many" description="hibernate.collection-many-to-many" enabled="false"/>
			<tag name="hibernate.collection-one-to-many" description="hibernate.collection-one-to-many" enabled="false"/>
			<tag name="hibernate.collection-cache" description="hibernate.collection-cache" enabled="false"/>
			<tag name="hibernate.collection-jcs-cache" description="hibernate.collection-jcs-cache" enabled="false"/>
        </javadoc>
    </target>
Comments
Locked Post
New comments cannot be posted to this locked post.
Post Details
Locked on May 18 2004
Added on Apr 7 2004
1 comment
543 views