Skip to content

Commit 10e738b

Browse files
committedJun 2, 2015
Allow linking API docs to Qt docs through the use of qt doxygen tagfiles.
This is done using the new QT_TAG_FILE and QT_DOC_URL cmake options. QT_TAG_FILE should be set to the path of the qt.tags tagfile. In ubuntu this file is provided by the qt4-doc-html package, and is located at /usr/share/qt4/doc/html/qt.tags QT_DOC_URL should be currently set to http://doc.qt.io/qt-4.8/
1 parent 93fb033 commit 10e738b

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed
 

‎cmake_templates/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1405,7 +1405,7 @@ SKIP_FUNCTION_MACROS = YES
14051405
# If a tag file is not located in the directory in which doxygen
14061406
# is run, you must also specify the path to the tagfile here.
14071407

1408-
TAGFILES =
1408+
TAGFILES = @DOXYGEN_TAGS@
14091409

14101410
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
14111411
# a tag file that is based on the input files it reads.

‎doc/CMakeLists.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen docum
44
# include doxygen documentation
55
SET (WITH_TXT2TAGS_PDF FALSE CACHE BOOL "Determines whether PDF should be generate for the txt2tags documentation")
66

7+
# include Qt documentation
8+
SET (QT_DOC_URL "http://doc.qt.io/qt-4.8/" CACHE STRING "URL for Qt docs")
9+
710
INCLUDE(Txt2Tags)
811
FIND_TXT2TAGS()
912

@@ -28,6 +31,16 @@ INSTALL(FILES ../images/icons/qgis-icon-60x60.png DESTINATION ${QGIS_DATA_DIR}/d
2831
IF(WITH_APIDOC)
2932
FIND_PACKAGE(Doxygen)
3033
IF(DOXYGEN_FOUND)
34+
35+
FIND_FILE(QT_TAG_FILE
36+
NAMES qt4.tags qt4.tag qt.tags qt.tag
37+
PATHS "${QT_DOC_DIR}"
38+
DOC "Path to Qt documentation tag file (eg qt.tags)"
39+
)
40+
IF(QT_TAG_FILE)
41+
SET(DOXYGEN_TAGS ${QT_TAG_FILE}=${QT_DOC_URL})
42+
ENDIF(QT_TAG_FILE)
43+
3144
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
3245
ADD_CUSTOM_TARGET(apidoc ALL
3346
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile

0 commit comments

Comments
 (0)
Please sign in to comment.