If any of the above apply, you can use doxygen's tag file mechanism. If the author requires compliance with some license condition as a precondition of redistribution, and you do not want to be bound by those conditions, referring to their copy of their documentation is preferable to including a copy. When the author forbids redistribution, this is necessary. If the external package and its documentation are copyright someone else, it may be better - or even necessary - to reference it rather than include a copy of it with your project's documentation. Availability: For some projects that are documented with doxygen, the sources may just not be available. By dividing the sources into several "packages", the sources of one package can be parsed by doxygen, while all other packages that this package depends on, are linked in externally. Memory: For very large source trees, letting doxygen parse all sources may simply take too much of your system's memory. It does not make much sense to let doxygen parse the sources for these external project over and over again, even if nothing has changed. Compilation speed: External projects typically have a different update frequency from your own project. You may want to link to these pages instead of generating the documentation in your local output directory. If your project depends on external libraries or tools, there are several reasons to not include all sources for these with every run of doxygen: Disk space: Some documentation may be available outside of the output directory of doxygen already, for instance somewhere on the web.
0 Comments
Leave a Reply. |