如何让 eclox 在 Eclipse 3.5 中工作?
我正在使用 Ubuntu 9.04。我从 ubuntu 存储库(版本 1.5.8)安装了 Doxygen。然后我通过更新站点在eclipse上安装了eclox。
尽管如此,我在任何菜单中都没有任何选项来启动它。
此外,eclox 网站似乎没有任何“入门”指南。
请帮忙。
如何让 eclox 在 Eclipse 3.5 中工作?
我正在使用 Ubuntu 9.04。我从 ubuntu 存储库(版本 1.5.8)安装了 Doxygen。然后我通过更新站点在eclipse上安装了eclox。
尽管如此,我在任何菜单中都没有任何选项来启动它。
此外,eclox 网站似乎没有任何“入门”指南。
请帮忙。
顺便说一句,org.gna.eclox_0.8.0.jar 里面有一个手册,奇怪的是他们没有在项目网站上发布这个!!!
这里是内容
Eclox, a Doxygen frontend plugin for Eclipse.
<http://gna.org/projects/eclox>
安装
安装插件有两种选择:使用更新站点或使用打包功能。
更新站点是安装 eclox 的更便捷方式。它位于https://anb0s.github.io/eclox。有关其他详细信息,请参阅 eclipse 的用户指南。
使用打包功能时,您必须将存档内容提取到 Eclipse 的根位置。有关其他详细信息,请参阅 eclipse 的用户指南。
配置
安装插件后,您必须确保默认 PATH 环境变量使插件可以访问 doxygen 二进制文件。如果没有,您可以更新 PATH 以包含到包含 Doxygen 二进制文件的目录,或者您可以告诉 Eclox 该二进制文件在您的系统上的位置(我认为这是更好的解决方案)。为此,请打开 eclipse 的首选项编辑对话框窗口并进入新的“Doxygen”部分。
用法
您可以使用创建向导创建新的 Doxygen 项目(也称为 doxyfiles)。转到“文件->新建->其他->其他->Doxygen配置”。按下一步并设置文件位置和名称。然后将在指定位置创建一个空的 doxyfile,向导会自动添加“.doxyfile”扩展名。
您现在应该会看到一个带有蓝色 @-sign 图标的文件。这是你的新 doxyfile。双击它将打开编辑器。您现在可以浏览和编辑设置。
正确设置所有 doxyfile 字段后,您可以使用显示蓝色 @ 符号的工具栏图标启动文档构建。如果按钮在工具栏中不可见,则需要配置您当前的透视图。转到“窗口->自定义透视图->命令”并在“可用命令组”中选中“Doxygen”。此外,您可以通过单击工具栏按钮右侧的向下箭头来浏览最新版本。
当文档构建开始时,会打开一个显示构建日志的新视图。在其工具栏中,一个名为“停止”的按钮允许您停止当前的构建过程。当前构建也出现在 Eclipse 作业进度视图中,您可以从那里控制作业。
构建工具栏操作根据当前活动的工作台部件(编辑器或视图)和该部件中的当前选择确定要构建的下一个 doxyfile。例如,如果活动部分是一个 doxyfile 编辑器,则要构建的下一个 doxyfile 将是正在编辑的那个。如果活动部分是资源浏览器并且当前选择是 doxyfile,则该 doxyfile 将是下一个构建。如果活动部件选择与 doxyfile 不对应,则将重新构建最后构建的 doxyfile。如果构建历史为空,您将被要求构建 doxyfile。
HTH 任何人
没关系,我自己解决了。
首先,您需要通过提供源路径和输出路径来创建一个 DoxyFile(这是配置文件)。
然后只有您可以通过右键单击项目并选择“生成文档”来生成文档。
不管怎么说,还是要谢谢你!
我刚刚在Mac OS X 10.7上的 Eclipse 中在 eclox 0.8.0 设置中设置Doxygen 二进制路径时遇到了问题。无法通过Eclipse-preferences -> Doxygen配置路径。
解决方案是手动编辑首选项文件
/Applications
,使用上面提到的向导。$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
对于 MacOS 用户,有一个非常简单的方法可以解决 Doxygen 版本选择的问题。提供详细信息的链接在这里:https ://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse
安装 Eclox 堵头后:
1)"转到"Eclipse --> Preferences --> Oxygen" 2)"按 Shift+CMD+G 然后添加:"/Applications/Doxygen.app/Contents/Resources/doxygen" 3) 应该显示 Doxygen 的版本
这可能会帮助您或任何尝试安装 eclox 的 Windows 用户:
安装 eclox 的教程 — 文档记录
步骤 1:进入 eclox 网站(http://home.gna.org/eclox/)并复制更新链接地址。步骤
第2步:将链接插入eclipse中的更新管理器,然后按OK。
第三步:选择Eclox项目并完成安装。
第四步:安装完成后,你应该选择一个你想要生成doxygen文件的项目。然后,为它创建一个 doxygen 项目。
第 5 步:配置选项。注意:您必须正确提供“输入目录”并选择“递归扫描”项。最后,保存配置文件。
第6步:找出“@”并选择“Choose Doxyfile ...”。
第 7 步:选择一个 doxyfile。第 8 步:等待几秒钟,将生成文档。
它来自这个链接: http ://www.slideshare.net/pickerweng/tutorial-for-installing-eclox
像克劳斯一样,我不得不深入研究首选项文件,因为 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
对此
doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programme\\doxygen\\bin
希望这可以帮助。
我找到了一个网页https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse,您可以在其中找到更多详细信息。特别是对于 Mac 用户,在使用 Eclox 编译 .doxygfile 之前,在 eclipse 中配置 doxygen 时,需要按 Shift+CMD+G 然后添加:“ /Applications/Doxygen.app/Contents/Resources/doxygen”。
eclipse 的替代方法是使用Javadoc:
项目 > 生成 Javadoc
!!!