summaryrefslogtreecommitdiff
path: root/payloads/libpayload/include
diff options
context:
space:
mode:
authorJordan Crouse <jordan.crouse@amd.com>2008-08-28 23:11:29 +0000
committerJordan Crouse <jordan.crouse@amd.com>2008-08-28 23:11:29 +0000
commit617120c8284c2abd054600207bd858a04d19b34d (patch)
tree87f4b86f3641aca0b5703a35fd9fe32b39cfa5e5 /payloads/libpayload/include
parente2ad80628581273558b59ea70d8e155ba567f76b (diff)
downloadcoreboot-617120c8284c2abd054600207bd858a04d19b34d.tar.xz
[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
Diffstat (limited to 'payloads/libpayload/include')
-rw-r--r--payloads/libpayload/include/libpayload.h3
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);