summaryrefslogtreecommitdiff
path: root/scriptc/rs_graphics.rsh
diff options
context:
space:
mode:
authorJean-Luc Brouillet <jeanluc@google.com>2015-04-28 15:06:30 -0700
committerJean-Luc Brouillet <jeanluc@google.com>2015-05-28 12:02:04 -0700
commit01c19c30a73d4a3ad42ad5630ad790db01a853cc (patch)
tree77a405eef7af5be1daf727d2eee449348cb2ac6e /scriptc/rs_graphics.rsh
parent0e5d9f637a9ed4207582edb51e200912d8bf54cb (diff)
downloadrs-01c19c30a73d4a3ad42ad5630ad790db01a853cc.tar.gz
API Runtime Reference documentation tweaks.
Many small changes. Among them: - Cleaned up the boiler plate HTML used for -H option to the minimal possible. - Cleaned line break of the comments to make them more consistent in the .rsh files. - Added missing summaries. - Make the style of argument comments more consistent. - Fixed missing HTML escaping. - Fixed generation of the snippets for the .cs file. - Improved the documentation about the math precision. - Reworked the documentation of object types. Change-Id: I8b229720134aac6d46a0a2679e8b58f15be5ed7e (cherry picked from commit 6386ceb3bf25e442513224aaa45691dfe49562d9)
Diffstat (limited to 'scriptc/rs_graphics.rsh')
-rw-r--r--scriptc/rs_graphics.rsh13
1 files changed, 5 insertions, 8 deletions
diff --git a/scriptc/rs_graphics.rsh b/scriptc/rs_graphics.rsh
index c133aadf..5439f061 100644
--- a/scriptc/rs_graphics.rsh
+++ b/scriptc/rs_graphics.rsh
@@ -214,12 +214,10 @@ typedef _RS_HANDLE rs_program_store;
/*
* rsClearObject: Release an object
*
- * Tells the run time that this handle will no longer be used to access the
- * the related object. If this was the last handle to that object, resource
- * recovery may happen.
+ * Tells the run time that this handle will no longer be used to access the the related
+ * object. If this was the last handle to that object, resource recovery may happen.
*
- * After calling this function, *dst will be set to an empty handle. See
- * rsIsObject().
+ * After calling this function, *dst will be set to an empty handle. See rsIsObject().
*/
#ifndef __LP64__
extern void __attribute__((overloadable))
@@ -259,9 +257,8 @@ extern void __attribute__((overloadable))
* This function does not validate that the internal pointer used in the handle
* points to an actual valid object; it only checks for null.
*
- * This function can be used to check the element returned by
- * rsElementGetSubElement() or see if rsClearObject() has been called on a
- * handle.
+ * This function can be used to check the Element returned by rsElementGetSubElement()
+ * or see if rsClearObject() has been called on a handle.
*/
#ifndef __LP64__
extern bool __attribute__((overloadable))