aboutsummaryrefslogtreecommitdiffstats
path: root/src/libstate/scan_name.h
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-16 04:03:10 +0000
committerlloyd <[email protected]>2010-06-16 04:03:10 +0000
commitbfb119cc85776d38ee728d320605abcb3e52448e (patch)
treec9106b742ac4da5b1b43e0de0ed203d9496da468 /src/libstate/scan_name.h
parentd066bf6897906ae634f381ddf3250d2ae56f238b (diff)
Replace "@return a blah" and "@return the blah" with just "@return blah"
Diffstat (limited to 'src/libstate/scan_name.h')
-rw-r--r--src/libstate/scan_name.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/libstate/scan_name.h b/src/libstate/scan_name.h
index 49c3d3765..3d11d54f6 100644
--- a/src/libstate/scan_name.h
+++ b/src/libstate/scan_name.h
@@ -28,22 +28,22 @@ class BOTAN_DLL SCAN_Name
SCAN_Name(std::string algo_spec);
/**
- * @return the original input string
+ * @return original input string
*/
std::string as_string() const { return orig_algo_spec; }
/**
- * @return the algorithm name
+ * @return algorithm name
*/
std::string algo_name() const { return alg_name; }
/**
- * @return the algorithm name plus any arguments
+ * @return algorithm name plus any arguments
*/
std::string algo_name_and_args() const;
/**
- * @return the number of arguments
+ * @return number of arguments
*/
u32bit arg_count() const { return args.size(); }
@@ -57,32 +57,32 @@ class BOTAN_DLL SCAN_Name
/**
* @param i which argument
- * @return the ith argument
+ * @return ith argument
*/
std::string arg(u32bit i) const;
/**
* @param i which argument
* @param def_value the default value
- * @return the ith argument or the default value
+ * @return ith argument or the default value
*/
std::string arg(u32bit i, const std::string& def_value) const;
/**
* @param i which argument
* @param def_value the default value
- * @return the ith argument as a u32bit, or the default value
+ * @return ith argument as a u32bit, or the default value
*/
u32bit arg_as_u32bit(u32bit i, u32bit def_value) const;
/**
- * @return the cipher mode (if any)
+ * @return cipher mode (if any)
*/
std::string cipher_mode() const
{ return (mode_info.size() >= 1) ? mode_info[0] : ""; }
/**
- * @return the cipher mode padding (if any)
+ * @return cipher mode padding (if any)
*/
std::string cipher_mode_pad() const
{ return (mode_info.size() >= 2) ? mode_info[1] : ""; }