[PATCH]: libpayload: Document readline

No code changes.

Signed-off-by: Jordan Crouse <jordan.crouse@amd.com>
Acked-by: Jordan Crouse <jordan.crouse@amd.com>


git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3550 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

1 files changed, 3 insertions, 0 deletions

diff --git a/payloads/libpayload/include/libpayload.h b/payloads/libpayload/include/libpayload.h
index 8ec052cbec..3351fd4927 100644
--- a/payloads/libpayload/include/libpayload.h
+++ b/payloads/libpayload/include/libpayload.h
@@ -418,6 +418,9 @@ void fatal(const char* msg) __attribute__ ((noreturn));
 
 /**
  * @defgroup readline Readline Functions
+ * This interface provides a simple implementation of the standard
+ * readline and getline functions.  They are suitable for reading a
+ * line of input from the console.
  * @{
  */
 char * readline(const char * prompt);