在Eclipse中为@RequestBody和@PathVariable生成Java文档时收到警告

时间:2014-11-23 13:52:37

标签: eclipse spring rest javadoc

我正在使用eclipse为我的项目生成java doc。一切正常但我在javadoc评论中使用@RequestBody和@PathVariable时会收到警告。如何删除该警告以生成文档?以下是我的javadoc的片段:

   /**
     * Request POST call to create category
     * @RequestBody Category category
     * @return category id and title as JSON string
     */

生成以下警告:

警告 - @RequestBody是一个未知标记。

可以得到这样的警告,还是我需要做些什么来消除这个?

2 个答案:

答案 0 :(得分:2)

您收到警告,因为这是无效的javadoc。有效的javadoc将是

/**
 * Request POST call to create category
 * @param category the category to create
 * @return category id and title as JSON string
 */

@RequestBody是一个Java注释。它与javadoc无关。

答案 1 :(得分:1)

因为@RequestBody和@PathVariable不是javadoc标签。

请参阅javadoc标记的list