how to get offline api documents

[Nissa wang]

Hi,everybody:

         Everytime i look for an api in ns-3, i search in online Doxygen. i want to know whether it has an offline Doxygen system like MSDN. Then,i can use it without the internet

[Konstantinos]

You can generate Doxygen and have them offline (also reflecting your own ns-3 version if you have added new modules)

Building the Documentation

ns-3 requires Doxygen version 1.5.4 or greater to fully build all items, although earlier versions of Doxygen will 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.

[Nissa wang]

Hi,Konstantinos .Thank you for your advise.but i encounter an error during the doxygen,and i donot konw how to solve it.couldyou help me?

Running dot for graph 1/8658

Error: /home/wdh/eclipse/workspace/ns-allinone-3.18/ns-3.18/doc/html/classns3_1_1_ns2_mobility_helper_test_suite_a7c6f63b35bc1cc1263d941b8da6a1995_cgraph.dot:14: syntax error near line 14

context:   Node5 [label="ns3::Ns2MobilityHelperTest::SetTrace",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classns3_1_1_ns2_mobility_helper_test.html#a4abff7a6cf66e60790f475e130cf5d88",tooltip="Set NS-2 trace to read as single large string (don&#39;t forget to add \n and quote >>>  "& <<< #39;s)"];

Warning: /home/wdh/eclipse/workspace/ns-allinone-3.18/ns-3.18/doc/html/classns3_1_1_ns2_mobility_helper_test_suite_a7c6f63b35bc1cc1263d941b8da6a1995_cgraph.dot:14: string ran past end of line

finished...

'doxygen' finished successfully (4m49.238s)

在 2014年5月14日星期三UTC+8下午3时30分58秒，Konstantinos写道：

[Konstantinos]

I do not really know.

Have you installed all required libraries?

From http://www.nsnam.org/wiki/Installation

• Doxygen and related inline documentation:

 sudo apt-get install doxygen graphviz imagemagick
 sudo apt-get install texlive texlive-extra-utils texlive-latex-extra

[Nissa wang]

I have installed before. Should i change something in doxygen.conf  ??

在 2014年5月14日星期三UTC+8下午9时10分50秒，Konstantinos写道：

[pdbarnes]

Hello Nissa,

You shouldn't have to change anything in doxygen.conf.

What version of ns-3 are you using? What version of doxygen?

Thanks,
Peter