summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGeorge Karpenkov <ekarpenkov@apple.com>2017-09-14 00:04:56 +0000
committerGeorge Karpenkov <ekarpenkov@apple.com>2017-09-14 00:04:56 +0000
commit7f54275c133baba8d97e85856cd2d5b3a26a17e0 (patch)
tree11d8aadab5042580dc6ac2b90acca29a2393e4e0 /docs
parentea180c9c542cf48ba30e05bded7a71a6b0706539 (diff)
[NFC] [Analyzer] Fix RST markup in documentation.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@313219 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/analyzer/DebugChecks.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/analyzer/DebugChecks.rst b/docs/analyzer/DebugChecks.rst
index 880dcfc960..e2a8e05417 100644
--- a/docs/analyzer/DebugChecks.rst
+++ b/docs/analyzer/DebugChecks.rst
@@ -74,7 +74,7 @@ inspects expressions.)
ExprInspection checks
---------------------
-- void clang_analyzer_eval(bool);
+- ``void clang_analyzer_eval(bool);``
Prints TRUE if the argument is known to have a non-zero value, FALSE if the
argument is known to have a zero or null value, and UNKNOWN if the argument
@@ -93,7 +93,7 @@ ExprInspection checks
clang_analyzer_eval(x); // expected-warning{{TRUE}}
-- void clang_analyzer_checkInlined(bool);
+- ``void clang_analyzer_checkInlined(bool);``
If a call occurs within an inlined function, prints TRUE or FALSE according to
the value of its argument. If a call occurs outside an inlined function,
@@ -125,7 +125,7 @@ ExprInspection checks
clang_analyzer_eval(value == 42); // expected-warning{{TRUE}}
}
-- void clang_analyzer_warnIfReached();
+- ``void clang_analyzer_warnIfReached();``
Generate a warning if this line of code gets reached by the analyzer.
@@ -138,7 +138,7 @@ ExprInspection checks
clang_analyzer_warnIfReached(); // no-warning
}
-- void clang_analyzer_numTimesReached();
+- ``void clang_analyzer_numTimesReached();``
Same as above, but include the number of times this call expression
gets reached by the analyzer during the current analysis.
@@ -149,7 +149,7 @@ ExprInspection checks
clang_analyzer_numTimesReached(); // expected-warning{{3}}
}
-- void clang_analyzer_warnOnDeadSymbol(int);
+- ``void clang_analyzer_warnOnDeadSymbol(int);``
Subscribe for a delayed warning when the symbol that represents the value of
the argument is garbage-collected by the analyzer.
@@ -173,7 +173,7 @@ ExprInspection checks
} while(0); // expected-warning{{SYMBOL DEAD}}
-- void clang_analyzer_explain(a single argument of any type);
+- ``void clang_analyzer_explain(a single argument of any type);``
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
@@ -197,7 +197,7 @@ ExprInspection checks
clang_analyzer_explain(ptr); // expected-warning{{memory address '0'}}
}
-- void clang_analyzer_dump(a single argument of any type);
+- ``void clang_analyzer_dump( /* a single argument of any type */);``
Similar to clang_analyzer_explain, but produces a raw dump of the value,
same as SVal::dump().
@@ -209,7 +209,7 @@ ExprInspection checks
clang_analyzer_dump(x); // expected-warning{{reg_$0<x>}}
}
-- size_t clang_analyzer_getExtent(void *);
+- ``size_t clang_analyzer_getExtent(void *);``
This function returns the value that represents the extent of a memory region
pointed to by the argument. This value is often difficult to obtain otherwise,
@@ -226,7 +226,7 @@ ExprInspection checks
clang_analyzer_explain(ys); // expected-warning{{'8'}}
}
-- void clang_analyzer_printState();
+- ``void clang_analyzer_printState();``
Dumps the current ProgramState to the stderr. Quickly lookup the program state
at any execution point without ViewExplodedGraph or re-compiling the program.