summaryrefslogtreecommitdiffstats
path: root/api/rs_quaternion.spec
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 /api/rs_quaternion.spec
parent0e5d9f637a9ed4207582edb51e200912d8bf54cb (diff)
downloadandroid_frameworks_rs-01c19c30a73d4a3ad42ad5630ad790db01a853cc.tar.gz
android_frameworks_rs-01c19c30a73d4a3ad42ad5630ad790db01a853cc.tar.bz2
android_frameworks_rs-01c19c30a73d4a3ad42ad5630ad790db01a853cc.zip
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 'api/rs_quaternion.spec')
-rw-r--r--api/rs_quaternion.spec7
1 files changed, 4 insertions, 3 deletions
diff --git a/api/rs_quaternion.spec b/api/rs_quaternion.spec
index 6cb280d4..fa37b38f 100644
--- a/api/rs_quaternion.spec
+++ b/api/rs_quaternion.spec
@@ -17,6 +17,7 @@
header:
summary: Quaternion Functions
description:
+ The following functions manipulate quaternions.
end:
function: rsQuaternionAdd
@@ -120,7 +121,7 @@ arg: float w, "W component."
arg: float x, "X component."
arg: float y, "Y component."
arg: float z, "Z component."
-summary: Create a quarternion
+summary: Create a quaternion
description:
Creates a quaternion from its four components or from another quaternion.
inline:
@@ -190,7 +191,7 @@ end:
function: rsQuaternionMultiply
ret: void
arg: rs_quaternion* q, "Destination quaternion."
-arg: float scalar, "Scalar to multiply the quarternion by."
+arg: float scalar, "Scalar to multiply the quaternion by."
summary: Multiply a quaternion by a scalar or another quaternion
description:
Multiplies a quaternion by a scalar or by another quaternion, e.g
@@ -206,7 +207,7 @@ end:
function: rsQuaternionMultiply
ret: void
arg: rs_quaternion* q
-arg: const rs_quaternion* rhs, "Quarternion to multiply the destination quaternion by."
+arg: const rs_quaternion* rhs, "Quaternion to multiply the destination quaternion by."
inline:
rs_quaternion qtmp;
rsQuaternionSet(&qtmp, q);