summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Goodliffe <dan@randomdan.homeip.net>2015-09-26 01:23:34 +0100
committerDan Goodliffe <dan@randomdan.homeip.net>2015-09-26 01:23:34 +0100
commit1ffa9bd5295511df5390925180865f31afcb3e97 (patch)
tree9578ffec5e955b455ae4ec4e7047033806b4002b
parentInstantiate the right plug-in type for factories (diff)
downloadlibadhocutil-1ffa9bd5295511df5390925180865f31afcb3e97.tar.bz2
libadhocutil-1ffa9bd5295511df5390925180865f31afcb3e97.tar.xz
libadhocutil-1ffa9bd5295511df5390925180865f31afcb3e97.zip
Update documentation
-rw-r--r--libadhocutil/Doxyfile2
-rw-r--r--libadhocutil/plugins.h4
2 files changed, 4 insertions, 2 deletions
diff --git a/libadhocutil/Doxyfile b/libadhocutil/Doxyfile
index a95dcca..98fa3ed 100644
--- a/libadhocutil/Doxyfile
+++ b/libadhocutil/Doxyfile
@@ -114,7 +114,7 @@ INPUT = .
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h
RECURSIVE = YES
-EXCLUDE = bin
+EXCLUDE = bin unittests
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
diff --git a/libadhocutil/plugins.h b/libadhocutil/plugins.h
index 03d59fb..4e81b62 100644
--- a/libadhocutil/plugins.h
+++ b/libadhocutil/plugins.h
@@ -90,6 +90,8 @@ namespace AdHoc {
/// Container for loaded plugins.
class DLL_PUBLIC PluginManager {
public:
+ /// Callback definition to resolve a plugin type and name to a potential library
+ /// containing an implementation.
typedef boost::function<boost::optional<std::string> (const std::type_info &, const std::string &)> PluginResolver;
PluginManager();
@@ -158,7 +160,7 @@ namespace AdHoc {
/**
* Remove a type plugin resolver function.
- * @param f The resolver type.
+ * @param t The resolver type.
*/
void removeResolver(const std::type_info & t);