[clang] [clang][analyzer] Improve documentation of StreamChecker (NFC). (PR #83858)

Ben Shi via cfe-commits cfe-commits at lists.llvm.org
Mon Mar 4 21:43:23 PST 2024


================
@@ -3020,44 +3020,82 @@ Check for misuses of stream APIs. Check for misuses of stream APIs: ``fopen, fcl
 
 alpha.unix.Stream (C)
 """""""""""""""""""""
-Check stream handling functions: ``fopen, tmpfile, fclose, fread, fwrite, fseek, ftell, rewind, fgetpos,``
-``fsetpos, clearerr, feof, ferror, fileno``.
+Check C stream handling functions:
+``fopen, fdopen, freopen, tmpfile, fclose, fread, fwrite, fgetc, fgets, fputc, fputs, fprintf, fscanf, ungetc, getdelim, getline, fseek, fseeko, ftell, ftello, fflush, rewind, fgetpos, fsetpos, clearerr, feof, ferror, fileno``.
+
+The checker maintains information about the C stream objects (``FILE *``) and
+can detect error conditions related to use of streams. The following conditions
+are detected:
+
+* The ``FILE *`` pointer passed to the function is NULL. (At ``fflush``
----------------
benshi001 wrote:

The ``FILE *`` pointer passed to a function is NULL. (except ''fflush'' which allows that)

https://github.com/llvm/llvm-project/pull/83858


More information about the cfe-commits mailing list