You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/customizing-library-models-for-cpp.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ Since we are adding a new source, we need to add a tuple to the ``sourceModel``
92
92
The first five values identify the callable (in this case a free function) to be modeled as a source.
93
93
94
94
- The first value ``"boost::asio"`` is the namespace name.
95
-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
95
+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
96
96
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
97
97
- The fourth value ``"read_until"`` is the function name.
98
98
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``read_until``.
@@ -128,7 +128,7 @@ Since we want to add a new sink, we need to add a tuple to the ``sinkModel`` ext
128
128
The first five values identify the callable (in this case a free function) to be modeled as a sink.
129
129
130
130
- The first value ``"boost::asio"`` is the namespace name.
131
-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
131
+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
132
132
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
133
133
- The fourth value ``"write"`` is the function name.
134
134
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``write``.
@@ -165,7 +165,7 @@ Since we are adding flow through a function, we need to add tuples to the ``summ
165
165
The first five values identify the callable (in this case free function) to be modeled as a summary.
166
166
167
167
- The first value ``"boost::asio"`` is the namespace name.
168
-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
168
+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
169
169
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
170
170
- The fourth value ``"buffer"`` is the function name.
171
171
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``buffer``.
@@ -207,7 +207,7 @@ Since we are adding a barrier, we need to add a tuple to the ``barrierModel`` ex
207
207
The first five values identify the callable (in this case a free function) to be modeled as a barrier.
208
208
209
209
- The first value ``""`` is the namespace name.
210
-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
210
+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
211
211
- The third value ``False`` is a flag that indicates whether or not the barrier also applies to all overrides of the method. For a free function, this should be ``False``.
212
212
- The fourth value ``"mysql_real_escape_string"`` is the function name.
213
213
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.
@@ -247,7 +247,7 @@ Since we are adding a barrier guard, we need to add a tuple to the ``barrierGuar
247
247
The first five values identify the callable (in this case a free function) to be modeled as a barrier guard.
248
248
249
249
- The first value ``""`` is the namespace name.
250
-
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modelling a free function, the type is left blank.
250
+
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
251
251
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to all overrides of the method. For a free function, this should be ``False``.
252
252
- The fourth value ``"is_safe"`` is the function name.
253
253
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.
0 commit comments