aboutsummaryrefslogtreecommitdiffstats
path: root/crypto/ui
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2015-01-16 09:21:50 +0000
committerMatt Caswell <matt@openssl.org>2015-01-22 09:19:59 +0000
commitc80fd6b215449f2ba7228af58979ac8709f74b82 (patch)
tree0269f83aff238ce66c2839e2a52c237caaa37ec3 /crypto/ui
parent4b618848f9beb8271f24883694e097caa70013c0 (diff)
downloadopenssl-c80fd6b215449f2ba7228af58979ac8709f74b82.tar.gz
Further comment changes for reformat (master)
Reviewed-by: Tim Hudson <tjh@openssl.org>
Diffstat (limited to 'crypto/ui')
-rw-r--r--crypto/ui/ui.h50
1 files changed, 26 insertions, 24 deletions
diff --git a/crypto/ui/ui.h b/crypto/ui/ui.h
index f23ae16d38..ffd72ef029 100644
--- a/crypto/ui/ui.h
+++ b/crypto/ui/ui.h
@@ -157,34 +157,36 @@ int UI_dup_error_string(UI *ui, const char *text);
might get confused. */
#define UI_INPUT_FLAG_DEFAULT_PWD 0x02
-/* The user of these routines may want to define flags of their own. The core
- UI won't look at those, but will pass them on to the method routines. They
- must use higher bits so they don't get confused with the UI bits above.
- UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good
- example of use is this:
-
- #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE)
-
+/*-
+ * The user of these routines may want to define flags of their own. The core
+ * UI won't look at those, but will pass them on to the method routines. They
+ * must use higher bits so they don't get confused with the UI bits above.
+ * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good
+ * example of use is this:
+ *
+ * #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE)
+ *
*/
#define UI_INPUT_FLAG_USER_BASE 16
-/* The following function helps construct a prompt. object_desc is a
- textual short description of the object, for example "pass phrase",
- and object_name is the name of the object (might be a card name or
- a file name.
- The returned string shall always be allocated on the heap with
- OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
-
- If the ui_method doesn't contain a pointer to a user-defined prompt
- constructor, a default string is built, looking like this:
-
- "Enter {object_desc} for {object_name}:"
-
- So, if object_desc has the value "pass phrase" and object_name has
- the value "foo.key", the resulting string is:
-
- "Enter pass phrase for foo.key:"
+/*-
+ * The following function helps construct a prompt. object_desc is a
+ * textual short description of the object, for example "pass phrase",
+ * and object_name is the name of the object (might be a card name or
+ * a file name.
+ * The returned string shall always be allocated on the heap with
+ * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
+ *
+ * If the ui_method doesn't contain a pointer to a user-defined prompt
+ * constructor, a default string is built, looking like this:
+ *
+ * "Enter {object_desc} for {object_name}:"
+ *
+ * So, if object_desc has the value "pass phrase" and object_name has
+ * the value "foo.key", the resulting string is:
+ *
+ * "Enter pass phrase for foo.key:"
*/
char *UI_construct_prompt(UI *ui_method,
const char *object_desc, const char *object_name);