From 7b74c035881e6290d716fc7e05022cad84a3ce7e Mon Sep 17 00:00:00 2001 From: Stefan Vigerske Date: Mon, 7 Oct 2024 16:26:52 +0200 Subject: [PATCH 1/3] fix position of symmetry docu groups - move PublicSymmetryMethods from INTERNALAPI TO PUBLICCOREAPI - add PublicSymmetryGraphMethods to PublicSymmetryMethods --- doc/xternal.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/xternal.c b/doc/xternal.c index 1980924e57..052003816b 100644 --- a/doc/xternal.c +++ b/doc/xternal.c @@ -9455,10 +9455,15 @@ */ /**@defgroup PublicSymmetryMethods Symmetry - * @ingroup INTERNALAPI + * @ingroup PUBLICCOREAPI * @brief methods for symmetry handling */ +/**@defgroup PublicSymmetryGraphMethods Symmetry Graph + * @ingroup PublicSymmetryMethods + * @brief methods for symmetry graph handling + */ + /**@defgroup FileReaderIncludes Inclusion methods * @ingroup FILEREADERS * @brief methods to include specific file readers into \SCIP From 60aa08b6d2e613a23ed53730732a1363c3f6ac28 Mon Sep 17 00:00:00 2001 From: Christopher Hojny Date: Mon, 7 Oct 2024 20:12:18 +0200 Subject: [PATCH 2/3] avoid listing a "note" twice --- src/scip/symmetry_graph.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/scip/symmetry_graph.c b/src/scip/symmetry_graph.c index ac75f3cccb..18542a221f 100644 --- a/src/scip/symmetry_graph.c +++ b/src/scip/symmetry_graph.c @@ -39,7 +39,7 @@ /** creates and initializes a symmetry detection graph with memory for the given number of nodes and edges * - * @note At some point, the graph needs to be freed! + * @note at some point, the graph needs to be freed! */ SCIP_RETCODE SCIPcreateSymgraph( SCIP* scip, /**< SCIP data structure */ From 767c08a1bc0b15d30a754a2b645f98bbf2d7f93d Mon Sep 17 00:00:00 2001 From: Christopher Hojny Date: Mon, 7 Oct 2024 20:12:36 +0200 Subject: [PATCH 3/3] move SymGraph to data structures section --- doc/xternal.c | 12 +++++++----- src/scip/symmetry_graph.c | 2 +- src/scip/symmetry_graph.h | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/xternal.c b/doc/xternal.c index 052003816b..be3e731c7d 100644 --- a/doc/xternal.c +++ b/doc/xternal.c @@ -9049,6 +9049,13 @@ * @brief methods for creating and accessing user decompositions */ +/**@defgroup SymGraph Symmetry Detection Graph + * @ingroup DataStructures + * @brief methods for creating and manipulating symmetry detection graphs + * + * Below you find a list of functions to create and manipulate symmetry detection graphs. + */ + /**@defgroup MiscellaneousMethods Miscellaneous Methods * @ingroup PUBLICCOREAPI * @brief commonly used methods from different categories @@ -9459,11 +9466,6 @@ * @brief methods for symmetry handling */ -/**@defgroup PublicSymmetryGraphMethods Symmetry Graph - * @ingroup PublicSymmetryMethods - * @brief methods for symmetry graph handling - */ - /**@defgroup FileReaderIncludes Inclusion methods * @ingroup FILEREADERS * @brief methods to include specific file readers into \SCIP diff --git a/src/scip/symmetry_graph.c b/src/scip/symmetry_graph.c index 18542a221f..fff19d342a 100644 --- a/src/scip/symmetry_graph.c +++ b/src/scip/symmetry_graph.c @@ -23,7 +23,7 @@ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**@file symmetry_graph.c - * @ingroup PUBLICCOREAPI + * @ingroup OTHER_CFILES * @brief methods for dealing with symmetry detection graphs * @author Christopher Hojny */ diff --git a/src/scip/symmetry_graph.h b/src/scip/symmetry_graph.h index d58ef215a0..d0d05a4d95 100644 --- a/src/scip/symmetry_graph.h +++ b/src/scip/symmetry_graph.h @@ -44,7 +44,7 @@ extern "C" { #endif -/**@addtogroup PublicSymmetryGraphMethods +/**@addtogroup SymGraph * * @{ */