Skip to content

Commit 648aabe

Browse files
committed
Add the doxygen help in readme file
1 parent b5fd0a7 commit 648aabe

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,24 @@ See `vm-env.md`.
1515

1616
## Simulation Script: ##
1717

18-
## Results Subdirectory ##
18+
## Results Subdirectory ##
19+
20+
## Doxygen Documents ##
21+
22+
```bash
23+
# install the doxygen, check the version
24+
sudo apt update
25+
sudo apt install doxygen graphviz dia
26+
doxygen --version
27+
# after install, reconfigure ns-3
28+
./ns3 configure --enable-tests --enable-examples --enable-python-bindings
29+
./ns3 build
30+
./ns3 docs doxygen
31+
# the doc will gene in ./doc/html/index.html
32+
xdg-open build/doxygen/html/index.html
33+
34+
# PS: if using vm, could using the http server, add port forwarding in Vritualbox config.
35+
# like port 127.0.0.1:2233 -> 8080
36+
python3 -m http.server --directory ./doc/html 8080 # set in vm (remote)
37+
http://127.0.0.1:2233 # open in local host
38+
```

0 commit comments

Comments
 (0)