Fix NLWriter docu links #30

Also allow indexing of namespace mp::internal
ampl · Oct 26, 2023 · 771634b · 771634b
1 parent a4ff81d
commit 771634b
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 13 deletions.
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -18,9 +18,9 @@ message(STATUS
   "Set BUILD_DOC=off otherwise.")
 
 add_prefix(doc_deps ../
-  ${NLW2_DOC_SRC}
-  ${MP_ALL_HEADERS}
-  )
+  ${MP_ALL_HEADERS})
+
+set(doc_deps ${doc_deps} ${NLW2_SRC})
 
 set(DOC_BASEDIR ${CMAKE_CURRENT_SOURCE_DIR}/source/)
 set(DOC_OUTPUTDIR ${CMAKE_CURRENT_BINARY_DIR}/html/)

diff --git a/doc/source/Doxyfile b/doc/source/Doxyfile
@@ -3,7 +3,7 @@ GENERATE_LATEX   = NO
 GENERATE_MAN     = NO
 GENERATE_RTF     = NO
 CASE_SENSE_NAMES = NO
-INPUT            =  ../../include/mp
+INPUT            =  ../../include/mp  ../../nl-writer2
 QUIET            = NO
 JAVADOC_AUTOBRIEF = YES
 AUTOLINK_SUPPORT = YES
@@ -21,4 +21,4 @@ MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
 HIDE_FRIEND_COMPOUNDS  = YES
 PREDEFINED = __cplusplus 
-EXCLUDE_SYMBOLS =  mp::internal::* fmt::*
+EXCLUDE_SYMBOLS =  fmt::*
diff --git a/nl-writer2/CMakeLists.txt b/nl-writer2/CMakeLists.txt
@@ -43,12 +43,19 @@ set(NLSOL_EX_FILES
   ${NLW2_DIR}/examples/nlsol_ex_mdl.h
   ${NLW2_DIR}/examples/nlsol_ex_nl.h
   ${NLW2_DIR}/examples/nlsol_ex_sol.h)
-add_executable(nl-writer-example ${NLSOL_EX_FILES})
-target_include_directories(nl-writer-example PUBLIC
-            ${NLW2_DIR}/include)
-target_link_libraries(nl-writer-example ${NLW2_LIB_NAME})
 
+option(BUILD_EXAMPLES_NLW2
+  "Build NLW2 examples (library not affected)" ON)
+if (BUILD_EXAMPLES_NLW2)         # Actually build the example
+  add_executable(nl-writer-example ${NLSOL_EX_FILES})
+  target_include_directories(nl-writer-example PUBLIC
+    ${NLW2_DIR}/include)
+  target_link_libraries(nl-writer-example ${NLW2_LIB_NAME})
+endif()
+
+# Export library include path
+set(NLW2_INCLUDE_PATH ${NLW2_DIR}/include PARENT_SCOPE)
 # Export source files
-set(NLW2_DOC_SRC
+set(NLW2_SRC
   ${NLW2_LIB_FILES} ${NLW2_INC_FILES} ${NLSOL_EX_FILES}
   PARENT_SCOPE)
diff --git a/nl-writer2/include/mp/nl-writer2.h b/nl-writer2/include/mp/nl-writer2.h
@@ -91,9 +91,6 @@ inline WriteNLReport WriteNLFile(
 /// Write an NL file:
 ///    WriteNLFile(filenamebase, feeder, utils);
 ///
-/// Write an NL string:
-///    WriteNLString(string, feeder, utils);
-///
 /// where feeder is an object that provides information on model
 /// components. See NLFeeder2 for an interface of a feeder class.
 ///