Never mind, worked it out my self.
First you need to create a DoxyFile (which is the configuration file) by giving the source path and the output path.
Then only you can generate the documentation by right clicking the project and selecting the "Generate Documentation".
this might help you or any windows user trying to install eclox:
Tutorial for Installing eclox — Document Transcript
Step 1: go to eclox website (http://home.gna.org/eclox/) and to copy the update link address.Step
step 2: Insert the link into the update manager in eclipse and press OK.
Step 3: Select the Eclox item and to complete the installation.
Step 4: When the installation has done, you should select a project that you want to generate thedoxygen documents. Then, create a doxygen project for it.
Step 5: config the options. Note: You have to provide the “Input directories” correctly and to select the “Scan recursively”item. Finally, save the configuration file.
Step 6: find out the “@” and to choice “Choose Doxyfile...”.
Step 7: select a doxyfile.Step 8: wait for few seconds and the doucments will be generated.
its from this link: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox
Like claus I had to dig into the preferences file maually, because eclox 0.8.0 would just not take a good path from Eclipse Preferences file chooser.
So, edit this file:
$WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs and alter the given path (in my case I had to change from
doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programm Files\\doxygen\\bin
Hope this helps.
I find a webpage https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse where you can find more details. Especially, for Mac users, you need to Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen" when you configure the doxygen in eclipse before compiling .doxygfile by using Eclox.
Alternative from eclipse is to use Javadoc:
- From menu (...Search Project Run...)
Project > Generate Javadoc
- You should be in Java project and add comments with tags.
For MacOS user there is a very easy way to get around via the issue of the Doxygen version selection. The link that provides details is here:https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse
After installing the Eclox plugging:
1)"go to "Eclipse --> Preferences --> Oxygen" 2)"Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen" 3) Doxygen's version should be displayed
I just faced a problem setting the Doxygen binary path in eclox 0.8.0 settings in Eclipse on Mac OS X 10.7. There is no way to configure the path via Eclipse-preferences->Doxygen.
The solution is to edit the preferences file manually
- add a (fake) location, let's say
/Applications, using the wizard mentioned above.
- close Eclipse
- edit this file:
$WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs: Replace the value for
eclox.core.doxygen.CustomDoxygen /Applications\n) with
- restart Eclipse
BTW there is a manual inside org.gna.eclox_0.8.0.jar, wierd they did not post this on the project site!!!
Here is the content
Eclox, a Doxygen frontend plugin for Eclipse. <http://gna.org/projects/eclox>
There are two options to install the plugin: using the update site or using the packaged feature.
The update site is the more convenient way to install eclox. It is located at https://anb0s.github.io/eclox. See eclipse's user guilde for additionnal details.
When using the packaged feature, you must extract the archive content into your eclipse's root location. For additionnal details, please refer to eclipse's user guide.
Once the plugin installed, you must ensure that the default PATH environment variable makes the doxygen binary reachable for the plugin. If not, you can update PATH to include to directory containing the Doxygen binary, or you can tell Eclox where that binary is located on your system (which is in my opinion the better solution). To do this, open eclipse's preference edition dialog window and go into the new "Doxygen" section.
You can create new Doxygen projects (also called doxyfiles) using the creation wizard. Go to "File->New->Other->Other->Doxygen Configuration". Press next and set both file location and name. Then a empty doxyfile will be created at the specified location, the wizard automatically adds the ".Doxyfile" extension.
You should now see a file with a blue @-sign 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 blue @-sign. 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 laetest 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.
- How to use eclox, the doxygen plugin for Eclipse
- How to build an Eclipse plugin with Maven/Tycho for use in the "Install New Software" dialog
- How to use the Edit button in eclipse for a plugin eclipse
- How do I use the Eclipse debugger in an AsyncTask when developing for Android?
- How to get rid of the warning: Use '$' instead of '.' for inner classes in Eclipse
- How to use the eclipse launch configuration string prompt for two values?
- How to install the Eclipse plugin for Symfony 2?
- How can two eclipse plugin use the same preferences store?
- How to use external libraries in the Eclipse (Java) and Processing for Arduino
- How to use Eclipse for capturing the structure of a java software
- How to install groovy plugin for eclipse without using the update site link
- How to use the JFace FileDialog from within an Eclipse plugin in a modeless way?
- How to package a library as an eclipse plugin for use by another plugin
- How do I change the syntax highlighting of feature files for Cucumber JVM Eclipse Plugin
- How to create a jar file for the eclipse plugin project that should be able to download and run without eclipse software?
- How to setup the project & workspace for building Androlate; an Eclipse Plugin
- How to change the font for Eclipse Twist scenario editor (Eclipse Plugin - ThoughtWorks Studios)
- Why does the SonarQube plugin for Eclipse use the "project name" instead of the "artifactID" to associate Maven projects with a SonarQube server?
- How do I make use of the apple extensions for Java using Eclipse
- Use a class field in the 'plugin.xml' for an eclipse plugin
- How do I use the Eclipse External null Annotations (EEAs) for the JDK/JRE and 3rd-party libraries inside Eclipse?
- How do you add the Python.h libraries to eclipse for use in a C++ program?
- How to use Cloud Tools for Eclipse plugin to create microservices in Google App Engine?
- How to use the same SDK for Android Studio and Eclipse (MAC version)
- How To Use A Relative Path For The Eclipse Workspace
- Eclipse CDT - how to use an argfile for the linker for a too long command line
- How to use (or integrate) maven pom.xml with an Eclipse Plugin project for dependency management
- How to use eclipse plugin to create a new wizard for creating a project?
- How to make the VJET plugin fully working in eclipse for my node.js project
- How do I make the Eclipse Checkstyle plugin and the Maven Checkstyle plugin use the same rules?
More Query from same tag
- An internal error occurred during: "Launching counter" java.lang.NullPointerException
- Fire eclipse event programmatically C#
- Eclipse subversion chan't checkout existing project
- which is the best way to externalize a database configuration on a desktop app?
- java.lang.NullPointerException: error - app is not opening
- Commit of eclipse subversion doesn't work
- Project build error with Maven under Eclipse : must specify an absolute path
- Find classes which are used during compilation in eclipse
- App keep crashing after trying to create new activity?
- Java Desktop application framework
- Disable automatic header file renaming in Eclipse CDT
- Can't use css in codename one
- Error: Project 'app' not found in root project 'projectName'
- What does CTRL-G do in Eclipse?
- Error: Could not find or load main class $MAVEN_HOME
- Java RMI: exception: java.security.AccessControlException: access denied ("java.net.SocketPermission" "127.0.0.1:1099" "connect,resolve")
- In eclipse'view, how to create a shortcut
- Running maven-clean-plugin during pre-integration-test without cleaning default target directory
- How can I programmatically set a source folder in Eclipse?
- Eclipse not showing my android perspective
- Retrieve the list of project active editors
- Eclipse (on mac) bug: inserting html between 2php tags impossible
- My JRadioButtons arent interacting with my JButton
- GIS / Map display component
- Is there any way to execute many maven build one after the other in Eclipse?
- Eclipse C++ project - Running external make file with different targets
- Android google maps v2 not loading with signed release key
- Eclipse returns error message "Java was started but returned exit code = 1"
- Can Titanium Studio coexist with an existing Eclipse install?
- Java configure build path