diff --git a/nl-writer2/include/api/c/sol-handler2-c-impl.h b/nl-writer2/include/api/c/sol-handler2-c-impl.h index b139365bd..52948c6d4 100644 --- a/nl-writer2/include/api/c/sol-handler2-c-impl.h +++ b/nl-writer2/include/api/c/sol-handler2-c-impl.h @@ -17,7 +17,7 @@ template class VecReader; /// Wrap SOLHandler2_C into a C++ class, -/// in order to interface it for NLReader2 +/// in order to interface it for mp::SOLReader2 class SOLHandler2_C_Impl : public SOLHandler2 { public: diff --git a/nl-writer2/include/mp/nl-feeder2.h b/nl-writer2/include/mp/nl-feeder2.h index afd06d3ae..768e6cf85 100644 --- a/nl-writer2/include/mp/nl-feeder2.h +++ b/nl-writer2/include/mp/nl-feeder2.h @@ -58,28 +58,30 @@ namespace mp { /** \rst - NLFeeder2: writes model details on request - via provided callback objects. - See the examples folder. + NLFeeder2: writes model details on request + via provided callback objects. + See the examples folder. - For the NL format, variables and constraints must have certain order. + For the NL format, variables and constraints must have certain order. - **Variable ordering:** - first continuous, then integer. - Some solvers might require more elaborate ordering, see NLHeader. + **Variable ordering:** + first continuous, then integer. + Some solvers might require more elaborate ordering, see NLHeader. - **Constraint ordering:** - first algebraic (including complementarity), then logical. - Some solvers might require nonlinear constraints first. + **Constraint ordering:** + first algebraic (including complementarity), then logical. + Some solvers might require nonlinear constraints first. - `~mp::NLFeeder2` can be used as a base class for other feeders, - or just be an interface example. + `~mp::NLFeeder2` can be used as a base class for other feeders + (see `ExampleNLFeeder2`), + or just be an interface prototype. Also subclassed + in the C API implementation class `~mp::NLFeeder2_C_Impl`. - @param: *Impl* is a type derived from `~mp::NLFeeder`. + @param: *Impl* is a type derived from `~mp::NLFeeder2`. - @param: *ExprType* is a type storing expressions from - methods such as `~mp::NLFeeder2::FeedExpr`. If not used, - it can be any default-constructible type. + @param: *ExprType* is a type storing expressions from + methods such as `~mp::NLFeeder2::FeedExpr`. If not used, + it can be any default-constructible type. \endrst */ template diff --git a/nl-writer2/include/mp/sol-handler2.h b/nl-writer2/include/mp/sol-handler2.h index d0fd0bc57..a256406a9 100644 --- a/nl-writer2/include/mp/sol-handler2.h +++ b/nl-writer2/include/mp/sol-handler2.h @@ -55,13 +55,12 @@ namespace mp { /** \rst - SOLHandler2: reads solution details on request - via provided callback objects. - See the examples folder. - - `~mp::SOLHandler2` can be used as a base class for other handlers, - or just be an interface prototype. + SOLHandler2: reads solution details on request + via provided callback objects. + See the examples folder. + `~mp::SOLHandler2` can be used as a base class for other handlers, + or just be an interface prototype. \endrst */ class SOLHandler2 {