[all-commits] [llvm/llvm-project] b9207a: [NFC][analyzer][docs] Improve Annotations.rst (#12...

[Donát Nagy via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: b9207aef09387342837069d2c0857e6d331a516c
      https://github.com/llvm/llvm-project/commit/b9207aef09387342837069d2c0857e6d331a516c
  Author: Donát Nagy <donat.nagy at ericsson.com>
  Date:   2025-01-31 (Fri, 31 Jan 2025)

  Changed paths:
    M clang/docs/analyzer/user-docs/Annotations.rst

  Log Message:
  -----------
  [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.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications