eina_js: Fix documentation generation
authorStefan Schmidt <stefan@osg.samsung.com>
Tue, 5 Jan 2016 16:09:31 +0000 (17:09 +0100)
committerStefan Schmidt <stefan@osg.samsung.com>
Tue, 5 Jan 2016 16:28:29 +0000 (17:28 +0100)
Summary:
Fix doxygen's documentation generation.
A bug in doxygen makes it fail with the _libv8_property_callback_info_test
class.
We put a #ifndef EFL_DOXYGEN around it to avoid it being seen by doxygen.

Add a NOTE comment about this.

ref T3005

@fix

Test Plan: make doc must succeed

Reviewers: felipealmeida, stefan_schmidt

Projects: #efl

Differential Revision: https://phab.enlightenment.org/D3534

src/bindings/js/eina_js/eina_js_compatibility.hh

index 9ef0cb8..159c74a 100644 (file)
@@ -316,13 +316,17 @@ struct _libv8_callback_info_test
 {
 };
 
+// NOTE: ifndef needed because a bug in doxygen makes it fail with this class
+#ifndef EFL_DOXYGEN
 template <typename T = v8::ObjectTemplate, typename Enable = void>
 struct _libv8_property_callback_info_test
   : std::true_type {};
+#endif
 
 typedef v8::Handle<v8::Value>(*_libv8_getter_callback)(v8::Local<v8::String>, v8::AccessorInfo const&);
 typedef void(*_libv8_setter_callback)(v8::Local<v8::String>, v8::Local<v8::Value>, v8::AccessorInfo const&);
 
+#ifndef EFL_DOXYGEN
 template <typename T>
 struct _libv8_property_callback_info_test
 <T, typename std::enable_if
@@ -339,6 +343,7 @@ struct _libv8_property_callback_info_test
   : std::false_type
 {
 };
+#endif
 
 static constexpr bool const v8_uses_isolate = _libv8_isolate_test<>::value;
 static constexpr bool const v8_uses_callback_info = _libv8_callback_info_test<>::value;