Improve the documentation of the RenderScript API.
Only the explanations should be changing.
Change-Id: I889b366e3be44f5ac7f44a199e4b9a47353665e2
diff --git a/scriptc/rs_debug.rsh b/scriptc/rs_debug.rsh
index d52590e..348c598 100644
--- a/scriptc/rs_debug.rsh
+++ b/scriptc/rs_debug.rsh
@@ -17,11 +17,10 @@
// Don't edit this file! It is auto-generated by frameworks/rs/api/generate.sh.
/*
- * rs_debug.rsh: Utility debugging routines
+ * rs_debug.rsh: Debugging Functions
*
- * Routines intended to be used during application developement. These should
- * not be used in shipping applications. All print a string and value pair to
- * the standard log.
+ * The functions below are intended to be used during application developement.
+ * They should not be used in shipping applications.
*/
#ifndef RENDERSCRIPT_RS_DEBUG_RSH
@@ -31,7 +30,12 @@
#define RS_DEBUG_MARKER rsDebug(__FILE__, __LINE__)
/*
- * Debug function. Prints a string and value to the log.
+ * rsDebug: Log a message and values
+ *
+ * This function prints a message to the standard log, followed by the provided values.
+ *
+ * This function is intended for debugging only and should not be used in shipping
+ * applications.
*/
extern void __attribute__((overloadable))
rsDebug(const char* message, double a);