Changes between Version 1 and Version 2 of Documentation/UserGuide/DoxygenDocumentation


Ignore:
Timestamp:
2022-05-23T13:42:49+02:00 (2 years ago)
Author:
mmcgrath
Comment:

I've tested the steps, and they work for me as well. Just adding a few clarifications to make it a little easier to follow.

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/UserGuide/DoxygenDocumentation

    v1 v2  
    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. 
     1Simple instructions on how to use doxygen to generate offline webpage-form documentation for ORCHIDEE. One of the nice features 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. 
    22 
    33The steps are: 
    … …  
    55(1) Download the most recent trunk of ORCHIDEE code. 
    66 
    7 (2) To install doxygen and the another program needed (examples on ubuntu machine): 
     7(2) To install doxygen and the another program needed (examples on an Ubuntu or Debian machine): 
     8{{{ 
    89sudo apt install doxygen 
    910sudo apt-get install graphviz 
     11}}} 
    1012 
    1113(3) Inside your ORCHIDEE code folder (.../modipsl/modeles/ORCHIDEE/), 
    1214 
    13 download the attached file (with the name of "Doxyfile", which is the doxygen configuration file) and put it into this folder. 
     15Download the attached file (with the name of "Doxyfile", which is the doxygen configuration file) and put it into this folder. 
    1416 
    1517Then run the command 'doxygen Doxyfile' 
     18 
    1619You will see three new folders being added after all commands are OK: 
    1720 
    18 docbook 
    19 latex 
    20 html 
     21{{{ 
     22docbook/ 
     23latex/ 
     24html/ 
     25}}} 
    2126 
    2227Then go into the html folder, there is a file named 'index.html' 
    2328 
    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. 
     29Open it with firefox or any other browser, you will be able to use the 'offline' documentation and check the call graph of different subroutines by looking up routines under the "Namespaces" menu. 
    2530 
    26 You can actually also read code there. 
     31You can also read code from this index.html file (under the "Files" menu). 
     32 
     33These steps were tried with Doxygen version 1.8.13 on Debian 9.13 (stretch).