NS3 using Doxygen to generate offline API documentation

Doxygen's Wiki introduction:

Doxygen is a tool for writing software reference files. This file is written directly in the source code, so it's easier to keep up to date. Doxygen can cross-reference uses an ISO and source code so that the reader of the file can easily refer to the actual source code.

NS3 's official also has doxygen generated documents, see: NS3 official Doxygen

But because of the network or other reasons, we have the need of local offline access, so Doxygen comes in handy. Here's a look at how to use Doxygen:

1. The official approach is as follows:

Ns-3 requires Doxygen version 1.5.4 or greater to fully build all items, although earlier versions of Doxygen would mostly Work. Type "./waf--doxygen" or "./waf--doxygen-no-build" to build the documentation. The doc/directory contains configuration for Doxygen (doxygen.conf) and Main.h. The Doxygen build process puts HTML files into the doc/html/directory, and latex filex into the doc/latex/directory.

That is, we use the command:

./waf--doxygen

Can.

2. Use the above command to error:

WAF Configure didn't detect Doxygen in the system-cannot build API docs

Two jobs need to be done:

(1) Installation Doxygen:

sudo apt-get install Doxygen

(2) Reconfigure WAF, see Google's NS3 forum post in this step:

./waf Configure--enable-examples--enable-tests

Then my configuration also encountered a problem:

Attributeerror: ' Buildcontext ' object has no attribute ' add_subdirs '

I have added a module--vanet-highway, it is estimated that the problem of this module, find the Error statement, the current comment out the statement.

3. Use the command in step 1 again to generate the document, my build directory is:/home/zy/code/ns3/ns3/ns-3.20/doc/html

How do I use this document? Two methods:

(1) File browser: However, due to too many files, the file browser will always load the file, click on the bottom right fork can stop loading, and then open with a browser on it, the effect is as follows:

(2) terminal open, terminal does not load. Let's take a look at how many files are generated:

[Email protected]:~/code/ns3/ns3/ns-3.20/doc/html$ LS-LR | grep "^-" | wc-l68170

So many files, no wonder it's been loaded so long. Then use the command, open with a browser:

Google-chrome aodv*.html

Reference Posts:

Get NS3 's help document using Doxygen

Compiling and viewing the NS3 Help documentation locally