Skip to content

Commit 8e281f8

Browse files
committed
doxygen: improve
* stop transforming all // in doxygen comment /// since it doesn't work nicely with our code base, prefer to replace // by /// when needed.
1 parent c5392b6 commit 8e281f8

File tree

2 files changed

+54
-1
lines changed

2 files changed

+54
-1
lines changed

ortools/cpp/main.cpp.dox.in

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,59 @@
33
* @author Corentin "Mizux" Le Molgat <[email protected]>
44
*/
55

6+
// WARNING: must keep the empty line between example otherwise doxygen has an
7+
// undefined behaviour...
8+
9+
/// @namespace operations_research OR-Tools root namespace.
10+
11+
/// @example{lineno} tsp.cc
12+
/// Simple TSP example.
13+
14+
/// @example{lineno} tsp_circuit_board.cc
15+
/// Simple TSP example.
16+
17+
/// @example{lineno} tsp_cities.cc
18+
/// Simple TSP example.
19+
20+
/// @example{lineno} tsp_distance_matrix.cc
21+
/// Simple TSP example.
22+
23+
/// @example{lineno} vrp_capacity.cc
24+
/// Simple VRP example.
25+
26+
/// @example{lineno} vrp.cc
27+
/// Simple VRP example.
28+
29+
/// @example{lineno} vrp_drop_nodes.cc
30+
/// Simple VRP example.
31+
32+
/// @example{lineno} vrp_global_span.cc
33+
/// Simple VRP example.
34+
35+
/// @example{lineno} vrp_initial_routes.cc
36+
/// Simple VRP example.
37+
38+
/// @example{lineno} vrp_pickup_delivery.cc
39+
/// Simple VRP example.
40+
41+
/// @example{lineno} vrp_pickup_delivery_fifo.cc
42+
/// Simple VRP example.
43+
44+
/// @example{lineno} vrp_pickup_delivery_lifo.cc
45+
/// Simple VRP example.
46+
47+
/// @example{lineno} vrp_resources.cc
48+
/// Simple VRP example.
49+
50+
/// @example{lineno} vrp_starts_ends.cc
51+
/// Simple VRP example.
52+
53+
/// @example{lineno} vrp_time_windows.cc
54+
/// Simple VRP example.
55+
56+
/// @example{lineno} vrp_with_time_limit.cc
57+
/// Simple VRP example.
58+
659
/*! @mainpage OR-Tools C++ Reference
760
This is the reference documentation for Google OR-Tools.
861

tools/doc/doxygen_filter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def CompileExpressions(self):
9797
# Replace pipe-delimited parameter names with backtick-delimiters
9898
(re.compile(r"\|(\w+)\|"), r"`\1`", self.COMMENT),
9999
# Convert standalone comment lines to Doxygen style.
100-
(re.compile(r"(^\s*)//(?=[^/])"), r"\1///", self.ANYWHERE),
100+
#(re.compile(r"(^\s*)//(?=[^/])"), r"\1///", self.ANYWHERE),
101101
# Strip trailing comments from preprocessor directives.
102102
(re.compile(r"(^#.*)//.*"), r"\1", self.ANYWHERE),
103103
# Convert remaining trailing comments to doxygen style, unless they are

0 commit comments

Comments
 (0)