[NFC][analyzer][docs] Improve Annotations.rst (#122749)
commitb9207aef09387342837069d2c0857e6d331a516c
authorDonát Nagy <donat.nagy@ericsson.com>
Fri, 31 Jan 2025 17:01:08 +0000 (31 18:01 +0100)
committerGitHub <noreply@github.com>
Fri, 31 Jan 2025 17:01:08 +0000 (31 18:01 +0100)
tree96e5f7b375dc242bd21411131c7d3e1469471858
parent65136a35309670c24bd0b8c98561fa4f7b503a70
[NFC][analyzer][docs] Improve Annotations.rst (#122749)

This commit fixes three issues within the documentation file
`Annotations.rst` which was recently created by my earlier commit
https://github.com/llvm/llvm-project/pull/122246 .

(1) The section title "Annotations to Enhance Generic Checks" is changed
to "General Purpose Annotations" because it was a bit too verbose and it
used the obsolete name "checks" for what we now call "checkers" in the
static analyzer.

(2) Several code blocks were missing from the generated html because I
accidentally used `.. code-block: c` instead of `.. code-block:: c` and
so Sphinx parsed them as comment blocks. (Without printing any error or
warning...)

(3) The `ownership_*` attributes (which are used by `MallocChecker`)
were missing from this document, so I wrote a section that briefly
describes them and links to their full documentation.
clang/docs/analyzer/user-docs/Annotations.rst