summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2015-06-20 21:51:05 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2015-06-20 21:51:05 (GMT)
commitf63d9ed958d2c06717434e1a90e6417cf2d60f6b (patch)
tree0bd2fb98598d2c87971eb041429b58bf9afee831 /doc
parentdfe93f9fde39167eae2aeeab929641a9c56cc916 (diff)
downloadDoxygen-f63d9ed958d2c06717434e1a90e6417cf2d60f6b.zip
Doxygen-f63d9ed958d2c06717434e1a90e6417cf2d60f6b.tar.gz
Doxygen-f63d9ed958d2c06717434e1a90e6417cf2d60f6b.tar.bz2
Various minor changes
- made copying doc and example files a target - fixed bug using temparary in the wizard. - Added faq question about extension mapping
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt12
-rw-r--r--doc/faq.doc15
2 files changed, 23 insertions, 4 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 877c9b8..af557d8 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -6,8 +6,6 @@ find_program(MAKE NAMES make gmake nmake )
file(GLOB DOC_FILES "*")
file(GLOB LANG_FILES "${CMAKE_SOURCE_DIR}/src/translator_??.h")
-file(COPY ${DOC_FILES} DESTINATION ${DOXYDOCS})
-file(COPY ${EXAMPLE_DIR} DESTINATION ${PROJECT_BINARY_DIR})
file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/man)
file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/src)
@@ -16,6 +14,14 @@ file(COPY ${CMAKE_SOURCE_DIR}/src/translator_adapter.h DESTINATION ${PROJECT_BIN
file(COPY ${LANG_FILES} DESTINATION ${PROJECT_BINARY_DIR}/src)
file(COPY ${CMAKE_SOURCE_DIR}/VERSION DESTINATION ${PROJECT_BINARY_DIR})
+# copy all doc files
+add_custom_target(copy_docs)
+foreach(doc_file ${DOC_FILES})
+ add_custom_command(TARGET copy_docs PRE_BUILD
+ COMMAND ${CMAKE_COMMAND} -E
+ copy ${doc_file} ${DOXYDOCS})
+endforeach()
+
add_custom_target(docs
COMMENT "Generating documentation in ${DOXYDOCS}"
COMMAND ${EXECUTABLE_OUTPUT_PATH}/doxygen
@@ -27,7 +33,7 @@ add_custom_target(docs
COMMAND ${SED} -e "s/\$VERSION/${VERSION}/g" doxygen.sty > ../latex/doxygen.sty
COMMAND ${EPSTOPDF} doxygen_logo.eps --outfile=../latex/doxygen_logo.pdf
COMMAND ${MAKE} -C ../latex > latex_out.txt
- DEPENDS doxygen ${PROJECT_BINARY_DIR}/doc/language.doc config.doc examples
+ DEPENDS doxygen copy_docs ${PROJECT_BINARY_DIR}/doc/language.doc config.doc examples
"${PROJECT_BINARY_DIR}/man/doxygen.1"
"${PROJECT_BINARY_DIR}/man/doxywizard.1"
"${PROJECT_BINARY_DIR}/man/doxysearch.1"
diff --git a/doc/faq.doc b/doc/faq.doc
index 0f12a44..bd327a1 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -63,7 +63,7 @@ PREDEFINED = MY_MACRO()=
manual for more information.
</ol>
-\section faq_extract_allWhen I set EXTRACT_ALL to NO none of my functions are shown in the documentation.
+\section faq_extract_all When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.
In order for global functions, variables, enums, typedefs, and defines
to be documented you should document the file in which these commands are
@@ -77,6 +77,19 @@ block containing the \ref cmddefgroup "\\defgroup" command.
For member functions or functions that are part of a namespace you should
document either the class or namespace.
+\section faq_ext_mapping My file with a custom extension is not parsed (properly) (anymore).
+
+Doxygen only parses files that are specified as input (via the \ref cfg_input "INPUT" tag)
+and that match a specified extension (mentioned in \ref cfg_file_patterns "FILE_PATTERNS")
+The list of files is then reduced by excluding files listed as \ref cfg_exclude "EXCLUDE" or
+files that match the patterns set by \ref cfg_exclude_patterns "EXCLUDE_PATTERNS".
+
+In the past doxygen parsed all files with an unknown extension as C files which could lead to
+undesired results. Since version 1.8.8, doxygen requires that you specify a mapping that tells
+for a certain file extension, which parser to use.
+This mapping is specified using the \ref cfg_extension_mapping "EXTENSION_MAPPING" tag.
+If no mapping is specified the file's contents will be ignored.
+
\section faq_code How can I make doxygen ignore some code fragment?
The new and easiest way is to add one comment block