From d32976c65c5cac0dafa83a132322a5a1152f03c5 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 13 Oct 2008 03:55:47 +0000
Subject: More Doxygen comments from InSiTo

---
 src/core/libstate/init.h | 88 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 81 insertions(+), 7 deletions(-)

(limited to 'src/core')

diff --git a/src/core/libstate/init.h b/src/core/libstate/init.h
index f4296a868..86ef09bac 100644
--- a/src/core/libstate/init.h
+++ b/src/core/libstate/init.h
@@ -12,26 +12,87 @@
 
 namespace Botan {
 
-/*************************************************
-* Options for initializing the library           *
-*************************************************/
+/**
+* This class represents options for initializing the library.
+*/
 class BOTAN_DLL InitializerOptions
    {
    public:
+      /**
+      * Check whether this set of options has thread safety enabled.
+      * @return true if thread safety is enabled
+      */
       bool thread_safe() const;
+
+      /**
+      * Check whether this set of options has the usage of alternative engines
+      * enabled.
+      * @return true if the usage of alternative engines
+      * is enabled
+      */
       bool use_engines() const;
+
+      /**
+      * Check whether this set of options has enabled the seeding of the
+      * global RNG at startup.
+      * @return true if the seeding at startup is enabled
+      */
+      bool seed_rng() const;
+
+      /**
+      * Check whether this set of options has enabled the memory
+      * locking feature. This is implemented for Unix and Win32, but
+      * it only reliably works for Unix. There, all SecureVectors and
+      * SecureBuffers are kept from being ever swapped to disk. On
+      * Win32 plattforms, the corresponding pages are locked into the
+      * working set of the process, reducing the chance of being
+      * swapped to disk, but not strictly preventing it.
+      * @return true if the memory locking feature is enabled
+      */
       bool secure_memory() const;
+
+      /**
+      * Check whether this set of options has the self-test-at-startup
+      * enabled.  Same as self_test().
+      * @param return true if the self-test is enabled
+      */
       bool fips_mode() const;
+
+      /**
+      * Check whether this set of options has the self-test-at-startup enabled.
+      * Same as fips_mode().
+      * @param return true if the self-test is enabled
+      */
       bool self_test() const;
 
-      InitializerOptions(const std::string&);
+      /**
+      * Get the full path of the configuration file to be used.
+      */
+      std::string config_file() const;
+
+      /**
+      * Create an initializer options object. The option are set based on the
+      * input string. The options can be set by building a white space separated
+      * list of elements out of the
+      * following set of strings:
+      * "config=<file name>",
+      * "selftest",
+      * "fips140",
+      * "seed_rng",
+      * "use_engines",
+      * "secure_memory",
+      * "thread_safe"
+      *
+      */
+      InitializerOptions(const std::string& options);
    private:
       std::map<std::string, std::string> args;
    };
 
-/*************************************************
-* Library Initialization/Shutdown Object         *
-*************************************************/
+/**
+* This class represents the Library Initialization/Shutdown Object. It has to 
+* exceed the lifetime of any Botan object used in an application.
+*/
 class BOTAN_DLL LibraryInitializer
    {
    public:
@@ -40,8 +101,21 @@ class BOTAN_DLL LibraryInitializer
       static void initialize(const InitializerOptions&, class Modules&);
       static void deinitialize();
 
+      /**
+      * Construct a library initializer from a string. Does exactly the same
+      * as if an InitializerOptions object created with that string was used as
+      * the argument.
+      * @param args the string determining the desired library configuration
+      */
       LibraryInitializer(const std::string& args = "") { initialize(args); }
+
+      /**
+      * Construct a library initializer.
+      * @param args the initializer option object specifying the desired
+      * library configuration
+      */
       LibraryInitializer(const InitializerOptions& args) { initialize(args); }
+
       ~LibraryInitializer() { deinitialize(); }
    };
 
-- 
cgit v1.2.3