Skip to content

Commit 232b803

Browse files
redboltzredboltz
committed
Merge branch 'redboltz-fix_doxygen_support'
2 parents dff7af2 + 10a315e commit 232b803

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+261
-5
lines changed

‎CMakeLists.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,8 @@ IF (DOXYGEN_FOUND)
218218
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
219219
COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.h" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
220220
COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc_c" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
221+
COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
222+
COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
221223
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = \"MessagePack for C\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
222224
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
223225
VERBATIM
@@ -227,6 +229,8 @@ IF (DOXYGEN_FOUND)
227229
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
228230
COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
229231
COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc_cpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
232+
COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
233+
COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
230234
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = \"MessagePack for C++\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
231235
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
232236
VERBATIM

‎erb/cpp03_define.hpp.erb‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@
4242
// MSGPACK_ADD_ENUM must be used in the global namespace.
4343
#define MSGPACK_ADD_ENUM(enum_name) \
4444
namespace msgpack { \
45+
/** @cond */ \
4546
MSGPACK_API_VERSION_NAMESPACE(v1) { \
47+
/** @endcond */ \
4648
namespace adaptor { \
4749
template<> \
4850
struct convert<enum_name> { \
@@ -73,18 +75,22 @@
7375
} \
7476
}; \
7577
} \
78+
/** @cond */ \
7679
} \
80+
/** @endcond */ \
7781
}
7882

7983
namespace msgpack {
84+
/// @cond
8085
MSGPACK_API_VERSION_NAMESPACE(v1) {
86+
/// @endcond
8187
namespace type {
8288

83-
89+
/// @cond
8490
<% GENERATION_LIMIT = 31 %>
8591
template <typename A0 = void<%1.upto(GENERATION_LIMIT+1) {|i|%>, typename A<%=i%> = void<%}%>>
8692
struct define;
87-
93+
/// @endcond
8894

8995
template <>
9096
struct define<> {
@@ -106,6 +112,8 @@ struct define<> {
106112
o->via.array.size = 0;
107113
}
108114
};
115+
116+
/// @cond
109117
<%0.upto(GENERATION_LIMIT) {|i|%>
110118
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
111119
struct define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
@@ -144,21 +152,27 @@ struct define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
144152
A<%=j%>& a<%=j%>;<%}%>
145153
};
146154
<%}%>
155+
/// @endcond
147156

148157
inline define<> make_define()
149158
{
150159
return define<>();
151160
}
161+
162+
/// @cond
152163
<%0.upto(GENERATION_LIMIT) {|i|%>
153164
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
154165
define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> make_define(A0& a0<%1.upto(i) {|j|%>, A<%=j%>& a<%=j%><%}%>)
155166
{
156167
return define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>(a0<%1.upto(i) {|j|%>, a<%=j%><%}%>);
157168
}
158169
<%}%>
170+
/// @endcond
159171

160172
} // namespace type
173+
/// @cond
161174
} // MSGPACK_API_VERSION_NAMESPACE(v1)
175+
/// @endcond
162176
} // namespace msgpack
163177

164178

‎erb/cpp03_msgpack_tuple.hpp.erb‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,20 @@
2424

2525
namespace msgpack {
2626

27+
/// @cond
2728
MSGPACK_API_VERSION_NAMESPACE(v1) {
29+
/// @endcond
2830

2931
namespace type {
3032

3133
// FIXME operator==
3234
// FIXME operator!=
3335
<% GENERATION_LIMIT = 31 %>
3436

37+
/// @cond
3538
template <typename A0 = void<%1.upto(GENERATION_LIMIT+1) {|i|%>, typename A<%=i%> = void<%}%>>
3639
struct tuple;
40+
/// @endcond
3741

3842
template <typename Tuple, int N>
3943
struct tuple_element;
@@ -68,6 +72,7 @@ struct tuple_type<const T&> {
6872
typedef const T& transparent_reference;
6973
};
7074

75+
/// @cond
7176
<%0.upto(GENERATION_LIMIT) {|i|%>
7277
<%0.upto(i) {|j|%>
7378
template <typename A0<%1.upto(i) {|k|%>, typename A<%=k%><%}%>>
@@ -92,13 +97,16 @@ private:
9297
};
9398
<%}%>
9499
<%}%>
100+
/// @endcond
95101

96102
template <>
97103
struct tuple<> {
98104
tuple() {}
99105
tuple(msgpack::object const& o) { o.convert(*this); }
100106
typedef tuple<> value_type;
101107
};
108+
109+
/// @cond
102110
<%0.upto(GENERATION_LIMIT) {|i|%>
103111
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
104112
struct tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
@@ -122,18 +130,22 @@ template <int N, typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
122130
inline typename type::const_tuple_element<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>, N>::const_reference get(type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> const& t)
123131
{ return t.template get<N>(); }
124132
<%}%>
133+
/// @endcond
125134

126135
inline tuple<> make_tuple()
127136
{
128137
return tuple<>();
129138
}
139+
140+
/// @cond
130141
<%0.upto(GENERATION_LIMIT) {|i|%>
131142
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
132143
inline tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> make_tuple(typename tuple_type<A0>::transparent_reference a0<%1.upto(i) {|j|%>, typename tuple_type<A<%=j%>>::transparent_reference a<%=j%><%}%>)
133144
{
134145
return tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>(a0<%1.upto(i) {|j|%>, a<%=j%><%}%>);
135146
}
136147
<%}%>
148+
/// @endcond
137149

138150
} // namespace type
139151

@@ -149,6 +161,7 @@ struct convert<type::tuple<> > {
149161
}
150162
};
151163

164+
/// @cond
152165
<%0.upto(GENERATION_LIMIT) {|i|%>
153166
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
154167
struct convert<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
@@ -164,6 +177,7 @@ struct convert<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
164177
}
165178
};
166179
<%}%>
180+
/// @endcond
167181

168182
template <>
169183
struct pack<type::tuple<> > {
@@ -176,6 +190,7 @@ struct pack<type::tuple<> > {
176190
}
177191
};
178192

193+
/// @cond
179194
<%0.upto(GENERATION_LIMIT) {|i|%>
180195
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
181196
struct pack<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
@@ -190,6 +205,7 @@ struct pack<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
190205
}
191206
};
192207
<%}%>
208+
/// @endcond
193209

194210
template <>
195211
struct object_with_zone<type::tuple<> > {
@@ -202,6 +218,7 @@ struct object_with_zone<type::tuple<> > {
202218
}
203219
};
204220

221+
/// @cond
205222
<%0.upto(GENERATION_LIMIT) {|i|%>
206223
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
207224
struct object_with_zone<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
@@ -216,10 +233,13 @@ struct object_with_zone<type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> > {
216233
}
217234
};
218235
<%}%>
236+
/// @endcond
219237

220238
} // namespace adaptor
221239

240+
/// @cond
222241
} // MSGPACK_API_VERSION_NAMESPACE(v1)
242+
/// @endcond
223243

224244
} // namespace msgpack
225245

‎erb/cpp03_zone.hpp.erb‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535
<% GENERATION_LIMIT = 15 %>
3636
namespace msgpack {
3737

38+
/// @cond
3839
MSGPACK_API_VERSION_NAMESPACE(v1) {
40+
/// @endcond
3941

4042
class zone {
4143
struct finalizer {
@@ -179,10 +181,12 @@ public:
179181
{
180182
::operator delete(p, place);
181183
}
184+
/// @cond
182185
<%0.upto(GENERATION_LIMIT) {|i|%>
183186
template <typename T<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
184187
T* allocate(<%=(1..i).map{|j|"A#{j} a#{j}"}.join(', ')%>);
185188
<%}%>
189+
/// @endcond
186190

187191
private:
188192
void undo_allocate(size_t size);
@@ -304,6 +308,7 @@ inline void zone::undo_allocate(size_t size)
304308
m_chunk_list.m_free += size;
305309
}
306310

311+
/// @cond
307312
<%0.upto(GENERATION_LIMIT) {|i|%>
308313
template <typename T<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
309314
T* zone::allocate(<%=(1..i).map{|j|"A#{j} a#{j}"}.join(', ')%>)
@@ -324,8 +329,11 @@ T* zone::allocate(<%=(1..i).map{|j|"A#{j} a#{j}"}.join(', ')%>)
324329
}
325330
}
326331
<%}%>
332+
/// @endcond
327333

334+
/// @cond
328335
} // MSGPACK_API_VERSION_NAMESPACE(v1)
336+
/// @endcond
329337

330338
} // namespace msgpack
331339

‎include/msgpack/adaptor/adaptor_base.hpp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@
2222

2323
namespace msgpack {
2424

25+
/// @cond
2526
MSGPACK_API_VERSION_NAMESPACE(v1) {
27+
/// @endcond
2628

2729
template <typename Stream>
2830
class packer;
@@ -80,7 +82,10 @@ void operator<< (msgpack::object::with_zone& o, T const& v) {
8082
adaptor::object_with_zone<T>()(o, v);
8183
}
8284

85+
/// @cond
8386
} // MSGPACK_API_VERSION_NAMESPACE(v1)
87+
/// @endcond
88+
8489
} // namespace msgpack
8590

8691

‎include/msgpack/adaptor/bool.hpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323

2424
namespace msgpack {
2525

26+
/// @cond
2627
MSGPACK_API_VERSION_NAMESPACE(v1) {
28+
/// @endcond
2729

2830
namespace adaptor {
2931

@@ -63,7 +65,9 @@ struct object_with_zone<bool> {
6365

6466
} // namespace adaptor
6567

68+
/// @cond
6669
} // MSGPACK_API_VERSION_NAMESPACE(v1)
70+
/// @endcond
6771

6872
} // namespace msgpack
6973

‎include/msgpack/adaptor/char_ptr.hpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626

2727
namespace msgpack {
2828

29+
/// @cond
2930
MSGPACK_API_VERSION_NAMESPACE(v1) {
31+
/// @endcond
3032

3133
namespace adaptor {
3234

@@ -154,7 +156,9 @@ struct object<const char[N]> {
154156

155157
} // namespace adaptor
156158

159+
/// @cond
157160
} // MSGPACK_API_VERSION_NAMESPACE(v1)
161+
/// @endcond
158162

159163
} // namespace msgpack
160164

‎include/msgpack/adaptor/check_container_size.hpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323

2424
namespace msgpack {
2525

26+
/// @cond
2627
MSGPACK_API_VERSION_NAMESPACE(v1) {
28+
/// @endcond
2729

2830
struct container_size_overflow : public std::runtime_error {
2931
explicit container_size_overflow(const std::string& msg)
@@ -54,7 +56,9 @@ inline uint32_t checked_get_container_size(T size) {
5456
}
5557

5658

59+
/// @cond
5760
} // MSGPACK_API_VERSION_NAMESPACE(v1)
61+
/// @endcond
5862

5963
} // namespace msgpack
6064

‎include/msgpack/adaptor/cpp11/array.hpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@
2727

2828
namespace msgpack {
2929

30+
/// @cond
3031
MSGPACK_API_VERSION_NAMESPACE(v1) {
32+
/// @endcond
3133

3234
namespace adaptor {
3335

@@ -80,7 +82,9 @@ struct object_with_zone<std::array<T, N>> {
8082

8183
} // namespace adaptor
8284

85+
/// @cond
8386
} // MSGPACK_API_VERSION_NAMESPACE(v1)
87+
/// @endcond
8488

8589
} // namespace msgpack
8690

‎include/msgpack/adaptor/cpp11/array_char.hpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626

2727
namespace msgpack {
2828

29+
/// @cond
2930
MSGPACK_API_VERSION_NAMESPACE(v1) {
31+
/// @endcond
3032

3133
namespace adaptor {
3234

@@ -86,7 +88,9 @@ struct object_with_zone<std::array<char, N>> {
8688

8789
} // namespace adaptor
8890

91+
/// @cond
8992
} // MSGPACK_API_VERSION_NAMESPACE(v1)
93+
/// @endcond
9094

9195
} // namespace msgpack
9296

0 commit comments

Comments
 (0)