[docs 2/5] Remove empty module group documentation

karkhaz · karkhaz · commit f5be7f11903c · 2017-07-10T12:42:46.000+01:00
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.
diff --git a/src/ansi-c/ansi_c_language.h b/src/ansi-c/ansi_c_language.h
@@ -10,15 +10,10 @@ Author: Daniel Kroening, kroening@kroening.com
 #ifndef CPROVER_ANSI_C_ANSI_C_LANGUAGE_H
 #define CPROVER_ANSI_C_ANSI_C_LANGUAGE_H
 
-/*! \defgroup gr_ansi_c ANSI-C front-end */
-
 #include <util/language.h>
 
 #include "ansi_c_parse_tree.h"
 
-/*! \brief TO_BE_DOCUMENTED
-    \ingroup gr_ansi_c
-*/
 class ansi_c_languaget:public languaget
 {
 public:
diff --git a/src/cpp/cpp_language.h b/src/cpp/cpp_language.h
@@ -12,15 +12,10 @@ Author: Daniel Kroening, kroening@cs.cmu.edu
 #ifndef CPROVER_CPP_CPP_LANGUAGE_H
 #define CPROVER_CPP_CPP_LANGUAGE_H
 
-/*! \defgroup gr_cpp C++ front-end */
-
 #include <util/language.h>
 
 #include "cpp_parse_tree.h"
 
-/*! \brief TO_BE_DOCUMENTED
-    \ingroup gr_cpp
-*/
 class cpp_languaget:public languaget
 {
 public:
diff --git a/src/goto-programs/goto_program.h b/src/goto-programs/goto_program.h
@@ -20,7 +20,6 @@ Author: Daniel Kroening, kroening@kroening.com
 
 /*! \brief A specialization of goto_program_templatet over
            goto programs in which instructions have codet type.
-    \ingroup gr_goto_programs
 */
 class goto_programt:public goto_program_templatet<codet, exprt>
 {
diff --git a/src/goto-programs/goto_program_template.h b/src/goto-programs/goto_program_template.h
@@ -12,8 +12,6 @@ Author: Daniel Kroening, kroening@kroening.com
 #ifndef CPROVER_GOTO_PROGRAMS_GOTO_PROGRAM_TEMPLATE_H
 #define CPROVER_GOTO_PROGRAMS_GOTO_PROGRAM_TEMPLATE_H
 
-/*! \defgroup gr_goto_programs Goto programs */
-
 #include <cassert>
 #include <iosfwd>
 #include <set>
@@ -53,7 +51,6 @@ std::ostream &operator<<(std::ostream &, goto_program_instruction_typet);
 
 /*! \brief A generic container class for a control flow graph
            for one function, in the form of a goto-program
-    \ingroup gr_goto_programs
 */
 template <class codeT, class guardT>
 class goto_program_templatet
diff --git a/src/goto-programs/wp.h b/src/goto-programs/wp.h
@@ -16,16 +16,12 @@ class codet;
 class exprt;
 class namespacet;
 
-/*! \defgroup gr_wp Weakest precondition */
-
 /*! \brief Compute the weakest precondition of the given program
  * piece \a code with respect to the expression \a post.
  * \param code  Program
  * \param post  Postcondition
  * \param ns    Namespace
  * \return Weakest precondition
- *
- * \ingroup gr_wp
 */
 exprt wp(
   const codet &code,
@@ -34,7 +30,6 @@ exprt wp(
 
 /*! \brief approximate the non-deterministic choice
            in a way cheaper than by (proper) quantification
- * \ingroup gr_wp
 */
 
 void approximate_nondet(exprt &dest);
diff --git a/src/goto-symex/goto_symex.h b/src/goto-symex/goto_symex.h
@@ -12,9 +12,6 @@ Author: Daniel Kroening, kroening@kroening.com
 #ifndef CPROVER_GOTO_SYMEX_GOTO_SYMEX_H
 #define CPROVER_GOTO_SYMEX_GOTO_SYMEX_H
 
-/*! \defgroup goto_symex Symbolic execution of goto programs
-*/
-
 #include <util/options.h>
 #include <util/byte_operators.h>
 
diff --git a/src/solvers/smt1/smt1_dec.h b/src/solvers/smt1/smt1_dec.h
@@ -10,8 +10,6 @@ Author: Daniel Kroening, kroening@kroening.com
 #ifndef CPROVER_SOLVERS_SMT1_SMT1_DEC_H
 #define CPROVER_SOLVERS_SMT1_SMT1_DEC_H
 
-/*! \defgroup gr_smt1 SMT-LIB 1.x Interface */
-
 #include <fstream>
 
 #include "smt1_conv.h"
@@ -28,7 +26,6 @@ class smt1_temp_filet
 };
 
 /*! \brief Decision procedure interface for various SMT 1.x solvers
-    \ingroup gr_smt1
 */
 class smt1_dect:protected smt1_temp_filet, public smt1_convt
 {
diff --git a/src/solvers/smt2/smt2_dec.h b/src/solvers/smt2/smt2_dec.h
@@ -10,8 +10,6 @@ Author: Daniel Kroening, kroening@kroening.com
 #ifndef CPROVER_SOLVERS_SMT2_SMT2_DEC_H
 #define CPROVER_SOLVERS_SMT2_SMT2_DEC_H
 
-/*! \defgroup gr_smt2 SMT-LIB 2.x Interface */
-
 #include <fstream>
 
 #include "smt2_conv.h"
@@ -33,7 +31,6 @@ class smt2_stringstreamt
 };
 
 /*! \brief Decision procedure interface for various SMT 2.x solvers
-    \ingroup gr_smt2
 */
 class smt2_dect:protected smt2_stringstreamt, public smt2_convt
 {
diff --git a/src/util/xml.h b/src/util/xml.h
@@ -15,11 +15,6 @@ Author: Daniel Kroening, kroening@kroening.com
 #include <string>
 #include <iosfwd>
 
-/*! \defgroup gr_xml XML file processing */
-
-/*! \brief TO_BE_DOCUMENTED
-    \ingroup xml
-*/
 class xmlt
 {
 public:

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ Author: Daniel Kroening, kroening@kroening.com`
`20`	`20`
`21`	`21`	`/*! \brief A specialization of goto_program_templatet over`
`22`	`22`	`goto programs in which instructions have codet type.`
`23`		`- \ingroup gr_goto_programs`
`24`	`23`	`*/`
`25`	`24`	`class goto_programt:public goto_program_templatet<codet, exprt>`
`26`	`25`	`{`