Skip to content

Commit ae5734e

Browse files
redboltzredboltz
committed
Recovered a minimal support for Doxygen.
Removed MSGPACK_API_VERSION_NAMESPACE(v1) from doxygen build. It seems that Doxygen cannot parse a complicated macro such as MSGPACK_API_VERSION_NAMESPACE. Added EXTRACT_ALL=YES to Doxyfle. Added INPUT configuration variable that is point to include directory to Doxyfile.
1 parent 6ec0905 commit ae5734e

Some content is hidden

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

73 files changed

+398
-4
lines changed

‎CMakeLists.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,8 @@ IF (DOXYGEN_FOUND)
245245
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
246246
COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.h" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
247247
COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc_c" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
248+
COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
249+
COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
248250
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = \"MessagePack for C\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
249251
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_c
250252
VERBATIM
@@ -254,6 +256,8 @@ IF (DOXYGEN_FOUND)
254256
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
255257
COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
256258
COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc_cpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
259+
COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
260+
COMMAND ${CMAKE_COMMAND} -E echo "EXTRACT_ALL = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
257261
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = \"MessagePack for C++\"" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
258262
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_cpp
259263
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) \
4444
namespace msgpack { \
45+
/** @cond */ \
4546
MSGPACK_API_VERSION_NAMESPACE(v1) { \
47+
/** @endcond */ \
4648
inline msgpack::object const& operator>> (msgpack::object const& o, enum& v) \
4749
{ \
4850
int tmp; \
@@ -66,18 +68,22 @@
6668
} \
6769
}; \
6870
} \
71+
/** @cond */ \
6972
} \
73+
/** @endcond */ \
7074
}
7175

7276
namespace msgpack {
77+
/// @cond
7378
MSGPACK_API_VERSION_NAMESPACE(v1) {
79+
/// @endcond
7480
namespace type {
7581

76-
82+
/// @cond
7783
<% GENERATION_LIMIT = 31 %>
7884
template <typename A0 = void<%1.upto(GENERATION_LIMIT+1) {|i|%>, typename A<%=i%> = void<%}%>>
7985
struct define;
80-
86+
/// @endcond
8187

8288
template <>
8389
struct define<> {
@@ -99,6 +105,8 @@ struct define<> {
99105
o->via.array.size = 0;
100106
}
101107
};
108+
109+
/// @cond
102110
<%0.upto(GENERATION_LIMIT) {|i|%>
103111
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
104112
struct define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
@@ -137,21 +145,27 @@ struct define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
137145
A<%=j%>& a<%=j%>;<%}%>
138146
};
139147
<%}%>
148+
/// @endcond
140149

141150
inline define<> make_define()
142151
{
143152
return define<>();
144153
}
154+
155+
/// @cond
145156
<%0.upto(GENERATION_LIMIT) {|i|%>
146157
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
147158
define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> make_define(A0& a0<%1.upto(i) {|j|%>, A<%=j%>& a<%=j%><%}%>)
148159
{
149160
return define<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>(a0<%1.upto(i) {|j|%>, a<%=j%><%}%>);
150161
}
151162
<%}%>
163+
/// @endcond
152164

153165
} // namespace type
166+
/// @cond
154167
} // MSGPACK_API_VERSION_NAMESPACE(v1)
168+
/// @endcond
155169
} // namespace msgpack
156170

157171

‎erb/cpp03_msgpack_tuple.hpp.erb‎

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

2424
namespace msgpack {
2525

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

2830
namespace type {
2931

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

36+
/// @cond
3437
template <typename A0<%1.upto(GENERATION_LIMIT+1) {|i|%>, typename A<%=i%><%}%>>
3538
struct tuple;
39+
/// @endcond
3640

3741
template <typename Tuple, int N>
3842
struct tuple_element;
@@ -67,6 +71,7 @@ struct tuple_type<const T&> {
6771
typedef const T& transparent_reference;
6872
};
6973

74+
/// @cond
7075
<%0.upto(GENERATION_LIMIT) {|i|%>
7176
<%0.upto(i) {|j|%>
7277
template <typename A0<%1.upto(i) {|k|%>, typename A<%=k%><%}%>>
@@ -91,13 +96,16 @@ private:
9196
};
9297
<%}%>
9398
<%}%>
99+
/// @endcond
94100

95101
template <>
96102
struct tuple<> {
97103
tuple() {}
98104
tuple(msgpack::object const& o) { o.convert(*this); }
99105
typedef tuple<> value_type;
100106
};
107+
108+
/// @cond
101109
<%0.upto(GENERATION_LIMIT) {|i|%>
102110
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
103111
struct tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>> {
@@ -121,18 +129,22 @@ template <int N, typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
121129
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)
122130
{ return t.template get<N>(); }
123131
<%}%>
132+
/// @endcond
124133

125134
inline tuple<> make_tuple()
126135
{
127136
return tuple<>();
128137
}
138+
139+
/// @cond
129140
<%0.upto(GENERATION_LIMIT) {|i|%>
130141
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
131142
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%><%}%>)
132143
{
133144
return tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>(a0<%1.upto(i) {|j|%>, a<%=j%><%}%>);
134145
}
135146
<%}%>
147+
/// @endcond
136148

137149
} // namespace type
138150

@@ -142,6 +154,8 @@ inline msgpack::object const& operator>> (
142154
if(o.type != msgpack::type::ARRAY) { throw msgpack::type_error(); }
143155
return o;
144156
}
157+
158+
/// @cond
145159
<%0.upto(GENERATION_LIMIT) {|i|%>
146160
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
147161
inline msgpack::object const& operator>> (
@@ -154,6 +168,7 @@ inline msgpack::object const& operator>> (
154168
return o;
155169
}
156170
<%}%>
171+
/// @endcond
157172

158173
template <typename Stream>
159174
inline const msgpack::packer<Stream>& operator<< (
@@ -162,6 +177,8 @@ inline const msgpack::packer<Stream>& operator<< (
162177
o.pack_array(0);
163178
return o;
164179
}
180+
181+
/// @cond
165182
<%0.upto(GENERATION_LIMIT) {|i|%>
166183
template <typename Stream, typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
167184
inline const msgpack::packer<Stream>& operator<< (
@@ -173,6 +190,7 @@ inline const msgpack::packer<Stream>& operator<< (
173190
return o;
174191
}
175192
<%}%>
193+
/// @endcond
176194

177195
inline void operator<< (
178196
msgpack::object::with_zone& o,
@@ -181,6 +199,8 @@ inline void operator<< (
181199
o.via.array.ptr = nullptr;
182200
o.via.array.size = 0;
183201
}
202+
203+
/// @cond
184204
<%0.upto(GENERATION_LIMIT) {|i|%>
185205
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
186206
inline void operator<< (
@@ -193,8 +213,11 @@ inline void operator<< (
193213
o.via.array.ptr[<%=j%>] = msgpack::object(v.template get<<%=j%>>(), o.zone);<%}%>
194214
}
195215
<%}%>
216+
/// @endcond
196217

218+
/// @cond
197219
} // MSGPACK_API_VERSION_NAMESPACE(v1)
220+
/// @endcond
198221

199222
} // namespace msgpack
200223

‎erb/cpp03_msgpack_tuple_fwd.hpp.erb‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,20 @@
2323

2424
namespace msgpack {
2525

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

2830
namespace type {
2931

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

36+
/// @cond
3437
template <typename A0 = void<%1.upto(GENERATION_LIMIT+1) {|i|%>, typename A<%=i%> = void<%}%>>
3538
struct tuple;
39+
/// @endcond
3640

3741
template <typename Tuple, int N>
3842
struct tuple_element;
@@ -43,6 +47,7 @@ struct const_tuple_element;
4347
template <typename T>
4448
struct tuple_type;
4549

50+
/// @cond
4651
<%0.upto(GENERATION_LIMIT) {|i|%>
4752
<%0.upto(i) {|j|%>
4853
template <typename A0<%1.upto(i) {|k|%>, typename A<%=k%><%}%>>
@@ -56,9 +61,12 @@ template <typename A0<%1.upto(i) {|k|%>, typename A<%=k%><%}%>>
5661
struct const_tuple_element<tuple<A0<%1.upto(i) {|k|%>, A<%=k%><%}%>>, <%=j%>>;
5762
<%}%>
5863
<%}%>
64+
/// @endcond
5965

6066
template <>
6167
struct tuple<>;
68+
69+
/// @cond
6270
<%0.upto(GENERATION_LIMIT) {|i|%>
6371
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
6472
struct tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>;
@@ -74,43 +82,53 @@ tuple<> make_tuple();
7482
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
7583
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%><%}%>);
7684
<%}%>
85+
/// @endcond
7786

7887
} // namespace type
7988

8089
msgpack::object const& operator>> (
8190
msgpack::object const& o,
8291
type::tuple<>&);
8392

93+
/// @cond
8494
<%0.upto(GENERATION_LIMIT) {|i|%>
8595
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
8696
msgpack::object const& operator>> (
8797
msgpack::object const& o,
8898
type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>& v);
8999
<%}%>
100+
/// @endcond
90101

91102
template <typename Stream>
92103
const msgpack::packer<Stream>& operator<< (
93104
msgpack::packer<Stream>& o,
94105
const type::tuple<>&);
95106

107+
/// @cond
96108
<%0.upto(GENERATION_LIMIT) {|i|%>
97109
template <typename Stream, typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
98110
const msgpack::packer<Stream>& operator<< (
99111
msgpack::packer<Stream>& o,
100112
const type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>& v);
101113
<%}%>
114+
/// @endcond
102115

103116
void operator<< (
104117
msgpack::object::with_zone& o,
105118
const type::tuple<>&);
119+
120+
/// @cond
106121
<%0.upto(GENERATION_LIMIT) {|i|%>
107122
template <typename A0<%1.upto(i) {|j|%>, typename A<%=j%><%}%>>
108123
void operator<< (
109124
msgpack::object::with_zone& o,
110125
const type::tuple<A0<%1.upto(i) {|j|%>, A<%=j%><%}%>>& v);
111126
<%}%>
127+
/// @endcond
112128

129+
/// @cond
113130
} // MSGPACK_API_VERSION_NAMESPACE(v1)
131+
/// @endcond
114132

115133
} // namespace msgpack
116134

‎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/bool.hpp‎

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

2525
namespace msgpack {
2626

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

2931
inline msgpack::object const& operator>> (msgpack::object const& o, bool& v)
3032
{
@@ -51,7 +53,9 @@ inline void operator<< (msgpack::object::with_zone& o, bool v)
5153
{ static_cast<msgpack::object&>(o) << v; }
5254

5355

56+
/// @cond
5457
} // MSGPACK_API_VERSION_NAMESPACE(v1)
58+
/// @endcond
5559

5660
} // namespace msgpack
5761

‎include/msgpack/adaptor/bool_fwd.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
msgpack::object const& operator>> (msgpack::object const& o, bool& v);
2931
template <typename Stream>
@@ -32,7 +34,9 @@ void operator<< (msgpack::object& o, bool v);
3234
void operator<< (msgpack::object::with_zone& o, bool v);
3335

3436

37+
/// @cond
3538
} // MSGPACK_API_VERSION_NAMESPACE(v1)
39+
/// @endcond
3640

3741
} // namespace msgpack
3842

0 commit comments

Comments
 (0)