Eclox Doxygen frontend

Use the Doxygen code documentation framework in Eclipse.

Download Eclox Doxygen frontend 0.6.5 for EasyEclipse 1.3:

(6.6MB)  (6.8MB)  (6.5MB)

Eclox is a Doxygen frontend plugin for Eclipse. It provides an integration of the code documentation process into eclipse: Features include graphical edition of doxyfile settings, integrated doxygen invocation and doxygen outputs logging.

Comments are currently disabled on this page.

Installing this plugin

This plugin is in the EasyEclipse for C and C++ distribution.

You can also install it on any EasyEclipse distribution, because it has no dependencies.

Getting started

Help is available for this plugin, in the Help > Help Contents menu in EasyEclipse.

The Doxygen executable is included for Linux and Windows, but you will need to configure the plugin to use it. Open the "Preferences" dialog, and under "Doxygen", make sure that one of the bundled Doxygen installations is checked. On Mac, you should download and install Doxygen as a universal binary distribution on the Doxygen site. Then, in Eclipse, in the "Preferences" dialogs, under "Doxygen", add the path /Applications/Doxygen.app/Contents/Resources.

The help includes a very complete "Getting Started" section.

Tests

(Notes that tests are only displayed if the page is served statically)

• Failing:

  This test is for MacOS
  - download doxygen as a .dmg from http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc and install it
  - create a C++ project with some source
  - create new Doxygen projects (also called doxyfiles) "File > New > Other, Other > Doxygen Configuration", next and set both file location and name. a empty doxyfile will be created at the specified location, the wizard automatically adds the ".Doxyfile" extension.
  (not finished)
          You should now see a file with a yellow question mark 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 yellow question mark. 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 latest 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.
      

Useful links

• Eclox Doxygen frontend home

Changelog

Changes in EasyEclipse 1.3.1:

• Upgraded to Eclox Doxygen frontend 0.6.5.

Changes in EasyEclipse 1.3.0:

• Initial release (with Eclox Doxygen frontend 0.6.3).

Credits and License

Credits: Guillaume Brocker

Copyright (C) 2003-2007 Guillaume Brocker

This plugin is licensed under the GNU General Public License 2.0 license.