Git Product home page Git Product logo

anb0s / eclox Goto Github PK

View Code? Open in Web Editor NEW
34.0 6.0 2.0 406.53 MB

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.

Home Page: http://anb0s.github.io/eclox

License: Eclipse Public License 2.0

Java 98.93% HTML 0.81% Batchfile 0.25%
eclipse eclipse-plugin doxygen doxygen-frontend-plug doxyfile

eclox's Introduction

- Project is discontinued and not maintained anymore!

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

eclox's People

Contributors

anb0s avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

rprabhu lius-rui

eclox's Issues

Actionscript or Java preprocessor

Original Savannah ticket 472 reported by gbrocker on Mon Mar 14 06:52:44 2005.

I am trying to Doxygen and eclox with actionscript which is similar to Java.
It seems to be having trouble with
"MyClass extends MyBaseClass"
It associates the attributes of MyClass with MyBaseClass and MyClass is documented as having no methods or properties.
Is there a java pre-compiler that I have to apply to make this work correctly.
Where do I specify this in eclox?

Activating Eclox in Eclipse

Original Savannah ticket 300 reported by gbrocker on Fri Aug 27 03:15:04 2004.

I installed Eclox into the plugins directory and I am trying to figure out how to make the doxygen binary reachable for the plugin. The manual .txt file said to "open Eclipse's preference edition dialog window and go into the new "Doxygen" section. I cannot find the dialog you are talking about. What menu and what option do I select to get to this dialog box? Then, what do I do on the dialog box?

Thank you,
Lori

Reassigned item: The doxygen editor cuts the ALIASES Entry string

Original Savannah ticket 866 reported by gbrocker on Fri Oct 08 14:48:30 2004.

The ALIASE entry:

ALIASES = "Function=\par Function: \n"

is sown as

"Function

in the Editor.

If I change a parameter and save the doxyfile, then the editor cuts the ALIASE entry in the doxyfile.

Missing sections and tags if using doxywizard

Original Savannah ticket 245 reported by gbrocker on Thu Feb 05 18:21:12 2004.

Setup:
Windows XP, Eclipse 2.1.2, CDT, eclox, doxygen & doxywizard 1.3.5

Bug:
After filling the information in the wizard (doxywizard) the file in the eclipse/eclox view only contains the search engine section and no tags at all...

Can not open Doxyfile generatet by doxywizard with the editor

Original Savannah ticket 333 reported by None on Fri Oct 08 14:29:36 2004.

I found the problem by the ALIASES entry.

I had to convert the ALIASES entry from
ALIASES = "Function=\par Function: \n"
"Type=\par Type: \n"
"Input=\par Input: \n"
"Output=\par Output: \n"
Return=\return
"Pattern=\par Pattern: \n"
Author=\author
"File=\par File: \n"
"SeeAlso=\par SeeAlso: \n"
"link=\par Link: \n"
"supplierCardinality=\par SupplierCardinality: \n"
"supplierRole=\par SupplierRole: \n"

to

ALIASES = "Function=\par Function: \n" "Type=\par Type: \n" "Input=\par Input: \n" "Output=\par Output: \n" Return=\return "Pattern=\par Pattern: \n" Author=\author "File=\par File: \n" "SeeAlso=\par SeeAlso: \n" "link=\par Link: \n" "supplierCardinality=\par SupplierCardinality: \n" "supplierRole=\par SupplierRole: \n"

Editing multi-lines tags values.

Original Savannah ticket 274 reported by gbrocker on Mon Feb 23 17:33:15 2004.

Some tags have long values (like PREDEFINED for macros) and editing them is not very easy actually.

muliple Doxyfiles - editing

Original Savannah ticket 363 reported by None on Thu Nov 04 16:58:15 2004.

I would like to have multiple doxyfiles for one project.
Is there possibility to have per project binding for Doxyfiles.

I would like to have a file named "Doxyfile" for generating the documentation for the whole project and then another ones for quick testing if some files are generating documentation correctly.

The names of secondary doxygen conf files would be different for each project.

I would like to have a project properties for the Eclox plugin which would specify the Doxygen conf files and those would be opened in the editor.

Build log incomplete

Original Savannah ticket 864 reported by gbrocker on Fri Oct 08 14:35:55 2004.

When doxygen has finish to build the documentation, the build log is sometimes incomplete.

Cannot launch Doxygen

Original Savannah ticket 5979 reported by gbrocker on Tue May 23 12:10:27 2006.

I have doxygen installed in
~/bin/doxygen

I have setup the corresponding preferences with the absolute path.

Trying to build it results in:

Unexpected error: eclox.core.doxygen.DoxygenException: Unable to launch Doxygen.

I am using eclipse 3.1.

I am reverting to 0.4.4 until this is solved...

Multiple path/file does not work

Original Savannah ticket 5981 reported by gbrocker on Tue May 23 12:31:20 2006.

I can't use the multiple path dialogs..

For instance, in the INPUT tag, although it displays my current items, if I try to select a new one by clicking 'Add', whatever I choose will not be added. This happens both for paths, files selected via the browser or if I type the path myself.

Also, when I select a path, it should transform it to absolute, instead of relative, since you never know what will be the current path during doxygen execution (imagine running it outside of eclipse).

Scan doxyfiles for absolute paths.

Original Savannah ticket 246 reported by gbrocker on Tue Jun 01 17:41:05 2004.

Adda feature to scan doxyfiles for absolute pathes. Propose to rewritte absolute pathes to relatives when possible.

File/open/other/other/doxygen

Original Savannah ticket 2341 reported by gbrocker on Tue May 10 22:49:27 2005.

Trying to create the doxygen file I receive this error in a dialog box:

CreateProcess: "C:\Program Files\Eclipse\plugins\eclox_0.3.4\eclox.jar" -g "C:\Program Files\Eclipse\workspace\Tnauth\DAuthtest.Doxyfile" error=193

Import of existing configuration files

Original Savannah ticket 470 reported by None on Mon Mar 14 06:26:44 2005.

I did not see any where that existing files could be imported so I created a new one according to the eclox manual and then copied my old configuration on top of it.
What is the correct way to do the import.

Little syntax enhancement in the doxygen console title

Original Savannah ticket 5976 reported by gbrocker on Mon May 22 15:24:32 2006.

Currently, the title shows "[Doxygen Build] /runtime/doc/doxyfile". Conforming to the standard presentation rules would give "Doxygen Build [/runtime/doc/doxyfile]".

0.3.1 not eunning in eclipse 3.0

Original Savannah ticket 524 reported by gbrocker on Thu Jul 15 04:03:54 2004.

downloaded and expanded 0.3.1 into the plugin directory of eclisp 3.0 (windows)
Nothin shows up on restart. Nothing added in preferences etc.
does eclox work eclipse 3.0?

thanks
bammi at memento-inc.com

Specially named doxyfiles

Original Savannah ticket 1604 reported by gbrocker on Fri May 11 15:17:03 2007.

Yegor Yefremov a ecrit :
> Hi!

Hello!

> Is necessary that doxygen should have .doxyfile extension? Mozilla
> people call their doxygen files *.cfg and so do I. Could it be changed
> to allow any file extension?

Indeed, only files having the ".doxyfile" extension or named "doxyfile" are automatically recognized and opened with eclox's editor.

Eclipse allows you to configure file and editor associations. Go to "Window>Preferences>General>Editors>File Associations" and then create a new file type that will associated to the doxyfile editor.

So you can name your doxygen files like you want but there is still a problem. These doxygen files will not be recognized as doxyfiles by eclox's building system. In other words, you will not be able to build those doxygen files using eclox (either from the contextual menu or from the action in the toolbar) :(

I will fill-up a support request and see how this problem can be solved.

Thank you for your interest for eclox.

-- Guillaume

Incremental build

Original Savannah ticket 1092 reported by None on Fri May 26 14:34:43 2006.

Whenever i save my file, doxygen updates incrementally only the documentation for the current file. But i'm not sure if doxygen has such a mode.

doxygen

Original Savannah ticket 2450 reported by None on Tue Nov 03 13:01:29 2009.

N/A

aaaaaaaaaaaaa

Original Savannah ticket 1610 reported by None on Mon May 14 15:34:16 2007.

N/A

Parsing Doxygen Wizard files

Original Savannah ticket 471 reported by gbrocker on Mon Mar 14 06:28:30 2005.

While trying to "import" an existing Doxygen configuration file, eclox would not parse multiline entries that the Doxygen wizard had created. I had to manually remove the line continuation \ and the CR to get the whle thing on one line. This occured on ABBREVIATE_BRIEF and FILE_PATTERNS where the Doxygen wizard had put each entry on a line with a line continuation \ at the end of all the lines except the last.

Marking finish of doxygen

Original Savannah ticket 1296 reported by gbrocker on Wed Oct 04 14:24:54 2006.

It would be nice if a line was added to the view "console" after doxygen has finished. It should look like:

...
Generating file member index...
Generating namespace member index...
Generating page index...
Generating graph info page...

Doxygen has finished! <-- This line is requested.

Cause depending on the selected doxyfile, the workspace size and other influences you do not know whether doxygen has finished or not.

Regards
Torge

Windows vs Linux line endings

Original Savannah ticket 815 reported by gbrocker on Wed Sep 29 09:12:21 2004.

There must be support for both Linux and Windows line endings in the doxyfile editor.

Generate Tag Files option is incorrect

Original Savannah ticket 5700 reported by gbrocker on Wed Apr 05 20:13:30 2006.

The "Generate Tag Files" option is incorrect. It offers a choice of "Yes", "No", or "Default", where it should actually have an editbox with a filename.

Selecting Yes will generate a tagfile named "YES".

Reassigned item: @INLCUDE -&gt; Syntax Error

Original Savannah ticket 2869 reported by gbrocker on Mon Sep 12 12:09:42 2005.

Doxygen allows to include other Files with the Include directive. @include
This is very helpful for SubProjects, so we include the general file and then override the sub project specific settings.

Unfortunataelly the DoxyFile editor draws a "Syntax Error" and sstopps parsing.
Please let the Syntax checker at least ignore @include directives !

Thanks !

TAGFILES note missing

Original Savannah ticket 5983 reported by gbrocker on Tue May 23 12:38:12 2006.

It says: note to be done.
From the config.doc file in doxygen I think it should read:

"The TAGFILES tag can be used to specify one or more tagfiles."

File is not well recognized.

Original Savannah ticket 241 reported by None on Wed Feb 04 11:15:43 2004.

See the attached file for an example of what is not well recognized.

doxygen and eclipse freeze.

Original Savannah ticket 413 reported by gbrocker on Wed Jun 09 15:50:59 2004.

Sometimes doxygen seems to be halted (and eclipse too) during the documentation generation. It happens not very often, but it should be fixed.
Temporary solution : kill the doxygen process.

Runtimeerror in version: 0.3.3

Original Savannah ticket 332 reported by gbrocker on Fri Oct 08 09:28:49 2004.

After installing version 0.3.3 on my eclipse 3.0 und 3.0.1 I have runtimeerrors.

The Errormessage:
Cannot open default editor on Doxyfile. Unable to instantiate editor: eclox.ui.editor org.eclipse.core.runtime.CoreException: Plug-in eclox was unable to load class eclox.ui.editor.Editor.

I diden't have such troubles with version 0.3.2

Unhandled doxyfile name

Original Savannah ticket 5972 reported by gbrocker on Mon May 22 12:20:02 2006.

When a doxyfile is called "doxyfile", it is not associated to the doxyfile editor.

Strip From Path option is incorrect

Original Savannah ticket 5927 reported by gbrocker on Thu May 11 11:11:39 2006.

The "Generate Tag Files" option is incorrect. It is defined as boolean, but it this is a text entry.

I solved it by commenting out line 67:

STRIP_FROM_PATH.type = boolean

This way, it is like the STRIP_FROM_INC_PATH option.

Reassigned item: Can not open Doxyfile generatet by doxywizard with the editor

Original Savannah ticket 865 reported by gbrocker on Fri Oct 08 14:47:43 2004.

I found the problem by the ALIASES entry.

I had to convert the ALIASES entry from
ALIASES = "Function=\par Function: \n"
"Type=\par Type: \n"
"Input=\par Input: \n"
"Output=\par Output: \n"
Return=\return
"Pattern=\par Pattern: \n"
Author=\author
"File=\par File: \n"
"SeeAlso=\par SeeAlso: \n"
"link=\par Link: \n"
"supplierCardinality=\par SupplierCardinality: \n"
"supplierRole=\par SupplierRole: \n"

to

ALIASES = "Function=\par Function: \n" "Type=\par Type: \n" "Input=\par Input: \n" "Output=\par Output: \n" Return=\return "Pattern=\par Pattern: \n" Author=\author "File=\par File: \n" "SeeAlso=\par SeeAlso: \n" "link=\par Link: \n" "supplierCardinality=\par SupplierCardinality: \n" "supplierRole=\par SupplierRole: \n"

The doxygen editor cuts the ALIASES Entry string

Original Savannah ticket 334 reported by gbrocker on Fri Oct 08 14:35:39 2004.

The ALIASE entry:

ALIASES = "Function=\par Function: \n"

is sown as

"Function

in the Editor.

If I change a parameter and save the doxyfile, then the editor cuts the ALIASE entry in the doxyfile.

setting comiler path

Original Savannah ticket 5563 reported by gbrocker on Fri Mar 24 23:34:12 2006.

Hi,

I am unable to set a valid compiler path for eclox. I'm using the latest eclox with Eclipse SDK, Version: 3.1.2, Build id: M20060118-160 running under Mac OS X 10.3.9 (7W98), Kernel Version: Darwin 7.9.0. ( I get the same error on a second machine running OS X 10.4.5).

When I browse for the compiler path under /Preferences and enter /Applications/Doxygen.app, I get this error: "Value must be an existing file". What am I doing wrong? Am I correct in assuming that the "compiler" is Doxygen or do you mean the gcc compiler or ?

Thanks,
Steve

Add ability to use Doxyfile not in project scope

Original Savannah ticket 658 reported by None on Thu Aug 11 17:16:39 2005.

At present, eclox can only use a Doxyfile that is contained within the project directory; however, many large projects contain more than one Eclipse project, and they may all be documented together. In such cases, it would be helpful to be able to select a Doxyfile that is not in the project directory.
As a workaround, giving eclox the ability to recognize Windows shortcuts, Mac aliases, and Unix symbolic links would be nice.

Comment stub generator

Original Savannah ticket 221 reported by None on Mon May 03 21:22:59 2004.

A way to generate stubs for methods. Auto-parsing of parameters, template parameters and exceptions to generate "an as complete as possible" stub to be filled with comments such has the one already included in eclipse for Java classes.

WorkingSets

Original Savannah ticket 245 reported by None on Tue Jun 01 17:39:31 2004.

Allow to define working sets for doxyfile sets to compile.

Generated Doxyfile not editable

Original Savannah ticket 5716 reported by gbrocker on Fri Apr 07 11:23:17 2006.

Installed Eclox 0.4.4 trough the eclipse update function.
Generated a standard doxyfile. When opening doxyfile editor got this error:

Unable to create this part due to an internal error. Reason for the failure: Unexpected error. Syntax error at line 42. Unable to match line.

Didn't edit the file in any way. Also other doxyfiles (from doxywizard or eclox) give the same sort of error.

Complete error detail in attachement

Same problem as #300

Original Savannah ticket 301 reported by gbrocker on Mon Aug 30 21:30:36 2004.

Hi,

I have same problem with Eclox 0.3.1. It does not working under eclipse 3.0.0. I follow the instalation instruction, but after restart eclipse platform, plugin not initilizet and did not see in all of places with you specifi in documentation.

In the section Help -> About Eclips Platform -> Plug-in details - is not eclox initialised.

Thank for help.

Reassigned item: @INLCUDE -&gt; Syntax Error

Original Savannah ticket 2868 reported by gbrocker on Mon Sep 12 12:08:23 2005.

Doxygen allows to include other Files with the Include directive. @include
This is very helpful for SubProjects, so we include the general file and then override the sub project specific settings.

Unfortunataelly the DoxyFile editor draws a "Syntax Error" and sstopps parsing.
Please let the Syntax checker at least ignore @include directives !

Thanks !

@INLCUDE -&gt; Syntax Error

Original Savannah ticket 700 reported by None on Thu Sep 08 11:44:01 2005.

Doxygen allows to include other Files with the Include directive. @include
This is very helpful for SubProjects, so we include the general file and then override the sub project specific settings.

Unfortunataelly the DoxyFile editor draws a "Syntax Error" and sstopps parsing.
Please let the Syntax checker at least ignore @include directives !

Thanks !

Wrong types

Original Savannah ticket 5980 reported by gbrocker on Tue May 23 12:16:46 2006.

The following variables are Boolean but show up as a text field:
RTF_HYPERLINKS
XML_PROGRAMLISTING
PERLMOD_LATEX

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.