From 07ff8a6c03e9c232a285e8b4ebc22f11ae5963d7 Mon Sep 17 00:00:00 2001 From: axel Date: Sat, 17 Jun 2006 23:07:08 +1000 Subject: Documentation updates. Fixes a few formating bugs, adds various minor missing api documentation, fixes a few typos. Also fixes a few tiny code issues, mostly missing consts, etc darcs-hash:20060617130708-ac50b-cc2ec5aa3e4bfb8e28d7b86441bfb4661f1dd7e7.gz --- builtin.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'builtin.h') diff --git a/builtin.h b/builtin.h index 511a046b..bd99808a 100644 --- a/builtin.h +++ b/builtin.h @@ -62,6 +62,9 @@ enum */ #define BUILTIN_FOR_ERR_IN _( L"%ls: Second argument must be 'in'\n" ) +/** + Error message when too many arguments are supplied to a builtin +*/ #define BUILTIN_ERR_TOO_MANY_ARGUMENTS _( L"%ls: Too many arguments\n" ) /** @@ -150,6 +153,11 @@ int builtin_count_args( wchar_t **argv ); void builtin_print_help( wchar_t *cmd, string_buffer_t *b ); +/** + Slightly kludgy function used with 'complete -C' in order to make + the commandline builtin operate on the string to complete instead + of operating on whatever is to be completed. +*/ const wchar_t *builtin_complete_get_temporary_buffer(); /** @@ -166,6 +174,6 @@ void builtin_wperror( const wchar_t *s); \param cmd The command for which to obtain help text */ -char *builtin_help_get( wchar_t *cmd ); +char *builtin_help_get( const wchar_t *cmd ); #endif -- cgit v1.2.3