diff options
author | Marco Poletti <poletti.marco@gmail.com> | 2017-08-06 12:12:21 +0100 |
---|---|---|
committer | Marco Poletti <poletti.marco@gmail.com> | 2017-08-06 12:12:21 +0100 |
commit | 735f047076e1a55bb13dd45fdbe62a8f4f106d5a (patch) | |
tree | 56cff89742f9bcf219af626f621a077694a5164d /include/fruit/fruit_forward_decls.h | |
parent | d9a2e98a6e0fd2a6556e8da2a6b265db27d4b746 (diff) | |
download | google-fruit-735f047076e1a55bb13dd45fdbe62a8f4f106d5a.tar.gz |
Various improvements to the Doxygen documentation on Fruit classes and their public methods.
Diffstat (limited to 'include/fruit/fruit_forward_decls.h')
-rw-r--r-- | include/fruit/fruit_forward_decls.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/include/fruit/fruit_forward_decls.h b/include/fruit/fruit_forward_decls.h index e6056b3..e5d0e61 100644 --- a/include/fruit/fruit_forward_decls.h +++ b/include/fruit/fruit_forward_decls.h @@ -22,17 +22,24 @@ namespace fruit { -// Used to group the requirements of Component. See Component for details. -// Note: this type is never defined, that's by design since instances of this type are not meaningful. +/** + * This is used to group the requirements of Component. See Component for details. + * Note: this type is declared but not defined; that's by design since instances of this type are not meaningful. + */ template <typename... Types> struct Required; -// Used to annotate T as a type that uses assisted injection. See PartialComponent for details. -// Note: this type is never defined, that's by design since objects of this type are not meaningful. +/** + * This is used to "annotate" T as a type that uses assisted injection. See PartialComponent for details. + * Note: this type is declared but not defined; that's by design since instances of this type are not meaningful. + */ template <typename T> struct Assisted; -// Used to annotate T (for annotated injection). See PartialComponent for details. +/** + * This is used to annotate T as a type that will be user-supplied instead of being injected. + * See PartialComponent::registerFactory for details. + */ template <typename Annotation, typename T> struct Annotated {}; |