From 617120c8284c2abd054600207bd858a04d19b34d Mon Sep 17 00:00:00 2001 From: Jordan Crouse Date: Thu, 28 Aug 2008 23:11:29 +0000 Subject: [PATCH]: libpayload: Document readline No code changes. Signed-off-by: Jordan Crouse Acked-by: Jordan Crouse git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3550 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1 --- payloads/libpayload/include/libpayload.h | 3 +++ 1 file changed, 3 insertions(+) (limited to 'payloads/libpayload/include') 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); -- cgit v1.2.3