Skip to content

Commit

Permalink
Update the contents
Browse files Browse the repository at this point in the history
  • Loading branch information
kazssym committed Jun 28, 2020
1 parent 76ec619 commit 2db6f4d
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion sphinx/interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@ Programming interface
Assertions
----------

The functions described in this section are declared in the
`cppunitx::assertion` namespace.

.. cpp:namespace:: cppunitx::assertion

.. cpp:function:: template<class T, class U> \
void assertEqual(T x, U y, const char *message = nullptr)
template<class T, class U> \
void assertEqual(T x, U y, const std::string &message)

This function asserts two values are equal to each other.

.. cpp:function:: void fail(const char *message = nullptr)
void fail(const std::string &message)

This function throws an exception to signal a test failure.
This function signals a test failure by throwing an exception.

0 comments on commit 2db6f4d

Please sign in to comment.