Skip to content

Commit 2a02d3f

Browse files
committed
Fix doxygen
1 parent 54dd052 commit 2a02d3f

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

src/solvers/smt2_incremental/smt_response_validation.cpp

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
// Author: Diffblue Ltd.
22

3-
/// \file Validation of smt response parse trees to produce either a strongly
4-
/// typed `smt_responset` representation, or a set of error messages.
5-
/// \note Functions named with the prefix `validate_` require the given parse
6-
/// tree to be a particular kind of sub tree. Functions named with the prefix
7-
/// `valid_` are called in places where the exact kind of sub-tree expected is
8-
/// unknown and so the function must determine if the sub-tree is of that type
9-
/// at all, before performing validation of it. These functions will return a
10-
/// `response_or_errort` in the case where the parse tree is of that type or
11-
/// an empty optional otherwise.
3+
/// \file
4+
///
5+
/// Validation of smt response parse trees to produce either a strongly typed
6+
/// `smt_responset` representation, or a set of error messages.
7+
///
8+
/// \note
9+
///
10+
/// Functions named with the prefix `validate_` require the given parse tree to
11+
/// be a particular kind of sub tree. Functions named with the prefix `valid_`
12+
/// are called in places where the exact kind of sub-tree expected is unknown
13+
/// and so the function must determine if the sub-tree is of that type at all,
14+
/// before performing validation of it. These functions will return a
15+
/// `response_or_errort` in the case where the parse tree is of that type or
16+
/// an empty optional otherwise.
1217

1318
#include <solvers/smt2_incremental/smt_response_validation.h>
1419

0 commit comments

Comments
 (0)