Skip to content

Commit f5be7f1

Browse files
committed
[docs 2/5] Remove empty module group documentation
Doxygen module groups that did not contain any documentation are removed from the codebase. There are still a few module groups remaining, which do contain useful content. This commit declutters the Doxygen Modules section in preparation for a commit introducing per-directory module documentation.
1 parent c9144dc commit f5be7f1

File tree

9 files changed

+0
-33
lines changed

9 files changed

+0
-33
lines changed

src/ansi-c/ansi_c_language.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,10 @@ Author: Daniel Kroening, [email protected]
1010
#ifndef CPROVER_ANSI_C_ANSI_C_LANGUAGE_H
1111
#define CPROVER_ANSI_C_ANSI_C_LANGUAGE_H
1212

13-
/*! \defgroup gr_ansi_c ANSI-C front-end */
14-
1513
#include <util/language.h>
1614

1715
#include "ansi_c_parse_tree.h"
1816

19-
/*! \brief TO_BE_DOCUMENTED
20-
\ingroup gr_ansi_c
21-
*/
2217
class ansi_c_languaget:public languaget
2318
{
2419
public:

src/cpp/cpp_language.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,10 @@ Author: Daniel Kroening, [email protected]
1212
#ifndef CPROVER_CPP_CPP_LANGUAGE_H
1313
#define CPROVER_CPP_CPP_LANGUAGE_H
1414

15-
/*! \defgroup gr_cpp C++ front-end */
16-
1715
#include <util/language.h>
1816

1917
#include "cpp_parse_tree.h"
2018

21-
/*! \brief TO_BE_DOCUMENTED
22-
\ingroup gr_cpp
23-
*/
2419
class cpp_languaget:public languaget
2520
{
2621
public:

src/goto-programs/goto_program.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Author: Daniel Kroening, [email protected]
2020

2121
/*! \brief A specialization of goto_program_templatet over
2222
goto programs in which instructions have codet type.
23-
\ingroup gr_goto_programs
2423
*/
2524
class goto_programt:public goto_program_templatet<codet, exprt>
2625
{

src/goto-programs/goto_program_template.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Author: Daniel Kroening, [email protected]
1212
#ifndef CPROVER_GOTO_PROGRAMS_GOTO_PROGRAM_TEMPLATE_H
1313
#define CPROVER_GOTO_PROGRAMS_GOTO_PROGRAM_TEMPLATE_H
1414

15-
/*! \defgroup gr_goto_programs Goto programs */
16-
1715
#include <cassert>
1816
#include <iosfwd>
1917
#include <set>
@@ -53,7 +51,6 @@ std::ostream &operator<<(std::ostream &, goto_program_instruction_typet);
5351

5452
/*! \brief A generic container class for a control flow graph
5553
for one function, in the form of a goto-program
56-
\ingroup gr_goto_programs
5754
*/
5855
template <class codeT, class guardT>
5956
class goto_program_templatet

src/goto-programs/wp.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,12 @@ class codet;
1616
class exprt;
1717
class namespacet;
1818

19-
/*! \defgroup gr_wp Weakest precondition */
20-
2119
/*! \brief Compute the weakest precondition of the given program
2220
* piece \a code with respect to the expression \a post.
2321
* \param code Program
2422
* \param post Postcondition
2523
* \param ns Namespace
2624
* \return Weakest precondition
27-
*
28-
* \ingroup gr_wp
2925
*/
3026
exprt wp(
3127
const codet &code,
@@ -34,7 +30,6 @@ exprt wp(
3430

3531
/*! \brief approximate the non-deterministic choice
3632
in a way cheaper than by (proper) quantification
37-
* \ingroup gr_wp
3833
*/
3934

4035
void approximate_nondet(exprt &dest);

src/goto-symex/goto_symex.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ Author: Daniel Kroening, [email protected]
1212
#ifndef CPROVER_GOTO_SYMEX_GOTO_SYMEX_H
1313
#define CPROVER_GOTO_SYMEX_GOTO_SYMEX_H
1414

15-
/*! \defgroup goto_symex Symbolic execution of goto programs
16-
*/
17-
1815
#include <util/options.h>
1916
#include <util/byte_operators.h>
2017

src/solvers/smt1/smt1_dec.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Author: Daniel Kroening, [email protected]
1010
#ifndef CPROVER_SOLVERS_SMT1_SMT1_DEC_H
1111
#define CPROVER_SOLVERS_SMT1_SMT1_DEC_H
1212

13-
/*! \defgroup gr_smt1 SMT-LIB 1.x Interface */
14-
1513
#include <fstream>
1614

1715
#include "smt1_conv.h"
@@ -28,7 +26,6 @@ class smt1_temp_filet
2826
};
2927

3028
/*! \brief Decision procedure interface for various SMT 1.x solvers
31-
\ingroup gr_smt1
3229
*/
3330
class smt1_dect:protected smt1_temp_filet, public smt1_convt
3431
{

src/solvers/smt2/smt2_dec.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Author: Daniel Kroening, [email protected]
1010
#ifndef CPROVER_SOLVERS_SMT2_SMT2_DEC_H
1111
#define CPROVER_SOLVERS_SMT2_SMT2_DEC_H
1212

13-
/*! \defgroup gr_smt2 SMT-LIB 2.x Interface */
14-
1513
#include <fstream>
1614

1715
#include "smt2_conv.h"
@@ -33,7 +31,6 @@ class smt2_stringstreamt
3331
};
3432

3533
/*! \brief Decision procedure interface for various SMT 2.x solvers
36-
\ingroup gr_smt2
3734
*/
3835
class smt2_dect:protected smt2_stringstreamt, public smt2_convt
3936
{

src/util/xml.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@ Author: Daniel Kroening, [email protected]
1515
#include <string>
1616
#include <iosfwd>
1717

18-
/*! \defgroup gr_xml XML file processing */
19-
20-
/*! \brief TO_BE_DOCUMENTED
21-
\ingroup xml
22-
*/
2318
class xmlt
2419
{
2520
public:

0 commit comments

Comments
 (0)