2009-05-30 7 views
2

J'ai commenté mon code source java avec javadoc en utilisant des balises telles que {@voir myPackage.MyClass}.Création de javadoc avec des balises utilisant ant

je dois générer javadoc avec ant du terminal, mais j'ai eu cet avertissement:

[javadoc] src/calendar/annotation/DataType.java:11: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method. 

En build.xml est cette ligne:

<javadoc sourcepath="${sourceDir}" destdir="${docDir}" windowtitle="MyProject" /> 

Quelqu'un peut-il me aider, s'il vous plaît?

Edit:

Je l'utilise correctement. Par exemple, j'ai

/** 
* <p>Metoda provede požadovaný dotaz do databáze za použití předaných parametrů. 
* Pokud jsou parametry nedostatečně nedefinované, SQL dotaz neexistuje nebo nastane 
* problém s komunikací, dojde k vygenerování {@see calendar.exception.LoadException}. 
* Pokud žádné entity neodpovídají požadavku, dochází k vrácení prázdného seznamu. 
* V případě, že nějaké entity odpovídají požadovanému pravidlu, jsou načteny především ty, 
* které již jsou definovány v persistenční vrstvě. Pokud tam entity nejsou zavedeny, dochází 
* k jejich načtení z databáze.</p> 
* @param entityClass 
* @param query 
* @param params 
* @return 
* @throws calendar.exception.LoadException 
*/ 
<EntityClass extends AbstractEntity> Collection<EntityClass> find(Class<EntityClass> entityClass, String query, Map<String, Object> params) throws LoadException; 
+0

indice popup dans Netbeans IDE accepte mon javadoc et il montre sans problème. – Gaim

Répondre

1

En Datatype.java, vous utilisez @see dans un commentaire dans votre code dans un Javadoc lieu ne permet pas. , Il semble précisément que vous avez quelque chose comme:

/** 
    *[email protected] 
    */ 
void foo() { 
} 

où il devrait être

/** 
    * ... 
    * @see bla 
/* 
void foo() { 
    ... 
} 
+0

Je l'utilise correctement, je pense. J'ai édité ma question. – Gaim

+0

Le @see doit être à la fin du commentaire, pas au milieu –

Questions connexes