Changes between Version 2 and Version 3 of Documentation/UserGuide/DoxygenDocumentation
- Timestamp:
- 2022-05-23T15:53:22+02:00 (2 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Documentation/UserGuide/DoxygenDocumentation
v2 v3 1 Simple 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. 1 Simple 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. 2 2 3 The steps are: 3 This Howto page is created under the related discussions of ticket #571 in which it's decided that automatic documentation in coding is largely removed. 4 5 Better to do this on your local computer. The steps are: 4 6 5 7 (1) Download the most recent trunk of ORCHIDEE code. 6 8 7 (2) To install doxygen and the another program needed ( examples on an Ubuntu or Debian machine):9 (2) To install doxygen and the another program needed (here examples on an Ubuntu or Debian machine): 8 10 {{{ 9 11 sudo apt install doxygen … … 31 33 You can also read code from this index.html file (under the "Files" menu). 32 34 33 These steps were tried with Doxygen version 1.8.13 on Debian 9.13 (stretch).35 Successful experiences were reported with Doxygen version 1.8.13 on Debian 9.13 (stretch), and with Doxygen version 1.9.3 on Manjaro arch-linux.
