Criterion/doc/assert.rst

47 lines
976 B
ReStructuredText
Raw Permalink Normal View History

.. _assertions-ref:
Assertion reference
===================
This is an exhaustive list of all assertion macros that Criterion provides.
As each ``assert`` macros have an ``expect`` counterpart with the exact same
number of parameters and name suffix, there is no benefit in adding ``expect``
macros to this list. Hence only ``assert`` macros are represented here.
All ``assert`` macros may take an optional ``printf`` format string and
parameters.
Base Assertions
-----------------
.. doxygengroup:: BaseAsserts
Common Assertions
-----------------
.. doxygengroup:: CommonBinAsserts
.. doxygengroup:: CommonUnaryAsserts
.. doxygengroup:: FloatAsserts
String Assertions
-----------------
.. doxygengroup:: StringAsserts
Array Assertions
-----------------
.. doxygengroup:: ArrayAsserts
.. doxygengroup:: SafeArrCmpAsserts
2015-09-14 04:16:03 +02:00
Exception Assertions
--------------------
.. doxygengroup:: ExceptionAsserts
2015-09-14 04:16:03 +02:00
File Assertions
---------------
.. doxygengroup:: FileAsserts