Documenting huge code

Question

I am using Doxygen to document a huge C++-project. Due to hardware limitations I am not able to document the entire code at once. Hence I divided my code into two modules (A and B), and am using the TAGFILES option to document dependencies.

For A

GENERATE_TAGFILE = A_tags
TAGFILES =  ""

For B

GENERATE_TAGFILE = B_tags
TAGFILES = "A_tags = doxygenated_A/html"

However, A and B depend on each other, but using the above configuration I am unable to solve A’s dependency on B.

Can you please suggest how to solve A’s dependency on B?

Do you mean "huge" instead of "hugh"? – Oberon Sep 27 '13 at 10:59 — Oberon, Sep 27 '13 at 10:59

score 0 · Accepted Answer · edited May 23 '17 at 12:21

0

You can use two runs. One run that generates the tag files only for all projects (and no output) and a second run to generate the actual output using the tag files.

See also my answer here https://stackoverflow.com/a/8247993/784672 for more details.

edited May 23 '17 at 12:21

Community

1
1

answered Sep 28 '13 at 10:58

doxygen

14,341
2
43
37

I tried generating the documents using this method, i.e used 2 runs. But I see that when I refer to module B code from module A I get webpage not found. [file:///C:/Users/jaia/Desktop/Doxygenating_code/MODULE_A/html/search/MODULE_B/h‌tml/d3/d2d/BaseEnvelopDriver_8cpp.xhtml] As seen above both Module A and B are found but links are not created correctly Can you please suggest a remedy. – user1918858 Sep 30 '13 at 11:00
The assignment after the A_tags in TAGFILES, should be the relative path to get from project B's html output directory to projects A's html output directory, i.e. typically A_tags=../../doxygenated_A/html" – doxygen Oct 01 '13 at 18:21

Documenting huge code

1 Answers1