All Projects → anb0s → eclox

anb0s / eclox

Licence: EPL-2.0 license
Eclox is a simple doxygen frontend plug-in for eclipse. It aims to provide a slim and sleek integration of the code documentation process into Eclipse.

Programming Languages

java
68154 projects - #9 most used programming language

Projects that are alternatives of or similar to eclox

uml2solidity
A uml profile and a set of acceleo code generators to model smart contracts in uml and generate solidity code.
Stars: ✭ 35 (+9.38%)
Mutual labels:  eclipse, eclipse-plugin
Google Cloud Eclipse
Google Cloud Platform plugin for Eclipse
Stars: ✭ 75 (+134.38%)
Mutual labels:  eclipse, eclipse-plugin
Groovy Eclipse
Eclipse Groovy Development Tools
Stars: ✭ 567 (+1671.88%)
Mutual labels:  eclipse, eclipse-plugin
eclipse
Eclipse For Bazel (deprecated, see https://github.com/salesforce/bazel-eclipse instead)
Stars: ✭ 31 (-3.12%)
Mutual labels:  eclipse, eclipse-plugin
J2c
Java to C++ translator
Stars: ✭ 189 (+490.63%)
Mutual labels:  eclipse, eclipse-plugin
Openexplorer
Open Explorer plugin for Eclipse
Stars: ✭ 404 (+1162.5%)
Mutual labels:  eclipse, eclipse-plugin
Ansi Econsole
Eclipse plugin that understands ANSI escape sequences to color the Eclipse console output.
Stars: ✭ 72 (+125%)
Mutual labels:  eclipse, eclipse-plugin
SubmiBot
Plugin do Eclipse para automatização do processo de submissão de tarefas na disciplina de LP2 - Computação@UFCG
Stars: ✭ 16 (-50%)
Mutual labels:  eclipse, eclipse-plugin
Autorefactor
Eclipse plugin to automatically refactor Java code bases
Stars: ✭ 168 (+425%)
Mutual labels:  eclipse, eclipse-plugin
Eclipse Instasearch
Eclipse plug-in for fast code search
Stars: ✭ 165 (+415.63%)
Mutual labels:  eclipse, eclipse-plugin
Angularjs Eclipse
AngularJS Eclipse Plugin
Stars: ✭ 336 (+950%)
Mutual labels:  eclipse, eclipse-plugin
eclipse-pmd
eclipse-pmd has been moved to
Stars: ✭ 20 (-37.5%)
Mutual labels:  eclipse, eclipse-plugin
Pydev
Python IDE for Eclipse
Stars: ✭ 306 (+856.25%)
Mutual labels:  eclipse, eclipse-plugin
Bnd
Bnd/Bndtools. Tooling to build OSGi bundles including Eclipse, Maven, and Gradle plugins.
Stars: ✭ 446 (+1293.75%)
Mutual labels:  eclipse, eclipse-plugin
chromium-swt
Create and render web UIs in Java SWT and Eclipse RCP applications.
Stars: ✭ 121 (+278.13%)
Mutual labels:  eclipse, eclipse-plugin
Amateras Html Editor
Eclipse plugin for HTML/JSP/XML/JavaScript Editing
Stars: ✭ 34 (+6.25%)
Mutual labels:  eclipse, eclipse-plugin
ruledesigner
Rule Designer is the Eclipse-based development environment for ODM developers.
Stars: ✭ 14 (-56.25%)
Mutual labels:  eclipse, eclipse-plugin
scalor-maven-plugin
Build integrator for Java, Scala, Scala.macro, Scala.js, Scala.native, Eclipse and Maven.
Stars: ✭ 47 (+46.88%)
Mutual labels:  eclipse, eclipse-plugin
So Eclipse Plugin
Eclipse plugin that enables you to get answers from Stack Overflow directly to your IDE 🔥
Stars: ✭ 84 (+162.5%)
Mutual labels:  eclipse, eclipse-plugin
Amateras Modeler
UML and ER-diagram editor for Eclipse
Stars: ✭ 190 (+493.75%)
Mutual labels:  eclipse, eclipse-plugin

eclox Version Issues Build Status License

Eclox is a simple Doxygen frontend plug-in for Eclipse. It aims to provide a slim and sleek integration of the code documentation process into Eclipse.

eclox_arch

Features Overview:

  • Graphical edition of Doxygen settings (Doxyfile)
  • Integrated Doxygen invocation
  • Doxygen outputs logging
  • Optional packaged Doxygen binaries (for Windows and Linux)

Not supported:

  • Content assist for Doxygen comments --> Eclipse C/C++ (CDT) supports it

Prerequisites:

  • Java SE 1.8 or newer
  • Doxygen executable in PATH or bundled with Eclox or custom location (see Installation and Configuration below)

Installation:

From Eclipse Markeplace:

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

http://marketplace.eclipse.org/content/eclox

OR

Using the update site located at: http://anb0s.github.io/eclox

Select Eclox Plugin and optional bundled Doxygen executable:

Eclox install

OR

You can download the update sites for offline install --> go to: https://github.com/anb0s/eclox/releases and download the org.gna.eclox.site-0.12.1-SNAPSHOT.zip and optional bundled doxygen executable org.gna.eclox.doxygen.site-X.Y.Z-SNAPSHOT.zip files, e.g. for latest stable version: https://github.com/anb0s/eclox/releases/latest

Now use inside Eclipse: "Help-> Install New Software... -> Add... -> Archive...", select the zip file and enter name:

Eclox instal local

and select it:

Eclox instal local-2

Optional: similar installation for Doxygen binaries:

Eclox Doxygen instal local

Eclox instal local-2

For additional details, please refer to Eclipse user guide.

Configuration

Once the plugin installed, you must ensure that the default PATH environment variable makes the Doxygen binary reachable for the plugin or you have installed the bundled Doxygen executable from Eclox site. 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.

If you have installed Doxygen executable from Eclox update site, check if it was automaticaly selected: Eclox Doxygen Bundled

If not you can select custom Doxygen location with "Add..." and "Browse...": Eclox Doxygen Custom

Now just select and apply: Eclox Doxygen Custom

For Mac OS X users there is an excellent HowTo: https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

Usage

You can create new Doxygen projects (also called doxyfiles) using the creation wizard. Go to "File -> New -> Other -> Other -> Doxyfile". Press next and set both file location and name. Then an 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.

Eclox basic editor

Eclox advanced editor

Once your have properly set all doxyfile fields, you can launch a documentation build using the toolbar icon showing a blue @-sign. Eclox toolbar icon

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". Additionally, you can browse the latest builds by clicking the down arrow right to the toolbar button.

Eclox toolbar icon menu

When the documentation build starts, a new view showing the build log opens.

Eclox console

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.

Eclox select doxyfile

For developers and contributors

Please checkout the wiki page: https://github.com/anb0s/eclox/wiki/How-to-build

License:

https://www.eclipse.org/legal/epl-2.0

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].