Skip to content

Commit 7feedb7

Browse files
author
John Nonweiler
committed
Fix Doxygen formatting in parse_options.h
The use of `\example` in this file created a new section in the main (side bar) menu. In order to limit the categories in the top level menu, the formatting is changed here to be more like how examples are given in other sections of our documentation. Also, a full stop is used to separate a method summary from more detailed documentation, to make the generated documentation look better.
1 parent 6b3d01a commit 7feedb7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/util/parse_options.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,13 @@ class parse_options_baset
4545
std::string
4646
banner_string(const std::string &front_end, const std::string &version);
4747

48-
/// Utility for displaying help centered messages borderered by "* *"
49-
/// - we use this for displaying banner information and the like
50-
/// in help messages
51-
/// \example
48+
/// Utility for displaying help centered messages borderered by "* *".
49+
/// We use this for displaying banner information and the like
50+
/// in help messages.
51+
/// ```
5252
/// align_center_with_border("test-text")
5353
/// == "* * test-text * *"
54+
/// ```
5455
std::string align_center_with_border(const std::string &text);
5556

5657
#endif // CPROVER_UTIL_PARSE_OPTIONS_H

0 commit comments

Comments
 (0)