如何使用eclox,Eclipse的doxygen插件

Question

如何在Eclipse 3.5中使用eclox？

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

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

此外,eclox网站似乎没有任何"入门"指南.

请帮忙.

Answer 1

顺便说一下,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.

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

2. 组态

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

3. 用法

   您可以使用创建向导创建新的Doxygen项目(也称为doxyfiles).转到"文件 - >新建 - >其他 - >其他 - > Doxygen配置".按next并设置文件位置和名称.然后将在指定位置创建一个空的doxyfile,向导会自动添加".Doxyfile"扩展名.

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

   一旦正确设置了所有doxyfile字段,就可以使用显示蓝色@ -sign的工具栏图标启动文档构建.如果按钮在工具栏中不可见,则需要配置当前透视图.转到"Window-> Customize perspective-> Commands",在"Available commands groups"中选中"Doxygen".另外,您可以通过单击工具栏按钮右侧的向下箭头来浏览最新的构建.

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

   构建工具栏操作根据当前活动工作台部件(编辑器或视图)以及该部件中的当前选择确定要构建的下一个doxyfile.例如,如果活动部分是doxyfile编辑器,则要构建的下一个doxyfile将是正在编辑的文件.如果活动部分是资源浏览器,并且当前选择是doxyfile,则该doxy文件将在get build旁边.在活动部件选择不对应于doxyfile的情况下,将重建最后构建的doxy文件.如果构建历史记录为空,则会要求您构建doxyfile.

HTH任何人

Answer 2

没关系,自己解决了.

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

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

不管怎么说,还是要谢谢你!