如何使用 Eclipse 的 doxygen 插件 eclox

How to use eclox, the doxygen plugin for Eclipse

提问by ruwan.jayaweera

How do I get eclox working in Eclipse 3.5?

如何让 eclox 在 Eclipse 3.5 中工作？

I'm using Ubuntu 9.04. I installed Doxygen from ubuntu repositories(version 1.5.8). Then I installed eclox on eclipse through the update site.

我正在使用 Ubuntu 9.04。我从 ubuntu 存储库（版本 1.5.8）安装了 Doxygen。然后我通过更新站点在 eclipse 上安装了 eclox。

Despite this, I don't get any option to in any menu to initiate it.

尽管如此，我在任何菜单中都没有任何选项来启动它。

Also the eclox sitedoesn't seem to have any "getting started" guide.

此外，eclox 网站似乎没有任何“入门”指南。

Please help.

请帮忙。

采纳答案by ruwan.jayaweera

Never mind, worked it out my self.

没关系，我自己解决了。

First you need to create a DoxyFile (which is the configuration file) by giving the source path and the output path.

首先，您需要通过提供源路径和输出路径来创建一个 DoxyFile（即配置文件）。

Then only you can generate the documentation by right clicking the project and selecting the "Generate Documentation".

然后只有您可以通过右键单击项目并选择“生成文档”来生成文档。

Thanks anyway!

不管怎么说，还是要谢谢你！

回答by siva.p

BTW there is a manual inside org.gna.eclox_0.8.0.jar, wierd they did not post this on the project site!!!

顺便说一句，org.gna.eclox_0.8.0.jar 里面有一个手册，奇怪的是他们没有在项目网站上发布这个！！！

Here is the content

这是内容

      Eclox, a Doxygen frontend plugin for Eclipse.
            <http://gna.org/projects/eclox>

1. INSTALLATION

   There are two options to install the plugin: using the update site or using the packaged feature.

   The update site is the more convenient way to install eclox. It is located at https://anb0s.github.io/eclox. See eclipse's user guilde for additionnal details.

   When using the packaged feature, you must extract the archive content into your eclipse's root location. For additionnal details, please refer to eclipse's user guide.

2. CONFIGURATION

   Once the plugin installed, you must ensure that the default PATH environment variable makes the doxygen binary reachable for the plugin. If not, you can update PATH to include to directory containing the Doxygen binary, or you can tell Eclox where that binary is located on your system (which is in my opinion the better solution). To do this, open eclipse's preference edition dialog window and go into the new "Doxygen" section.

3. USAGE

   You can create new Doxygen projects (also called doxyfiles) using the creation wizard. Go to "File->New->Other->Other->Doxygen Configuration". Press next and set both file location and name. Then a empty doxyfile will be created at the specified location, the wizard automatically adds the ".Doxyfile" extension.

   You should now see a file with a blue @-sign icon. This is your new doxyfile. Double-clicking on it will open the editor. You can now browse and edit the settings.

   Once your have properly set all doxyfile fields, you can launch a documentation build using the toolbar icon showing a blue @-sign. In the case the button is not visible in the toolbar, your current perspective needs to get configured. Go to "Window->Customize perspective->Commands" and in "Available command groups" check "Doxygen". Additionnaly, you can browse the laetest builds by clicking the down arrow right to the toolbar button.

   When the documentation build starts, a new view showing the build log opens. In its toolbar, a button named "Stop" allows you to halt the current build process. The current build also appears in the Eclipse job progress view and you can control the job from there.

   The build toolbar action determine the next doxyfile to build depending on the current active workbench part (editor or view) and the current selection in that part. For example, if the active part is a doxyfile editor, the next doxyfile to build will be the one being edited. If the active part is the resource explorer and the current selection is a doxyfile, that doxyfile will be next to get build. In the case the active part selection doesn't correspond to a doxyfile, the last built doxyfile will be rebuiled. And if the build history is empty, you will be asked for the doxyfile to build.

1. 安装

   安装插件有两种选择：使用更新站点或使用打包功能。

   更新站点是安装 eclox 的更方便的方式。它位于https://anb0s.github.io/eclox。有关其他详细信息，请参阅 eclipse 的用户指南。

   使用打包功能时，您必须将存档内容提取到 eclipse 的根位置。有关其他详细信息，请参阅 eclipse 的用户指南。

2. 配置

   安装插件后，您必须确保默认的 PATH 环境变量使插件可以访问 doxygen 二进制文件。如果没有，您可以更新 PATH 以包含到包含 Doxygen 二进制文件的目录，或者您可以告诉 Eclox 该二进制文件在您的系统上的位置（我认为这是更好的解决方案）。为此，请打开 eclipse 的首选项编辑对话框窗口并进入新的“Doxygen”部分。

3. 用法

   您可以使用创建向导创建新的 Doxygen 项目（也称为 doxyfiles）。转到“文件->新建->其他->其他-> Doxygen配置”。按下一步并设置文件位置和名称。然后会在指定位置创建一个空的doxyfile，向导会自动添加“.Doxyfile”扩展名。

   您现在应该会看到一个带有蓝色 @-sign 图标的文件。这是您的新 doxyfile。双击它会打开编辑器。您现在可以浏览和编辑设置。

   正确设置所有 doxyfile 字段后，您可以使用显示蓝色 @ 符号的工具栏图标启动文档构建。如果该按钮在工具栏中不可见，则需要配置您当前的透视图。转到“窗口->自定义透视图->命令”并在“可用命令组”中选中“Doxygen”。此外，您可以通过单击工具栏按钮右侧的向下箭头来浏览最新版本。

   当文档构建开始时，会打开一个显示构建日志的新视图。在其工具栏中，一个名为“停止”的按钮允许您停止当前的构建过程。当前构建也出现在 Eclipse 作业进度视图中，您可以从那里控制作业。

   构建工具栏操作根据当前活动的工作台部件（编辑器或视图）和该部件中的当前选择确定要构建的下一个 doxyfile。例如，如果活动部件是一个 doxyfile 编辑器，下一个要构建的 doxyfile 将是正在编辑的那个。如果活动部分是资源浏览器并且当前选择是一个 doxyfile，那么该 doxyfile 将是下一个要构建的。如果活动部件选择与 doxyfile 不对应，则将重新构建最后构建的 doxyfile。如果构建历史为空，您将被要求构建 doxyfile。

HTH Anybody

任何人

回答by klaus

I just faced a problem setting the Doxygen binary pathin eclox 0.8.0 settings in Eclipse on Mac OS X10.7. There is no way to configure the path via Eclipse-preferences->Doxygen.

我刚刚在Mac OS X10.7上的 Eclipse 中的 eclox 0.8.0 设置中设置Doxygen 二进制路径时遇到问题。无法通过Eclipse-preferences-> Doxygen配置路径。

The solution is to edit the preferences file manually

解决方法是手动编辑首选项文件

1. add a (fake) location, let's say /Applications, using the wizard mentioned above.
2. close Eclipse
3. edit this file: $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs: Replace the value for doxygen.default(currently eclox.core.doxygen.CustomDoxygen /Applications\n) with eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
4. restart Eclipse

1. 添加一个（假）位置，比如说/Applications，使用上面提到的向导。
2. 关闭日食
3. 编辑此文件：： $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs将doxygen.default（当前eclox.core.doxygen.CustomDoxygen /Applications\n）的值替换为eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
4. 重启 Eclipse

回答by MickaelT

For MacOS user there is a very easy way to get around via the issue of the Doxygen version selection. The link that provides details is here:https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

对于 MacOS 用户，有一种非常简单的方法可以解决 Doxygen 版本选择问题。提供详细信息的链接在这里：https: //github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

After installing the Eclox plugging:

安装 Eclox 堵头后：

1)"go to "Eclipse --> Preferences --> Oxygen" 2)"Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen" 3) Doxygen's version should be displayed

1)"转到"Eclipse --> 首选项 --> Oxygen" 2)"按 Shift+CMD+G 然后添加："/Applications/Doxygen.app/Contents/Resources/doxygen" 3) 应显示 Doxygen 的版本

回答by j2emanue

this might help you or any windows user trying to install eclox:

这可能会帮助您或任何尝试安装 eclox 的 Windows 用户：

Tutorial for Installing eclox — Document Transcript

安装 eclox 的教程 — 文档记录

Step 1: go to eclox website (http://home.gna.org/eclox/) and to copy the update link address.Step

第一步：到eclox网站（http://home.gna.org/eclox/）复制更新链接地址。

step 2: Insert the link into the update manager in eclipse and press OK.

第二步：在eclipse的更新管理器中插入链接，点击确定。

Step 3: Select the Eclox item and to complete the installation.

第三步：选择Eclox项并完成安装。

Step 4: When the installation has done, you should select a project that you want to generate thedoxygen documents. Then, create a doxygen project for it.

步骤4：安装完成后，您应该选择要生成doxygen 文档的项目。然后，为其创建一个 doxygen 项目。

Step 5: config the options. Note: You have to provide the “Input directories” correctly and to select the “Scan recursively”item. Finally, save the configuration file.

第五步：配置选项。注意：您必须正确提供“输入目录”并选择“递归扫描”项。最后，保存配置文件。

Step 6: find out the “@” and to choice “Choose Doxyfile...”.

第六步：找出“@”并选择“Choose Doxyfile...”。

Step 7: select a doxyfile.Step 8: wait for few seconds and the doucments will be generated.

第七步：选择一个doxyfile。第八步：等待几秒钟，文件就会生成。

its from this link: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox

它来自这个链接：http: //www.slideshare.net/pickerweng/tutorial-for-installing-eclox

回答by goeck

Like claus I had to dig into the preferences file maually, because eclox 0.8.0 would just not take a good path from Eclipse Preferences file chooser. So, edit this file: $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefsand alter the given path (in my case I had to change from

像克劳斯一样，我不得不深入研究首选项文件，因为 eclox 0.8.0 不会从 Eclipse 首选项文件选择器中获得好的路径。因此，编辑此文件：$WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs并更改给定的路径（在我的情况下，我必须从

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\Programm Files\doxygen\bin

to this

对此

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\Programme\doxygen\bin

Hope this helps.

希望这可以帮助。

回答by Yong Yang

I find a webpage https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipsewhere you can find more details. Especially, for Mac users, you need to Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen"when you configure the doxygen in eclipse before compiling .doxygfile by using Eclox.

我找到了一个网页https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse，您可以在其中找到更多详细信息。特别是Mac用户，在eclipse中配置doxygen时，需要先按Shift+CMD+G再添加："/Applications/Doxygen.app/Contents/Resources/doxygen"，然后再用Eclox编译.doxygfile。

回答by adrian filipescu

Alternative from eclipse is to use Javadoc:

eclipse 的替代方法是使用Javadoc：

1. From menu (...Search Project Run...)

1. 从菜单（...搜索项目运行...）

Project > Generate Javadoc

项目 > 生成 Javadoc

1. You should be in Java project and add comments with tags.

2. 您应该在 Java 项目中并添加带有标签的注释。

!!!

！！！