| | 1 | Simple instructions on how to use doxygen to generate offline webpage-form documentation for ORCHIDEE. One of the nice feature is that it will show calling graph, i.e., which subroutines a given subroutine is calling and itself in turn is called by which subroutines. The call graph is also interactive. When you click on a subroutine, you will be directed to the details of this subroutine, because the offline webpages are linked. Note we are just visiting our local files using an internet browser. |
| | 2 | |
| | 3 | The steps are: |
| | 4 | |
| | 5 | (1) Download the most recent trunk of ORCHIDEE code. |
| | 6 | |
| | 7 | (2) To install doxygen and the another program needed (examples on ubuntu machine): |
| | 8 | sudo apt install doxygen |
| | 9 | sudo apt-get install graphviz |
| | 10 | |
| | 11 | (3) Inside your ORCHIDEE code folder (.../modipsl/modeles/ORCHIDEE/), |
| | 12 | |
| | 13 | download the attached file (with the name of "Doxyfile", which is the doxygen configuration file) and put it into this folder. |
| | 14 | |
| | 15 | Then run the command 'doxygen Doxyfile' |
| | 16 | You will see three new folders being added after all commands are OK: |
| | 17 | |
| | 18 | docbook |
| | 19 | latex |
| | 20 | html |
| | 21 | |
| | 22 | Then go into the html folder, there is a file named 'index.html' |
| | 23 | |
| | 24 | open it with firefox or any other browser, you will be able to use the 'offline' documentation and check the call graph of different subroutines. |
| | 25 | |
| | 26 | You can actually also read code there. |
