Changes between Version 4 and Version 5 of Documentation/UserGuide/DoxygenDocumentation


Ignore:
Timestamp:
2023-06-01T12:54:41+02:00 (12 months ago)
Author:
jgipsl
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/UserGuide/DoxygenDocumentation

    v4 v5  
    11=  Use doxygen to generate subroutine call graphs and offline html-form documentation = 
    22 
    3 Author: Chao Yue 
    4 Last revision: 2022/06/01, Chao Yue  
     3Author: Chao Yue[[BR]] 
     4Last revision: 2022/06, Chao Yue [[BR]] 
     5 
    56 
    67Simple 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. As a result it's not encouraged to do this on a server because it's not necessarily straightforward to install doxygen and related software on a server or to initiate a web browser and forward its content to your own monitor or screen, with the latter especially slow when the internet connection to the server is bad.