From e2a2295fb4bfda21ddb44a004280ab6913dbd9e9 Mon Sep 17 00:00:00 2001 From: Mizux Seiha Date: Tue, 8 Jul 2025 13:45:24 +0200 Subject: [PATCH] doxygen: update docs --- cmake/dotnet.cmake | 1 + cmake/java.cmake | 1 + cmake/python.cmake | 1 + ortools/cpp/main.cpp.dox.in | 2 +- ortools/dotnet/Doxyfile.in | 4 ++-- ortools/dotnet/main.dotnet.dox | 2 +- ortools/java/Doxyfile.in | 4 ++-- ortools/java/main.java.dox | 2 +- ortools/python/Doxyfile.in | 4 ++-- ortools/python/main.python.dox | 2 +- 10 files changed, 13 insertions(+), 10 deletions(-) diff --git a/cmake/dotnet.cmake b/cmake/dotnet.cmake index e241e01c26..06b23c8862 100644 --- a/cmake/dotnet.cmake +++ b/cmake/dotnet.cmake @@ -521,6 +521,7 @@ if(BUILD_DOTNET_DOC) ${PROJECT_BINARY_DIR}/dotnet/Doxyfile ${PROJECT_BINARY_DIR}/dotnet/doxygen-awesome.css ${PROJECT_SOURCE_DIR}/ortools/doxygen/header.html + ${PROJECT_SOURCE_DIR}/ortools/doxygen/DoxygenLayout.xml ${PROJECT_SOURCE_DIR}/ortools/dotnet/stylesheet.css WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Generating .Net API documentation with Doxygen" diff --git a/cmake/java.cmake b/cmake/java.cmake index bd73e09dd2..6d74bc848c 100644 --- a/cmake/java.cmake +++ b/cmake/java.cmake @@ -583,6 +583,7 @@ if(BUILD_JAVA_DOC) ${PROJECT_BINARY_DIR}/java/Doxyfile ${PROJECT_BINARY_DIR}/java/doxygen-awesome.css ${PROJECT_SOURCE_DIR}/ortools/doxygen/header.html + ${PROJECT_SOURCE_DIR}/ortools/doxygen/DoxygenLayout.xml ${PROJECT_SOURCE_DIR}/ortools/java/stylesheet.css WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Generating Java API documentation with Doxygen" diff --git a/cmake/python.cmake b/cmake/python.cmake index b8eabc21c8..45c43f3ca7 100644 --- a/cmake/python.cmake +++ b/cmake/python.cmake @@ -879,6 +879,7 @@ if(BUILD_PYTHON_DOC) ${PROJECT_BINARY_DIR}/python/Doxyfile ${PROJECT_BINARY_DIR}/python/doxygen-awesome.css ${PROJECT_SOURCE_DIR}/ortools/doxygen/header.html + ${PROJECT_SOURCE_DIR}/ortools/doxygen/DoxygenLayout.xml ${PROJECT_SOURCE_DIR}/ortools/python/stylesheet.css WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Generating Python API documentation with Doxygen" diff --git a/ortools/cpp/main.cpp.dox.in b/ortools/cpp/main.cpp.dox.in index 5a02d927ba..3a857905f9 100644 --- a/ortools/cpp/main.cpp.dox.in +++ b/ortools/cpp/main.cpp.dox.in @@ -3,7 +3,7 @@ * @author Corentin "Mizux" Le Molgat */ -/*! @mainpage OR-Tools +/*! @mainpage OR-Tools C++ Reference This is the reference documentation for Google OR-Tools. This repository contains several components: diff --git a/ortools/dotnet/Doxyfile.in b/ortools/dotnet/Doxyfile.in index a137f56eef..0a7e7f3bcb 100644 --- a/ortools/dotnet/Doxyfile.in +++ b/ortools/dotnet/Doxyfile.in @@ -472,7 +472,7 @@ TYPEDEF_HIDES_STRUCT = NO # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. -LOOKUP_CACHE_SIZE = 0 +LOOKUP_CACHE_SIZE = 3 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of @@ -796,7 +796,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = ortools/doxygen/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib diff --git a/ortools/dotnet/main.dotnet.dox b/ortools/dotnet/main.dotnet.dox index e6022c0b73..c461226b5c 100644 --- a/ortools/dotnet/main.dotnet.dox +++ b/ortools/dotnet/main.dotnet.dox @@ -3,7 +3,7 @@ * @author Corentin "Mizux" Le Molgat */ -/*! @mainpage OR-Tools +/*! @mainpage OR-Tools .Net Reference This is the reference documentation for Google OR-Tools. This repository contains several component: diff --git a/ortools/java/Doxyfile.in b/ortools/java/Doxyfile.in index ff8544e977..2bab07c370 100644 --- a/ortools/java/Doxyfile.in +++ b/ortools/java/Doxyfile.in @@ -472,7 +472,7 @@ TYPEDEF_HIDES_STRUCT = NO # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. -LOOKUP_CACHE_SIZE = 0 +LOOKUP_CACHE_SIZE = 3 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of @@ -796,7 +796,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = ortools/doxygen/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib diff --git a/ortools/java/main.java.dox b/ortools/java/main.java.dox index 544be9711d..bec95e7adb 100644 --- a/ortools/java/main.java.dox +++ b/ortools/java/main.java.dox @@ -3,7 +3,7 @@ * @author Corentin "Mizux" Le Molgat */ -/*! @mainpage OR-Tools +/*! @mainpage OR-Tools Java Reference This is the reference documentation for the Google OR-Tools Java wrapper. This repository contains several components: diff --git a/ortools/python/Doxyfile.in b/ortools/python/Doxyfile.in index 48b3347927..9a39a266aa 100644 --- a/ortools/python/Doxyfile.in +++ b/ortools/python/Doxyfile.in @@ -472,7 +472,7 @@ TYPEDEF_HIDES_STRUCT = NO # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. -LOOKUP_CACHE_SIZE = 0 +LOOKUP_CACHE_SIZE = 3 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of @@ -796,7 +796,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = ortools/doxygen/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib diff --git a/ortools/python/main.python.dox b/ortools/python/main.python.dox index ec2ed2936f..d90db8b833 100644 --- a/ortools/python/main.python.dox +++ b/ortools/python/main.python.dox @@ -3,7 +3,7 @@ * @author Corentin "Mizux" Le Molgat */ -/*! @mainpage OR-Tools +/*! @mainpage OR-Tools Python Reference This is the reference documentation for the Google OR-Tools Python wrappers. This repository contains several components: