Skip to content

Commit

Permalink
Docu: full autodoc
Browse files Browse the repository at this point in the history
Use doxygenindex:: to include all C++ and C autodocs
  • Loading branch information
glebbelov committed Nov 30, 2023
1 parent 4309b0c commit c5bc35c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 41 deletions.
41 changes: 4 additions & 37 deletions doc/source/details.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,9 @@ See the :ref:`alphabetic index <genindex>`.
Alternatively, use the :ref:`search` or look below.


Namespace mp
------------
Autodoc
----------

.. doxygennamespace:: mp
:members:
.. doxygenindex::
:project: mp


Namespace mp::pre
-----------------

.. doxygennamespace:: mp::pre
:members:


Namespace mp::internal
----------------------

.. doxygennamespace:: mp::internal
:members:


Namespace fmt
-------------

.. doxygennamespace:: fmt
:members:


C API
-----------

.. doxygenstruct:: NLW2_NLSOL_C
:members:

.. doxygenstruct:: NLW2_NLFeeder2_C
:members:

.. doxygenstruct:: NLW2_SOLHandler2_C
:members:
6 changes: 3 additions & 3 deletions include/mp/flat/model_api_connect.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ namespace mp {
/// Currently is uses mp::Problem as intermediate storage
/// of the NL model.
///
/// @param Backend: the Backend class
/// @param ModelAPI: the ModelAPI class to be created and
/// @tparam Backend: the Backend class
/// @tparam ModelAPI: the ModelAPI class to be created and
/// used by the ModelManager
/// @param FlatConverter: the FlatConverter to be used
/// @tparam FlatConverter: the FlatConverter to be used
///
/// @param gc: Backend object
/// @param e: the MP environment
Expand Down
2 changes: 1 addition & 1 deletion include/mp/flat/problem_flattener.h
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ class ProblemFlattener :
/// Can produce a new variable/expression and specified constraints on it.
/// Produces a conditional linear/quadratic constraint
/// b==1 <=/=> c'x [+ x'Qx] <=/= d.
/// @param comp_kind: < (-2), <= (-1), == (0)
/// @tparam comp_kind: < (-2), <= (-1), == (0)
/// @param ea: array of 2 expressions (comparison arguments lhs, rhs)
template <int comp_kind, class ExprArray=std::initializer_list<Expr> >
EExpr VisitRelationalExpression(ExprArray ea) {
Expand Down

0 comments on commit c5bc35c

Please sign in to comment.