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>

1 files changed, 6 insertions, 3 deletions

diff --git a/src/qdoc/quoter.cpp b/src/qdoc/quoter.cpp
index 397caf085..408b1b5b0 100644
--- a/src/qdoc/quoter.cpp
+++ b/src/qdoc/quoter.cpp
@@ -112,7 +112,7 @@ Quoter::Quoter()
     /* We're going to hard code these delimiters:
         * C++, Qt, Qt Script, Java:
           //! [<id>]
-        * .pro, .py files:
+        * .pro, .py, CMake files:
           #! [<id>]
         * .html, .qrc, .ui, .xq, .xml .dita files:
           <!-- [<id>] -->
@@ -120,6 +120,7 @@ Quoter::Quoter()
     if (!commentHash.size()) {
         commentHash["pro"] = "#!";
         commentHash["py"] = "#!";
+        commentHash["cmake"] = "#!";
         commentHash["html"] = "<!--";
         commentHash["qrc"] = "<!--";
         commentHash["ui"] = "<!--";
@@ -339,8 +340,10 @@ void Quoter::failedAtEnd( const Location& docLocation, const QString& command )
 
 QString Quoter::commentForCode() const
 {
-    QString suffix = QFileInfo(codeLocation.fileName()).suffix();
-    return commentHash.value(suffix, "//!");
+    QFileInfo fi = QFileInfo(codeLocation.fileName());
+    if (fi.fileName() == "CMakeLists.txt")
+        return "#!";
+    return commentHash.value(fi.suffix(), "//!");
 }
 
 QString Quoter::removeSpecialLines(const QString &line, const QString &comment, int unindent)