如何在同一个Java项目中使用doxygen和JavaDoc

时间:2022-11-19 15:16:35

I would like to create two versions, one with doxygen and one with JavaDoc. However Javadoc does not have an option to exclude specific text parts from the documentation. So tags which are specific to doxygen are included, like \mainpage or \page

我想创建两个版本,一个使用doxygen,另一个使用JavaDoc。但是,Javadoc没有从文档中排除特定文本部分的选项。因此包括特定于doxygen的标签,如\ mainpage或\ page

A workaround could be to use package-info.java for the core Javadoc of the API, and to put some additional documentation, release notes etc. for Doxygen in a file doxygen.html in the source folder (just where package.html was before JDK 5).

解决方法可能是使用package-info.java作为API的核心Javadoc,并在源文件夹中的doxygen.html文件中放置一些额外的文档,发行说明等Doxygen(就在package.html之前的位置) JDK 5)。

Or are there other options, which could even help to put the parts with some doxygen specific tags back to the package-info.html?

或者是否有其他选项,甚至可以帮助将带有一些doxygen特定标签的部件放回package-info.html?

1 个解决方案

#1


0  

If such doxygen tags are limited than let such tags getting generated in Java docs. Use some text processor to find and replace the tags, such text processor can be already available in unix env.

如果这样的doxygen标签是有限的,那么让这些标签在Java文档中生成。使用一些文本处理器来查找和替换标签,这样的文本处理器可以在unix环境中使用。

#1


0  

If such doxygen tags are limited than let such tags getting generated in Java docs. Use some text processor to find and replace the tags, such text processor can be already available in unix env.

如果这样的doxygen标签是有限的,那么让这些标签在Java文档中生成。使用一些文本处理器来查找和替换标签,这样的文本处理器可以在unix环境中使用。