Project

General

Profile

Actions

Feature #455

closed

Add support for Doxygen's "tag files"

Added by Jörg Riesmeier almost 13 years ago. Updated about 12 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
Start date:
2012-10-25
Due date:
% Done:

100%

Estimated time:
Module:
doxygen
Operating System:
Compiler:

Description

These tag files can be used to link the DCMTK documentation from external projects. See: http://www.stack.nl/~dimitri/doxygen/external.html

This has already been used successfully for the DICOM WSI Converter. Here's the patch to the DCMTK:

diff --git a/doxygen/CMakeLists.txt b/doxygen/CMakeLists.txt
index b05e9d8..f0256ec 100644
--- a/doxygen/CMakeLists.txt
+++ b/doxygen/CMakeLists.txt
@@ -36,6 +36,8 @@ IF(DCMTK_WITH_DOXYGEN)
   IF(NOT WIN32)
     INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/manpages/ DESTINATION ${DCMTK_INSTALL_MANDIR} COMPONENT man PATTERN "CVS" EXCLUDE)
   ENDIF(NOT WIN32)
+  # install tag file
+  INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/dcmtk.tag DESTINATION ${DCMTK_INSTALL_DOCDIR} COMPONENT doc)

   # cleanup created files on "make clean" - directories are not removed with CMake 2.4 :-/
   SET(make_clean_files ${CMAKE_CURRENT_BINARY_DIR}/htmldocs ${CMAKE_CURRENT_BINARY_DIR}/manpages)
diff --git a/doxygen/htmldocs.cfg b/doxygen/htmldocs.cfg
index 150d854..e52e5ef 100644
--- a/doxygen/htmldocs.cfg
+++ b/doxygen/htmldocs.cfg
@@ -1531,7 +1531,7 @@ TAGFILES               =
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.

-GENERATE_TAGFILE       =
+GENERATE_TAGFILE       = dcmtk.tag

 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 # in the class index. If set to NO only the inherited external classes

However, when adding this feature to the DCMTK, there should be an CMake option for this since the "dcmtk.tag" file gets pretty large (about 14 MB).

Actions #1

Updated by Jörg Riesmeier about 12 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100
Actions

Also available in: Atom PDF