aboutsummaryrefslogtreecommitdiffstats
path: root/src/libstate
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-16 00:52:24 +0000
committerlloyd <[email protected]>2010-06-16 00:52:24 +0000
commitecb574d32f4382326e94ad19e9d5baecc84a3c29 (patch)
tree55e98453b046e8553bc21fc2153939032718bbec /src/libstate
parentb1405ff3191a4343d098c513af157d831723b92d (diff)
More Doxygen comments
Diffstat (limited to 'src/libstate')
-rw-r--r--src/libstate/init.h7
-rw-r--r--src/libstate/libstate.h3
2 files changed, 10 insertions, 0 deletions
diff --git a/src/libstate/init.h b/src/libstate/init.h
index 4c4a09d1f..2d70e4370 100644
--- a/src/libstate/init.h
+++ b/src/libstate/init.h
@@ -22,8 +22,15 @@ namespace Botan {
class BOTAN_DLL LibraryInitializer
{
public:
+ /**
+ * Initialize the library
+ * @param options a string listing initialization options
+ */
static void initialize(const std::string& options = "");
+ /**
+ * Shutdown the library
+ */
static void deinitialize();
/**
diff --git a/src/libstate/libstate.h b/src/libstate/libstate.h
index 058b70e74..d7fb6e02c 100644
--- a/src/libstate/libstate.h
+++ b/src/libstate/libstate.h
@@ -29,6 +29,9 @@ class BOTAN_DLL Library_State
Library_State();
~Library_State();
+ /**
+ * @param thread_safe should a mutex be used for serialization
+ */
void initialize(bool thread_safe);
/**