Jump to: navigation, search

EDT:EGLDoc

Revision as of 14:48, 9 July 2012 by Jspadea.us.ibm.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Overview

The EGLDoc component is similar to Javadoc - create a set of HTML documentation from source files. The HTML files will show relations between parts, structure breakdown, any any detailed documentation that was written in the source code. For example the HTML for a program part would list its parameters, fields, and functions. If any of these elements had documentation written in the "egldoc" syntax then that information would be used as a description of that element. If no documentation was written for an element you will still see the API of the element.



EGLDoc spec

TBD




Getting the code

The code resides in CVS with the rest of the EDT code: :pserver:anonymous@dev.eclipse.org:/cvsroot/tools

Plug-ins:

org.eclipse.edt/gen/org.eclipse.edt.gen.egldoc
org.eclipse.edt/ide/org.eclipse.edt.ide.egldoc




Running EGLDoc

You can kick off EGLDoc generation by right-clicking on an EGL project > Generate EGLDoc. This will generate HTML files for all *.egl files within the project, and the output will be placed inside <project>/egldoc/.