Docu index: NLW2 C API #30

Manually citing major structs. Ideal would be automatic
ampl · Nov 30, 2023 · 4309b0c · 4309b0c
1 parent 35e5f1c
commit 4309b0c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/doc/source/components.rst b/doc/source/components.rst
@@ -155,9 +155,9 @@ NL component writer callbacks
 In turn, the library is flexible to use because
 various components of the user model will be provided
 on the library's request from a user-specialized
-NLFeeder2 object (for solution input,
+`~mp::NLFeeder2` object (for solution input,
 solution components will be received by methods
-of a custom SOLHandler2 class.)
+of a custom `~mp::SOLHandler2` class.)
 
 .. image:: images/NLWriter.svg
 
@@ -166,13 +166,13 @@ NL Writer APIs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - **NL Writer C++ API** is provided by classes
-  `mp::NLSOL`, `mp::NLFeeder2`, `mp::SOLHandler2`.
+  `~mp::NLSOL`, `~mp::NLFeeder2`, `~mp::SOLHandler2`.
   See
   `C++ API example </~https://github.com/ampl/mp/blob/develop/nl-writer2/examples/cpp/nlsol_ex.cc>`_
   solving a small non-linear model.
 
 - **NL Writer C API** is provided by structs
-  `NLW2_NLSOL_C`, `NLW2_NLFeeder2_C`, `NLW2_SOLHandler2_C`.
+  `~NLW2_NLSOL_C`, `~NLW2_NLFeeder2_C`, `~NLW2_SOLHandler2_C`.
   *Currently only linear models are supported.*
   See
   `C API example </~https://github.com/ampl/mp/blob/develop/nl-writer2/examples/c/nlsol_ex_c.c>`_

diff --git a/doc/source/details.rst b/doc/source/details.rst
@@ -40,3 +40,14 @@ Namespace fmt
    :members:
 
 
+C API
+-----------
+
+.. doxygenstruct:: NLW2_NLSOL_C
+   :members:
+
+.. doxygenstruct:: NLW2_NLFeeder2_C
+   :members:
+
+.. doxygenstruct:: NLW2_SOLHandler2_C
+   :members: