I have commented my java source code with javadoc using tags like {@see myPackage.MyClass}.
我使用像{@see myPackage.MyClass}这样的标签用javadoc评论了我的java源代码。
I have to generate javadoc with ant from terminal but I have got this warning:
我必须从终端生成带有ant的javadoc,但是我收到了这个警告:
[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.
In build.xml is this line:
在build.xml中是这一行:
<javadoc sourcepath="${sourceDir}" destdir="${docDir}" windowtitle="MyProject" />
Can anybody help me, please?
请问有人帮帮我吗?
Edit:
I am using it correctly. For example I have
我正确使用它。比如我有
/**
* <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 个解决方案
#1
Shouldn't that be @link instead of @see?
不应该是@link而不是@see吗?
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#%7B%40link%7D
#2
In Datatype.java, you are using @see in a comment in your code in a place Javadoc does not allow. Specifically, it looks like you have something like:
在Datatype.java中,您在代码中使用@see在Javadoc不允许的地方使用。具体来说,看起来你有类似的东西:
/**
*...@see...
*/
void foo() {
}
Where it should be
它应该在哪里
/**
* ...
* @see bla
/*
void foo() {
...
}
#1
Shouldn't that be @link instead of @see?
不应该是@link而不是@see吗?
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#%7B%40link%7D
#2
In Datatype.java, you are using @see in a comment in your code in a place Javadoc does not allow. Specifically, it looks like you have something like:
在Datatype.java中,您在代码中使用@see在Javadoc不允许的地方使用。具体来说,看起来你有类似的东西:
/**
*...@see...
*/
void foo() {
}
Where it should be
它应该在哪里
/**
* ...
* @see bla
/*
void foo() {
...
}