auto import from //branches/cupcake/...@130745

1 files changed, 36 insertions, 0 deletions

diff --git a/android/help.h b/android/help.h
new file mode 100644
index 0000000..94feca1
--- /dev/null
+++ b/android/help.h
@@ -0,0 +1,36 @@
+/* Copyright (C) 2008 The Android Open Source Project
+**
+** This software is licensed under the terms of the GNU General Public
+** License version 2, as published by the Free Software Foundation, and
+** may be copied, distributed, and modified under those terms.
+**
+** This program is distributed in the hope that it will be useful,
+** but WITHOUT ANY WARRANTY; without even the implied warranty of
+** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+** GNU General Public License for more details.
+*/
+#ifndef _ANDROID_HELP_H
+#define _ANDROID_HELP_H
+
+#include "android/utils/stralloc.h"
+
+/* appends the list of options with a small description to a dynamic string */
+extern void  android_help_list_options( stralloc_t*  out );
+
+/* output main help screen into a single dynamic string */
+extern void  android_help_main( stralloc_t*  out );
+
+/* output all help into a single dynamic string */
+extern void  android_help_all( stralloc_t*  out );
+
+/* appends the help for a given command-line option into a dynamic string
+ * returns 0 on success, or -1 on error (i.e. unknown option)
+ */
+extern int  android_help_for_option( const char*  option, stralloc_t*  out );
+
+/* appends the help for a given help topic into a dynamic string
+ * returns 0 on success, or -1 on error (i.e. unknown topic)
+ */
+extern int  android_help_for_topic( const char*  topic, stralloc_t*  out );
+
+#endif /* _ANDROID_HELP_H */