|
Documentation describing the APIs for the various frameworks and functions within OpenRTE is contained in the header files of the code base itself. This has been done in the Doxygen format. It is easy, therefore, to generate your own personal documentation "manual" in html, pdf, latex, or a variety of forms.
Creating the documentation is accomplished in a few simple steps:
- Change directory to the head directory where you installed the Open MPI distribution.
- Change directory to the orte subdirectory and execute doxygen at that location.
You'll need to ensure that the doxygen command is in your path, of course.
Doxygen will traverse the OpenRTE directory tree and create a new subdirectory doxygen. In that subdirectory, you will find subdirectories for each of the output types. In the html subdirectory is an index.html file - simply point your browser at that file and you will see all the header file documentation laid out in a (hopefully) easily navigated display.
You can also run Doxygen in the head directory itself - in this case, Doxygen will traverse
the entire Open MPI directory tree (including all three sub-projects) and create a new subdirectory html.
In that subdirectory, you will again find a doxygen subdirectory tree as described above.
By default, we create the html and pdf versions of the documentation. If you would prefer to add another different format, or delete one of these, you can do so by editing the file named "Doxyfile" in the head directory - it is pretty self-explanatory.
Feel free to
with any questions.
|
![[Flag]](../../community/mirrors/flag-us.gif){kind=small}