如何使用eclox,Eclipse的doxygen插件

时间:2010-01-21 10:55:45

标签: eclipse eclipse-plugin doxygen

如何让eclox在Eclipse 3.5中运行?

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

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

此外,eclox site似乎没有任何“入门”指南。

请帮忙。

8 个答案:

答案 0 :(得分:29)

顺便说一句,org.gna.eclox_0.8.0.jar里面有一本手册,很奇怪他们没有在项目网站上发帖!!!

这是内容

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

    安装插件有两个选项:使用更新站点或 使用打包的功能。

    更新站点是安装eclox的更方便的方法。它是 位于https://anb0s.github.io/eclox。请参阅eclipse的用户 guilde for additionalnal details。

    使用打包功能时,必须将存档内容解压缩到 你的日食的根位置。有关其他详细信息,请参阅 eclipse的用户指南。

  2. CONFIGURATION

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

  3. USAGE

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

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

    一旦你正确设置了所有doxyfile字段,就可以启动一个 使用显示蓝色@ -sign的工具栏图标构建文档。在 如果按钮在工具栏中不可见,则显示当前视角 需要配置。转到“Window-&gt; Customize perspective-&gt; Commands”和 在“可用命令组”中,选中“Doxygen”。另外,你可以浏览 单击工具栏按钮右侧的向下箭头即可构建最新版本。

    文档构建开始时,将打开一个显示构建日志的新视图。 在其工具栏中,名为“Stop”的按钮允许您暂停当前构建 处理。当前版本也出现在Eclipse作业进度视图中 你可以从那里控制工作。

    构建工具栏操作确定要构建的下一个doxyfile,具体取决于 当前活动工作台部件(编辑器或视图)和当前选择 在那一部分。例如,如果活动部分是doxyfile编辑器,则下一个 要构建的doxyfile将是正在编辑的那个。如果活动部分是 资源浏览器和当前选择是doxyfile,doxyfile将 紧接着建立。在活动部件选择不对应的情况下 到doxyfile,最后构建的doxyfile将被重建。如果构建 如果历史记录为空,则会要求您创建doxyfile。

  4. HTH Anybody

答案 1 :(得分:16)

没关系,自己解决了。

首先,您需要通过提供源路径和输出路径来创建DoxyFile(这是配置文件)。

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

非常感谢!

答案 2 :(得分:3)

我刚刚在 Mac OS X 10.7的Eclipse中的eclox 0.8.0设置中设置 Doxygen二进制路径时遇到了问题。 无法通过 Eclipse-preferences - &gt; Doxygen 配置路径。

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

  1. 使用上面提到的向导添加(假)位置,假设为/Applications
  2. 关闭Eclipse
  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

答案 3 :(得分:1)

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

安装Eclox插件后:

1)&#34;转到&#34; Eclipse - &gt;偏好 - &gt;氧&#34; 2)&#34;按Shift + CMD + G然后添加:&#34; /Applications/Doxygen.app/Contents/Resources/doxygen" 3)应显示Doxygen的版本

答案 4 :(得分:0)

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

安装eclox的教程 - 文档脚本

第1步:访问eclox网站(http://home.gna.org/eclox/)并复制更新链接地址。步骤

步骤2:在eclipse中将链接插入更新管理器,然后按OK。

步骤3:选择Eclox项目并完成安装。

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

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

步骤6:找出“@”并选择“选择Doxyfile ...”。

步骤7:选择doxyfile.Step 8:等待几秒钟,然后生成doucments。

来自此链接:http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox

答案 5 :(得分:0)

和claus一样,我必须手动挖掘首选项文件,因为eclox 0.8.0不会从Eclipse Preferences文件选择器中找到一条好路径。 因此,编辑此文件:$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

希望这有帮助。

答案 6 :(得分:0)

我找到了一个网页https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse,您可以在其中找到更多详细信息。特别是,对于Mac用户,你需要按Shift + CMD + G然后添加:“/ Applications / Doxygen.app/Contents/Resources/doxygen”在eclipse中配置doxygen之前编译.doxygfile通过使用Eclox。

答案 7 :(得分:0)

eclipse的替代方法是使用 Javadoc

  1. 从菜单(...搜索项目运行...)
  2. 项目&gt;生成Javadoc

    1. 您应该使用Java项目并使用标记添加注释。
    2. !!!