doxygen cleanup

This commit is contained in:
Corentin Le Molgat
2023-10-27 10:15:27 +02:00
parent e1882d0843
commit 5b50f67ed0
3 changed files with 49 additions and 4 deletions

View File

@@ -11,7 +11,7 @@ This repository contains several component:
@li @ref ortools/algorithms "Algorithms"
@li @ref ortools/graph "Graph"
@li @ref ortools/linear_solver "Linear Solver"
@li @ref ortools/math_opt "Math Opt" (Bazel only)
@li @ref ortools/math_opt "Math Opt"
@li @ref ortools/glop "GLOP"
@li @ref ortools/sat "SAT"
@li @ref ortools/pdlp "PDLP"

View File

@@ -299,7 +299,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = YES
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
@@ -917,8 +917,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @PROJECT_BINARY_DIR@/python/ortools
# @PROJECT_SOURCE_DIR@/ortools \
INPUT = @PROJECT_BINARY_DIR@/python/ortools \
@PROJECT_SOURCE_DIR@/ortools/python/main.python.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -996,6 +996,7 @@ EXCLUDE_PATTERNS = *Test.java \
*/cpp/* \
*/csharp/* \
*/dotnet/* \
*/go/* \
*/java/* \
*/samples/* \
*/SWIGTYPE* \

View File

@@ -8,4 +8,48 @@ This is the reference documentation for the Google OR-Tools Python wrappers.
This repository contains several components:
Link with the C++ layer
@li @ref ortools.init.python.init,
Knapsack solver
@li @ref ortools.algorithms.python.knapsack_solver,
Graph and flow algorithms
@li @ref ortools.graph.python.linear_sum_assignment,
@li @ref ortools.graph.python.max_flow,
@li @ref ortools.graph.python.min_cost_flow,
Routing library and legacy Constraint Programming Solver
@li @ref ortools.constraint_solver.pywrapcp,
Minimalistic linear solver wrapper
@li @ref ortools.linear_solver.python.model_builder
CP-SAT
@li @ref ortools.sat.python.cp_model,
@li @ref ortools.util.python.sorted_interval_list,
@li @ref ortools.sat.cp_model_pb2
@li @ref ortools.sat.sat_parameters_pb2
Legacy linear solver wrapper
@li @ref ortools.linear_solver.pywraplp,
@li @ref ortools.linear_solver.linear_solver_pb2,
Linear solver backends
@li @ref ortools.bop.bop_parameters_pb2,
@li @ref ortools.glop.parameters_pb2,
@li @ref ortools.pdlp,
PSPLIB Parser
@li @ref ortools.scheduling.python.rcpsp
*/