2011-05-27 22:56:42 +02:00
|
|
|
# include doxygen documentation
|
|
|
|
SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built")
|
|
|
|
|
|
|
|
# include doxygen documentation
|
|
|
|
SET (WITH_TXT2TAGS_PDF FALSE CACHE BOOL "Determines whether PDF should be generate for the txt2tags documentation")
|
|
|
|
|
2015-05-27 16:21:29 +10:00
|
|
|
# include Qt documentation
|
2019-10-06 21:10:36 +02:00
|
|
|
SET (QT_DOC_URL "https://doc.qt.io/qt-5/" CACHE STRING "URL for Qt docs")
|
2015-05-27 16:21:29 +10:00
|
|
|
|
2011-03-06 02:09:21 +00:00
|
|
|
INCLUDE(Txt2Tags)
|
2011-03-06 23:15:18 +00:00
|
|
|
FIND_TXT2TAGS()
|
|
|
|
|
|
|
|
IF(TXT2TAGS_EXECUTABLE)
|
2019-10-26 13:36:31 +02:00
|
|
|
ADD_TXT2TAGS_FILES(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
|
2011-05-27 22:56:42 +02:00
|
|
|
IF(WITH_TXT2TAGS_PDF)
|
2019-10-26 13:36:31 +02:00
|
|
|
ADD_TXT2TAGS_PDFS(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
|
2011-05-27 22:56:42 +02:00
|
|
|
ENDIF(WITH_TXT2TAGS_PDF)
|
2018-02-18 14:01:25 +01:00
|
|
|
FILE(GLOB t2tfiles doc/*.t2t)
|
|
|
|
ADD_CUSTOM_TARGET (t2tdoc ALL DEPENDS ${QGIS_DOC_FILES} ${t2tfiles})
|
2011-03-06 23:15:18 +00:00
|
|
|
ELSE(TXT2TAGS_EXECUTABLE)
|
|
|
|
SET(QGIS_DOC_FILES
|
2019-10-26 13:36:31 +02:00
|
|
|
../INSTALL
|
|
|
|
../NEWS
|
|
|
|
INSTALL.html
|
|
|
|
NEWS.html
|
2011-03-06 23:15:18 +00:00
|
|
|
)
|
|
|
|
ENDIF(TXT2TAGS_EXECUTABLE)
|
2007-01-09 02:39:15 +00:00
|
|
|
|
2019-10-26 13:36:31 +02:00
|
|
|
SET(QGIS_DOC_FILES
|
|
|
|
${QGIS_DOC_FILES}
|
|
|
|
index.html
|
|
|
|
developersmap.html
|
|
|
|
nohelp.html
|
|
|
|
favicon.ico
|
|
|
|
style.css
|
|
|
|
AUTHORS
|
|
|
|
CONTRIBUTORS
|
|
|
|
SPONSORS
|
|
|
|
DONORS
|
|
|
|
TRANSLATORS
|
2019-10-06 20:16:01 +02:00
|
|
|
LICENSE
|
|
|
|
)
|
|
|
|
|
2019-10-26 13:36:31 +02:00
|
|
|
INSTALL(FILES ${QGIS_DOC_FILES} DESTINATION ${QGIS_DATA_DIR}/doc)
|
2014-04-05 20:01:21 +02:00
|
|
|
INSTALL(FILES ../images/icons/qgis-icon-60x60.png DESTINATION ${QGIS_DATA_DIR}/doc/images)
|
2007-01-09 02:39:15 +00:00
|
|
|
|
2016-07-03 23:28:29 +02:00
|
|
|
# Sponsor images
|
|
|
|
FILE (GLOB SPONSOR_IMAGES images/projects/thumbnails/* )
|
|
|
|
INSTALL (FILES ${SPONSOR_IMAGES} DESTINATION ${QGIS_DATA_DIR}/doc/images/projects/thumbnails/)
|
|
|
|
|
2011-03-06 02:09:21 +00:00
|
|
|
IF(WITH_APIDOC)
|
2016-03-30 12:10:32 +01:00
|
|
|
FIND_PACKAGE(Doxygen 1.8.2 REQUIRED)
|
2011-03-06 02:09:21 +00:00
|
|
|
IF(DOXYGEN_FOUND)
|
2016-09-25 16:54:24 +02:00
|
|
|
SET(QHP_FILES ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.qhp)
|
2015-05-27 16:21:29 +10:00
|
|
|
|
2016-04-30 10:15:09 +10:00
|
|
|
# Whether to generate QHP file
|
|
|
|
SET (GENERATE_QHP FALSE CACHE BOOL "Determines whether to generate Qt QHP help from the QGIS API Docs")
|
|
|
|
IF (GENERATE_QHP)
|
|
|
|
SET(WITH_QHP YES)
|
2016-09-25 16:54:24 +02:00
|
|
|
SET(QHP_FILES ${QHP_FILES} ${CMAKE_CURRENT_BINARY_DIR}/api/qch/qgis.qch)
|
2016-04-30 10:15:09 +10:00
|
|
|
ELSE(GENERATE_QHP)
|
|
|
|
SET(WITH_QHP NO)
|
|
|
|
ENDIF(GENERATE_QHP)
|
|
|
|
|
2017-04-25 12:23:36 +02:00
|
|
|
SET(DOXYGEN_INCLUDE_PATH
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core
|
2017-04-25 12:23:36 +02:00
|
|
|
)
|
|
|
|
STRING(REPLACE ";" " " DOXYGEN_INCLUDE_PATH "${DOXYGEN_INCLUDE_PATH}")
|
|
|
|
|
2016-09-21 23:33:43 +02:00
|
|
|
SET(DOXYGEN_INPUT
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/doc
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core
|
2017-09-15 12:36:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/3d
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/annotations
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/auth
|
2019-07-10 17:46:35 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/callouts
|
2019-09-02 09:48:46 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/classification
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/diagram
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/dxf
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/effects
|
2018-04-02 22:46:47 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/expression
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/fieldformatter
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/geometry
|
2017-09-06 17:34:27 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/geocms
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/geocms/geonode
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/gps
|
2019-12-10 13:58:38 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/labeling
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/layertree
|
2017-06-23 16:34:20 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/layout
|
2017-08-30 18:46:12 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/locator
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/metadata
|
2018-04-20 09:19:11 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/mesh
|
[api] Add registry and interface for QgsNumericFormats
QgsNumericFormat subclasses provide a means to format a numeric value
as a string, applying various formatting options. E.g. a default
string to value formatter (included here) includes settings for
controlling the number of decimal places, whether a thousands separator
should be shown, whether a leading + sign should be shown, whether
trailing zeros should be shown.
This PR also includes a formatter for bearings, allowing various
formats of numeric bearings to be applied (e.g. control over decimal
places, etc + control over whether direction E/W suffixes are shown,
or whether values should be limited to either the +/- 180 range or
0-360 degree range)
When formatting values, a QgsNumericFormatContext class is used
to provide context. Currently, this includes the thousands and
decimal separators to apply when formatting (which are taken by
default from the user's locale).
A registry of formatters is included to allow easy addition of
other formats in future (e.g. currencies, percentages, scientific
notation, etc...) and to allow plugin based formats.
The intention is to follow this up with gui configuration widgets
for the formats, and then expose them in various places through
the qgis ui (e.g. in the range editor widget for fields, in scalebar
numbers, as an option for formatting numeric labels, etc)
2020-01-06 15:21:26 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/numericformats
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/pal
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/processing
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/providers
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/providers/memory
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/raster
|
|
|
|
${CMAKE_SOURCE_DIR}/src/core/scalebar
|
2017-08-06 13:39:03 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/symbology
|
2018-11-28 17:03:07 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/validity
|
2020-03-26 19:31:00 +01:00
|
|
|
${CMAKE_SOURCE_DIR}/src/core/vectortile
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui
|
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/auth
|
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/attributetable
|
2019-07-10 17:46:35 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/callouts
|
2020-03-25 10:26:39 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/devtools
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/editorwidgets
|
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/editorwidgets/core
|
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/effects
|
2019-12-11 06:46:24 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/labeling
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/layertree
|
2018-10-24 07:48:39 -04:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/layout
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/locator
|
2020-01-07 10:41:55 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/numericformats
|
2019-01-05 20:31:10 -05:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/ogr
|
2018-02-01 07:21:00 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/processing
|
2020-02-29 16:05:20 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/processing/models
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/raster
|
2017-08-06 13:39:03 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/symbology
|
2020-04-02 20:49:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/gui/vectortile
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis
|
2018-12-18 14:25:08 +01:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/mesh
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/interpolation
|
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/network
|
2017-10-16 16:01:25 +10:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/processing
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/raster
|
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/vector
|
2018-12-21 16:24:01 +01:00
|
|
|
${CMAKE_SOURCE_DIR}/src/analysis/vector/geometry_checker
|
2017-09-15 12:36:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/3d
|
|
|
|
${CMAKE_SOURCE_DIR}/src/3d/chunks
|
|
|
|
${CMAKE_SOURCE_DIR}/src/3d/symbols
|
|
|
|
${CMAKE_SOURCE_DIR}/src/3d/terrain
|
2017-06-02 21:39:44 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/plugins
|
2018-04-26 13:33:48 +02:00
|
|
|
${CMAKE_SOURCE_DIR}/src/quickgui
|
|
|
|
${CMAKE_SOURCE_DIR}/src/quickgui/plugin
|
2016-09-21 23:33:43 +02:00
|
|
|
)
|
|
|
|
|
2018-07-08 17:58:57 +01:00
|
|
|
IF(WITH_SERVER)
|
2016-10-01 13:23:10 +02:00
|
|
|
SET(DOXYGEN_INPUT
|
|
|
|
${DOXYGEN_INPUT}
|
2018-07-07 21:49:26 +01:00
|
|
|
${CMAKE_SOURCE_DIR}/src/server/
|
|
|
|
${CMAKE_SOURCE_DIR}/src/server/services/
|
|
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wms
|
|
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wfs
|
|
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wcs
|
2016-10-01 13:23:10 +02:00
|
|
|
)
|
2018-07-08 17:58:57 +01:00
|
|
|
ENDIF(WITH_SERVER)
|
2016-10-01 13:23:10 +02:00
|
|
|
|
2016-09-21 23:33:43 +02:00
|
|
|
SET(DOXYGEN_FILE_PATTERNS *.h *.cpp *.dox)
|
|
|
|
|
|
|
|
SET(DOXYGEN_FILES)
|
|
|
|
FOREACH(_dir ${DOXYGEN_INPUT})
|
|
|
|
FOREACH(_pattern ${DOXYGEN_FILE_PATTERNS})
|
|
|
|
FILE(GLOB_RECURSE _files ${_dir}/${_pattern})
|
|
|
|
LIST(APPEND DOXYGEN_FILES ${_files})
|
|
|
|
ENDFOREACH(_pattern)
|
|
|
|
ENDFOREACH(_dir)
|
|
|
|
|
|
|
|
STRING(REPLACE ";" " " DOXYGEN_INPUT "${DOXYGEN_INPUT}")
|
|
|
|
|
2017-06-02 21:39:44 +02:00
|
|
|
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
2016-10-04 15:45:55 +02:00
|
|
|
|
|
|
|
SET (DOXYGEN_ON_DEMAND FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be build on demand only")
|
|
|
|
|
|
|
|
IF(DOXYGEN_ON_DEMAND)
|
|
|
|
ADD_CUSTOM_TARGET(apidoc DEPENDS ${QHP_FILES})
|
2019-09-17 15:00:07 +02:00
|
|
|
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api OPTIONAL)
|
2016-10-04 15:45:55 +02:00
|
|
|
ELSE(DOXYGEN_ON_DEMAND)
|
2019-09-17 15:00:07 +02:00
|
|
|
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
2016-10-04 15:45:55 +02:00
|
|
|
ADD_CUSTOM_TARGET(apidoc ALL DEPENDS ${QHP_FILES})
|
|
|
|
ENDIF(DOXYGEN_ON_DEMAND)
|
2016-09-21 23:33:43 +02:00
|
|
|
ADD_CUSTOM_COMMAND(
|
2016-09-25 16:54:24 +02:00
|
|
|
OUTPUT ${QHP_FILES}
|
2016-09-21 23:33:43 +02:00
|
|
|
DEPENDS ${DOXYGEN_FILES}
|
|
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
|
|
COMMENT "Generating API documentation" VERBATIM)
|
2014-04-05 20:01:21 +02:00
|
|
|
INSTALL(FILES ../images/icons/qgis-icon-60x60.png DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
2016-05-19 09:01:38 +02:00
|
|
|
IF(GENERATE_QHP)
|
|
|
|
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/api/qch/qgis.qch DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
|
|
|
ENDIF(GENERATE_QHP)
|
2011-03-06 02:09:21 +00:00
|
|
|
ELSE(DOXYGEN_FOUND)
|
|
|
|
MESSAGE(STATUS "QGIS api documentation not built - Doxygen not found")
|
|
|
|
ENDIF(DOXYGEN_FOUND)
|
|
|
|
ENDIF(WITH_APIDOC)
|
2007-01-09 02:39:15 +00:00
|
|
|
|
2011-03-06 02:09:21 +00:00
|
|
|
#SUBDIRS (images plugins install_guide)
|