aboutsummaryrefslogtreecommitdiff
path: root/doxygen
diff options
context:
space:
mode:
authorMinos Galanakis <minos.galanakis@arm.com>2020-07-21 15:13:52 +0100
committerTamas Ban <tamas.ban@arm.com>2020-09-24 12:49:54 +0000
commitdff2eaee4ab96f9641d7bc91b4f8ceee229d5728 (patch)
treeb03fed4d75144655d893b23947aef7770fe66b39 /doxygen
parentd19a19f161148b97f3ec8ccec7baebd79599f8c4 (diff)
downloadtrusted-firmware-m-dff2eaee4ab96f9641d7bc91b4f8ceee229d5728.tar.gz
Build: Convert docs directory to modern cmake
Add cmake files to docs directory. Remove unneeded cmake files. By default, the targets are generated but not run by `make all` or `make`. The documentation can be generated by running `make docs` Please refer to the tfm_build_instructions document for reference examples. WARNING: This change will not build in isolation, it requires _all_ other cmake changes to successfully build. It is split out only for ease of understanding. Change-Id: I1b004a8f8ccfba2df901d91b093576fdc6bfa40d Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Signed-off-by: Raef Coles <raef.coles@arm.com>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Doxyfile.in18
1 files changed, 9 insertions, 9 deletions
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
index ccfa60cc6..60b1ea4bd 100644
--- a/doxygen/Doxyfile.in
+++ b/doxygen/Doxyfile.in
@@ -45,7 +45,7 @@ PROJECT_NAME = "TF-M Reference Manual"
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = @DOXYCFG_TFM_VERSION@
+PROJECT_NUMBER = @CMAKE_PROJECT_VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -58,7 +58,7 @@ PROJECT_BRIEF = Trusted Firmware-M
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
-PROJECT_LOGO = @TFM_ROOT_DIR@/doxygen/TrustedFirmware-Logo_icon.png
+PROJECT_LOGO = @CMAKE_SOURCE_DIR@/doxygen/TrustedFirmware-Logo_icon.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@@ -169,7 +169,7 @@ FULL_PATH_NAMES = YES
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
-STRIP_FROM_PATH = "@TFM_ROOT_DIR@"
+STRIP_FROM_PATH = "@CMAKE_SOURCE_DIR@"
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
@@ -178,7 +178,7 @@ STRIP_FROM_PATH = "@TFM_ROOT_DIR@"
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
-STRIP_FROM_INC_PATH = "@TFM_ROOT_DIR@"
+STRIP_FROM_INC_PATH = "@CMAKE_SOURCE_DIR@"
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
@@ -797,10 +797,10 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = "@TFM_ROOT_DIR@/doxygen" \
- "@TFM_ROOT_DIR@/interface" \
- "@TFM_ROOT_DIR@/secure_fw" \
- "@TFM_ROOT_DIR@/test"
+INPUT = "@CMAKE_SOURCE_DIR@/doxygen" \
+ "@CMAKE_SOURCE_DIR@/interface" \
+ "@CMAKE_SOURCE_DIR@/secure_fw" \
+ "@CMAKE_SOURCE_DIR@/test"
# This tag can be used to specify the character encoding of the source files
@@ -1423,7 +1423,7 @@ GENERATE_ECLIPSEHELP = No
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
-ECLIPSE_DOC_ID = @DOXYCFG_ECLIPSE_DOCID@
+# ECLIPSE_DOC_ID = @DOXYCFG_ECLIPSE_DOCID@
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The