DocItEasy is a software that allow you to quickly produce source documentation for programs written in Ada, C or Java. It generates HTML documents.
Generated pages contain:
- dictionaries of main elements (classes, fonctions, types, ...),
- more readable listings,
- a global index.
DocItEasy can work on C, Ada or Java source files. Later version will accept C++ or Lisp (CLOS) source files. Generated pages are in french or english.
Installing DocItEasy
Written in Java, DocItEasy can be run on any system that have a Java Virtual Machine (almost all systems). But the JVM must be installed first. See the Sun www site to download JRE (Java Runtime Environment) or JDK (Java Development Kit).
Once Java is installed, download one of this file :
- DocItEasy.tgz (~110ko)
- DocItEasy.jar (~140ko)
The last thing is to create a shortcut to run DocItEasy:.
exemples :
- Windows: java -classpath %CLASSPATH%;c:\whereIs\DocIt.jar DocItEasy
- Unix: java -classpath $CLASSPATH:/usr/local/DocIt.jar DocItEasy &
The main windows of DocItEasy looks like this::
To run it, you must indicate:
- In:
- The directory where the source files are. All files and sub-directories will be examinated.,
- Language of source files (Ada, C or Java),
- File extensions. For java, .java. For C, ".c .h" and ".C .H" added if your OS doesn't makes any case distinction.
- Out:
- The destination directory for HTML generated files,
- HTML file language,
- If you want a short HTML extension selected the last option.
To view the result, open the "index.htm(l)" file located in the output directory with your browser.
License:
This software is free. It is distributed as a GPL licenced software.
Future version:
- Highest Priority:
- Lisp (CLOS)
- Ada
- C++
- Other:
- generation of Latex or RTF instead of HTML
