- edited description
Doxygen Documentation for UPC++
As requested by Dr. Baden, please find attached a generated Doxygen documentation for UPC++ source code that lists the classes, their data members and functions found in the source code folder. The file was generated by using doxygen tool. Currently it just lists the functions' signature and where the definition is. To get a more descriptive documentation some annotations are needed as comments inside the code to be extracted by doxygen.
Here are the steps used to generate the file:
1- doxygen -g
output: default configuration file named Doxyfile
2- Edit these variables in the Doxyfile
EXTRACT_ALL = YES
SOURCE_BROWSER = YES
3- doxygen Doxyfile
This will generate two folders html and latex
To access html version look for index.html
For latex:
cd latex/
export PDF_HYPERLINKS=YES
export USE_PDFLATEX=YES
make
Generated filename is: refman.pdf
Comments (2)
-
reporter -
- changed status to closed
This issue was triaged at the 2018-06-13 Pagoda meeting.
This issue does not represent a task, defect or proposed enhancement.
- Log in to comment