C++: Add top of file doc comment.

2025-12-21 19:26:31 +01:00 · 2024-01-30 17:28:47 +00:00
parent 8b2888c2de
commit c29d0b78ce
1 changed files with 7 additions and 0 deletions
--- a/cpp/ql/lib/semmle/code/cpp/headers/PreprocBlock.qll
+++ b/cpp/ql/lib/semmle/code/cpp/headers/PreprocBlock.qll
@@ -1,3 +1,10 @@
+/**
+ * This library offers a view of preprocessor branches (`#if`, `#ifdef`,
+ * `#ifndef`, `#elif` and `#else`) as blocks of code between the opening and
+ * closing directives, with navigable parent-child relationships to other
+ * blocks. The main class is `PreprocessorBlock`.
+ */
+
 import cpp

 /**