Skip to content

Commit 5f70859

Browse files
committed
C++: Improve the SideEffect library QLDoc.
1 parent c94582a commit 5f70859

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

cpp/ql/src/semmle/code/cpp/models/interfaces/SideEffect.qll

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,18 @@ abstract class SideEffectFunction extends Function {
1818
/**
1919
* Holds if the function never reads from memory that was defined before entry to the function.
2020
* This memory could be from global variables, or from other memory that was reachable from a
21-
* pointer that was passed into the function.
21+
* pointer that was passed into the function. Input side-effects, and reads from memory that
22+
* cannot be visible to the caller (for example a buffer inside an I/O library) are not modelled
23+
* here.
2224
*/
2325
abstract predicate hasOnlySpecificReadSideEffects();
2426

2527
/**
2628
* Holds if the function never writes to memory that remains allocated after the function
2729
* returns. This memory could be from global variables, or from other memory that was reachable
28-
* from a pointer that was passed into the function.
30+
* from a pointer that was passed into the function. Output side-effects, and writes to memory
31+
* that cannot be visible to the caller (for example a buffer inside an I/O library) are not
32+
* modelled here.
2933
*/
3034
abstract predicate hasOnlySpecificWriteSideEffects();
3135

0 commit comments

Comments
 (0)