-
Notifications
You must be signed in to change notification settings - Fork 36
Description
Description
As user of doxygen for code documentation I want to be able to link requirement UID in doxygen html export to the requirement in the strictdox html export.
Problem
Since the strictdoc html export is organized from file name and folder structure it is not enough to know the requirement UID on the doxygen side in order to create a working URL to the strictdoc export.
Solution
Doxygen has a TAGFILE feature that is used to link to external documentation. This tagfile is in XML format and look like this:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<tagfile doxygen_version="1.9.8">
<compound kind="page">
<name>REQ-1</name>
<filename>strictdocfolder/mystrictdocreq.html#REQ-1</filename>
</compound>
</tagfile>
When the requirement is referenced in source code comment block with the command \ref REQ-1, doxygen will insert a link to the <filename/> in the output.
The tagfile is added to the doxygen config field TAGFILES =
The location of the strictdoc export can be set in the TAGFILE field like so: TAGFILES = strictdoc.tag=../../strictdoc or absolute TAGFILES = strictdoc.tag=http://example.com/strictdoc