Browse Source

docs: Redo documentation for LUWRA_MEMBER

Ole 9 years ago
parent
commit
2f1ab60122
1 changed files with 4 additions and 0 deletions
  1. 4 0
      lib/luwra/generic.hpp

+ 4 - 0
lib/luwra/generic.hpp

@@ -60,6 +60,10 @@ LUWRA_NS_END
 #define LUWRA_WRAP(entity) \
 #define LUWRA_WRAP(entity) \
 	(&luwra::internal::GenericWrapper<decltype(&entity)>::template invoke<&entity>)
 	(&luwra::internal::GenericWrapper<decltype(&entity)>::template invoke<&entity>)
 
 
+/**
+ * Generate a user type member manifest. This is basically a type which can be constructed using a
+ * string and whatever `LUWRA_WRAP` produces. For example `std::pair<Pushable, Pushable>`.
+ */
 #define LUWRA_MEMBER(type, name) \
 #define LUWRA_MEMBER(type, name) \
 	{#name, LUWRA_WRAP(__LUWRA_NS_RESOLVE(type, name))}
 	{#name, LUWRA_WRAP(__LUWRA_NS_RESOLVE(type, name))}