Создание javadoc с тегами с использованием муравья - PullRequest
2 голосов
/ 30 мая 2009

Я прокомментировал свой исходный код java с помощью javadoc, используя теги вроде {@see myPackage.MyClass}.

Я должен сгенерировать javadoc с ant из терминала, но у меня есть это предупреждение:

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

В build.xml есть эта строка:

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

Кто-нибудь может мне помочь, пожалуйста?

Edit:

Я правильно его использую. Например, у меня есть

/**
 * <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;

Ответы [ 2 ]

2 голосов
/ 30 мая 2009
1 голос
/ 30 мая 2009

В Datatype.java вы используете @see в комментарии в своем коде в месте, которое Javadoc не позволяет. В частности, похоже, что у вас есть что-то вроде:

/**
  *...@see...
  */
void foo() {
}

Где это должно быть

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