Changeset 550af2b in mainline

Timestamp:

2012-07-10T12:40:50Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

f4a8734

Parents:

aca4a04

Message:

Add missing documentation

File:

• kernel/generic/src/console/prompt.c (modified) (2 diffs)

kernel/generic/src/console/prompt.c

@@ -39 +39 @@
 #include <console/prompt.h>
 
+/** Display the <i>display all possibilities</i> prompt and wait for answer.
+ *
+ * @param indev Where to read characters from.
+ * @param hints Number of hints that would be displayed.
+ * @return Whether to print all hints.
+ */
 bool console_prompt_display_all_hints(indev_t *indev, size_t hints)
 {
@@ -58 +64 @@
 }
 
+/** Display the <i>--more--</i> prompt and wait for answer.
+ *
+ * When the function returns false, @p display_hints is set to zero.
+ *
+ * @param[in] indev Where to read characters from.
+ * @param[out] display_hints How many hints to display.
+ * @return Whether to display more hints.
+ */
 bool console_prompt_more_hints(indev_t *indev, size_t *display_hints)
 {