简体   繁体   English

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

[英]How to use doxygen and JavaDoc for the same Java project

I would like to create two versions, one with doxygen and one with JavaDoc. 我想创建两个版本,一个使用doxygen,另一个使用JavaDoc。 However Javadoc does not have an option to exclude specific text parts from the documentation. 但是,Javadoc没有选择从文档中排除特定文本部分的选项。 So tags which are specific to doxygen are included, like \\mainpage or \\page 因此,包含了特定于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的一些其他文档,发行说明等放入源文件夹中的doxygen.html文件中(只是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?

If such doxygen tags are limited than let such tags getting generated in Java docs. 如果此类doxygen标签受限制,则不要在Java文档中生成此类标签。 Use some text processor to find and replace the tags, such text processor can be already available in unix env. 使用一些文本处理器来查找和替换标签,这样的文本处理器在unix env中已经可用。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM