summaryrefslogtreecommitdiffstats
path: root/scriptc
diff options
context:
space:
mode:
authorJean-Luc Brouillet <jeanluc@google.com>2015-04-24 14:41:48 -0700
committerJean-Luc Brouillet <jeanluc@google.com>2015-04-24 16:27:09 -0700
commit2217eb7b12e598e5b435a732207647918c171560 (patch)
treec5fb5e279f839fdd1a7f2580e7e26ae136364568 /scriptc
parent54950687ea8bdde7d1498690433b069924f58044 (diff)
downloadandroid_frameworks_rs-2217eb7b12e598e5b435a732207647918c171560.tar.gz
android_frameworks_rs-2217eb7b12e598e5b435a732207647918c171560.tar.bz2
android_frameworks_rs-2217eb7b12e598e5b435a732207647918c171560.zip
Update documentation generator to work with the Documentation system.
Also added this flag to the generator: -H Now that we generate by default .jd files rather than .html files, you can use this flag to revert to generating .html files. This is useful when verifying doc changes locally. And modified the -v flag to specify the API level for all file generation rather than just the testing files. Change-Id: Ic9e35ad6779b9fbc6b23228dded2e2be864393ff
Diffstat (limited to 'scriptc')
-rw-r--r--scriptc/rs_core.rsh14
-rw-r--r--scriptc/rs_object_types.rsh15
2 files changed, 18 insertions, 11 deletions
diff --git a/scriptc/rs_core.rsh b/scriptc/rs_core.rsh
index be9f7fa0..f242890a 100644
--- a/scriptc/rs_core.rsh
+++ b/scriptc/rs_core.rsh
@@ -19,16 +19,18 @@
/*
* rs_core.rsh: Overview
*
- * RenderScript is a high-performance runtime that provides
- * compute operations at the native level. RenderScript code is compiled on devices
- * at runtime to allow platform-independence as well.
- * This reference documentation describes the RenderScript runtime APIs, which you
- * can utilize to write RenderScript code in C99. The RenderScript compute header
- * files are automatically included for you.
+ * RenderScript is a high-performance runtime that provides compute operations at the native level.
+ * RenderScript code is compiled on devices at runtime to allow platform-independence as well.
+ *
+ * This reference documentation describes the RenderScript runtime APIs, which you can utilize
+ * to write RenderScript code in C99. The RenderScript compute header files are automatically
+ * included for you.
*
* To use RenderScript, you need to utilize the RenderScript runtime APIs documented here
* as well as the Android framework APIs for RenderScript.
+ *
* For documentation on the Android framework APIs, see the android.renderscript package reference.
+ *
* For more information on how to develop with RenderScript and how the runtime and
* Android framework APIs interact, see the RenderScript developer guide
* and the RenderScript samples.
diff --git a/scriptc/rs_object_types.rsh b/scriptc/rs_object_types.rsh
index 0fc5e4da..43c89db5 100644
--- a/scriptc/rs_object_types.rsh
+++ b/scriptc/rs_object_types.rsh
@@ -49,7 +49,8 @@ struct {\
* rs_element: Handle to an element
*
* Opaque handle to a RenderScript element.
- * See: android.renderscript.Element
+ *
+ * See android.renderscript.Element.
*/
typedef _RS_HANDLE rs_element;
@@ -57,7 +58,8 @@ typedef _RS_HANDLE rs_element;
* rs_type: Handle to a Type
*
* Opaque handle to a RenderScript type.
- * See: android.renderscript.Type
+ *
+ * See android.renderscript.Type.
*/
typedef _RS_HANDLE rs_type;
@@ -65,7 +67,8 @@ typedef _RS_HANDLE rs_type;
* rs_allocation: Handle to an allocation
*
* Opaque handle to a RenderScript allocation.
- * See: android.renderscript.Allocation
+ *
+ * See android.renderscript.Allocation.
*/
typedef _RS_HANDLE rs_allocation;
@@ -73,7 +76,8 @@ typedef _RS_HANDLE rs_allocation;
* rs_sampler: Handle to a Sampler
*
* Opaque handle to a RenderScript sampler object.
- * See: android.renderscript.Sampler
+ *
+ * See android.renderscript.Sampler.
*/
typedef _RS_HANDLE rs_sampler;
@@ -81,7 +85,8 @@ typedef _RS_HANDLE rs_sampler;
* rs_script: Handle to a Script
*
* Opaque handle to a RenderScript script object.
- * See: android.renderscript.ScriptC
+ *
+ * See android.renderscript.ScriptC.
*/
typedef _RS_HANDLE rs_script;