Eclox

Original link:current page

Description:

The way to install doxygen in eclipse and to configure.

Install the eclox with Eclipse Marketplace, find “eclox” or “doxygen” directly and install it.

After finished, the icon would be added to the eclipse toolbar

For more Information please check eclox

The configureation is a little more complex than the installation.

First, add a doxyfile to your project

  • right click your project, [new][other], choose the wizard [other][Doxyfile]
  • click [Next], choose your project, change the doxyfilie name if need or just keep the default, and [Finish].
  • open the doxyfile just created

You will get the options as follows:

Then

  • Input the Project name and the directories(input and output).
  • Check the “Scan recursively” box.
  • switch to the [Advanced] options by click the key at the buttom of editor
  • change the sort type to “By Group”

If you had tried the doxywizard on windows, you may fimiliar with the options.\
The options have been discribed in great detail on Doxygen + Graphviz + Htmlhelp, 成为文档好手

dot tools

There may be some problem with the dot tools settings if you got the error:

...
error: Problems running dot: exit code=-1, command='dot', arguments='
...

Please check the dot command by

  • 1. open a cmd dialog and check “dot -V”
  • 2. the result should be the message as follows, if not, go step 3 and 4
  • 3. confirm that the application graphviz had been already installed currectly , refer to doxywizard on windows
  • 4. the path of “dot.exe” had been added to the “Path” of system environment variable, refer to add to the path on windows 10
> dot -V
dot - graphviz version 2.38.0 (20140413.2041)

After configuring, the eclox is ready to run.
Click drop-down arrow of the button and choose the doxyfile you added, the tool would run and output the message to the output directory according to configuration.

If option [Generate HTML] is set, you would get the html data in <output directory>/html, open the “index.html” in it with your browers.

Enjoy it.

Messy code with Chinese

If your code mode is gbk, you need to change the [output language] to [Chinese] (default English)

  • Last modified: 2019/03/21 10:08