Merge pull request #806 from 2bndy5/alias-unparsed-code

treat .unparsed as plain text
breathe-doc · Feb 18, 2022 · c1d15fe · c1d15fe · 2bndy5 · Feb 24, 2022
2 parents 2a68310 + 5602cf5
commit c1d15fe
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/breathe/filetypes.py b/breathe/filetypes.py
@@ -18,4 +18,7 @@ def get_extension(filename: str) -> str:
     # If the filename is just '.ext' then we get ('.ext', '') so we fall back to first part if
     # the second isn't there
     (first, second) = os.path.splitext(filename)
-    return (second or first).lstrip(".")
+
+    # Doxygen allows users to specify the file extension ".unparsed" to disable syntax highlighting.
+    # We translate it into the pygments unhighlighted 'text' type
+    return (second or first).lstrip(".").replace("unparsed", "text")
diff --git a/documentation/source/codeblocks.rst b/documentation/source/codeblocks.rst
@@ -91,6 +91,11 @@ recognize the code block's contained syntax as a C++ snippet.
     *     message(STATUS "Element is ${element}")
     * endforeach()
     * @endcode
+    * 
+    * Another code-block that explicitly remains not highlighted.
+    * @code{.unparsed}
+    * Show this as is.
+    * @endcode
     */
    void with_unannotated_cmake_code_block();
 

diff --git a/examples/specific/code_blocks.h b/examples/specific/code_blocks.h
@@ -16,6 +16,11 @@ void with_standard_code_block();
  *     message(STATUS "Element is ${element}")
  * endforeach()
  * @endcode
+ * 
+ * Another code-block that explicitly remains not highlighted.
+ * @code{.unparsed}
+ * Show this as is.
+ * @endcode
  */
 void with_unannotated_cmake_code_block();