aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/base/scan_name.h
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-07 12:01:07 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-11 11:22:04 +0200
commitb2b7909709f281b178e3a1141c9db6fea049f8db (patch)
treeddd4bf26d881b69b7371a4b757f701ecde13dd48 /src/lib/base/scan_name.h
parente402cbacbb08784753772dba9ee5e48f9d64d71e (diff)
Improve base doxygen [ci skip]
Diffstat (limited to 'src/lib/base/scan_name.h')
-rw-r--r--src/lib/base/scan_name.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/base/scan_name.h b/src/lib/base/scan_name.h
index d59d5889e..c19bbf50f 100644
--- a/src/lib/base/scan_name.h
+++ b/src/lib/base/scan_name.h
@@ -24,17 +24,21 @@ class BOTAN_DLL SCAN_Name
{
public:
/**
+ * Create a SCAN_Name
* @param algo_spec A SCAN-format name
*/
explicit SCAN_Name(const char* algo_spec);
/**
+ * Create a SCAN_Name
* @param algo_spec A SCAN-format name
*/
explicit SCAN_Name(std::string algo_spec);
/**
+ * Create a SCAN_Name
* @param algo_spec A SCAN-format name
+ * @param extra An extra string appended to the algorithm name
*/
SCAN_Name(std::string algo_spec, const std::string& extra);
@@ -103,8 +107,14 @@ class BOTAN_DLL SCAN_Name
std::string cipher_mode_pad() const
{ return (m_mode_info.size() >= 2) ? m_mode_info[1] : ""; }
+ /*
+ * FIXME add doc
+ */
static void add_alias(const std::string& alias, const std::string& basename);
+ /*
+ * FIXME add doc
+ */
static std::string deref_alias(const std::string& alias);
private:
static std::mutex g_alias_map_mutex;