diff options
| author | Dimitry Andric <dim@FreeBSD.org> | 2017-04-16 16:02:28 +0000 |
|---|---|---|
| committer | Dimitry Andric <dim@FreeBSD.org> | 2017-04-16 16:02:28 +0000 |
| commit | 7442d6faa2719e4e7d33a7021c406c5a4facd74d (patch) | |
| tree | c72b9241553fc9966179aba84f90f17bfa9235c3 /docs/analyzer | |
| parent | b52119637f743680a99710ce5fdb6646da2772af (diff) | |
Diffstat (limited to 'docs/analyzer')
| -rw-r--r-- | docs/analyzer/DebugChecks.rst | 8 | ||||
| -rw-r--r-- | docs/analyzer/conf.py | 6 |
2 files changed, 10 insertions, 4 deletions
diff --git a/docs/analyzer/DebugChecks.rst b/docs/analyzer/DebugChecks.rst index ecf11ca0f1339..880dcfc9609ca 100644 --- a/docs/analyzer/DebugChecks.rst +++ b/docs/analyzer/DebugChecks.rst @@ -178,15 +178,21 @@ ExprInspection checks This function explains the value of its argument in a human-readable manner in the warning message. You can make as many overrides of its prototype in the test code as necessary to explain various integral, pointer, - or even record-type values. + or even record-type values. To simplify usage in C code (where overloading + the function declaration is not allowed), you may append an arbitrary suffix + to the function name, without affecting functionality. Example usage:: void clang_analyzer_explain(int); void clang_analyzer_explain(void *); + // Useful in C code + void clang_analyzer_explain_int(int); + void foo(int param, void *ptr) { clang_analyzer_explain(param); // expected-warning{{argument 'param'}} + clang_analyzer_explain_int(param); // expected-warning{{argument 'param'}} if (!ptr) clang_analyzer_explain(ptr); // expected-warning{{memory address '0'}} } diff --git a/docs/analyzer/conf.py b/docs/analyzer/conf.py index 6b54b0646ecab..c40af7a5e8324 100644 --- a/docs/analyzer/conf.py +++ b/docs/analyzer/conf.py @@ -48,10 +48,10 @@ copyright = u'2013-%d, Analyzer Team' % date.today().year # |version| and |release|, also used in various other places throughout the # built documents. # -# The short X.Y version. -version = '4.0' +# The short version. +version = '5' # The full version, including alpha/beta/rc tags. -release = '4.0' +release = '5' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. |