diff options
| author | Kai Koehne <kai.koehne@qt.io> | 2019-04-02 09:46:30 +0200 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2019-04-02 11:55:53 +0000 |
| commit | b8a6084861456f5448c0fd0c22e0192e83ffb5f0 (patch) | |
| tree | b752d1e15677da9df7555914d941635914d09cbf /src/qdoc/doc/qdoc-manual-markupcmds.qdoc | |
| parent | ebda25ecb40aa1a13920a534bf2c6449981b92fe (diff) | |
qdoc: Add support for CMake comments
CMake uses # as a line comment marker. To detect CMake files
we check for the suffix .cmake, or check whether the filename
is "CMakeLists.txt".
See also
https://cmake.org/cmake/help/latest/manual/cmake-language.7.html
[ChangeLog][qdoc] qdoc now uses #! as a snippet marker in
.cmake, CMakeLists.txt files.
Task-number: QTBUG-73058
Change-Id: I230b113f0d49dd487b0f1926c815295a8a660a27
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-markupcmds.qdoc')
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index 1b6648f90..22b0b4e6b 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -1767,6 +1767,11 @@ ... \endcode + By default, qdoc looks for \c{//!} as a code snippet marker. + For \c{.pro}, \c{.py}, \c{.cmake}, and \c{CMakeLists.txt} + files, \c {#!} is detected. Finally, \c{<!--} is accepted in + \c{.html}, \c{.qrc}, \c{.ui}, \c{.xml}, \c{.dita}, and \c{.xq} files. + \target codeline-command \section1 \\codeline |