Skip to content

Commit 4d558f5

Browse files
committed
[NFC][analyzer][docs] Migrate 'annotations.html' to RST
This commit migrates the contents of 'annotations.html' in the old HTML-based documentation of the Clang static analyzer to the new RST-based documentation. During this conversion I reordered the sections of this documentation file by placing the section "Custom Assertion Handlers" as a subsection of "Annotations to Enhance Generic Checks". (The primary motivation was that Sphinx complained about inconsistent section levels; with this change I preserved that sections describing individual annotations are all on the same level.) Apart from this change and the format conversion, I didn't review, validate or edit the contents of this documentation file because I think it would be better to place any additional changes in separate commits.
1 parent 56c5a6b commit 4d558f5

File tree

7 files changed

+694
-760
lines changed

7 files changed

+694
-760
lines changed

clang/docs/analyzer/user-docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ Contents:
1212
user-docs/FilingBugs
1313
user-docs/CrossTranslationUnit
1414
user-docs/TaintAnalysisConfiguration
15+
user-docs/Annotations
1516
user-docs/FAQ

0 commit comments

Comments
 (0)