add docs

Author: jan-br

ultralight-java-native/src/main/c/include/ultralight_java/java_bridges/ultralight_matrix4x4_jni.hpp

@@ -25,7 +25,13 @@
 namespace ultralight_java {
     class UltralightMatrix4x4JNI {
     public:
+        ///
+        /// Raw 4x4 matrix as an array
+        ///
         static jfloatArray get_data(JNIEnv *env, jobject instance);
+        ///
+        /// Set to identity matrix.
+        ///
         static void set_identity(JNIEnv *env, jobject instance);
         static jobject create(JNIEnv *env, ultralight::Matrix4x4 matrix);
         static jlong construct(JNIEnv *env, jclass caller_class);

ultralight-java-native/src/main/c/include/ultralight_java/java_bridges/ultralight_matrix_jni.hpp

@@ -25,8 +25,14 @@
 namespace ultralight_java {
     class UltralightMatrixJNI {
     public:
+        ///
+        /// Set to another matrix.
+        ///
         static void set1(JNIEnv *env, jobject instance, jobject matrix4x4);
 
+        ///
+        /// Set from raw 4x4 components.
+        ///
         static void set(
             JNIEnv *env,
             jobject instance,
@@ -47,17 +53,28 @@ namespace ultralight_java {
             jdouble m43,
             jdouble m44);
 
+        ///
+        /// Get this matrix as unaligned 4x4 float components (for use passing to
+        /// GPU driver APIs).
+        ///
         static jobject getMatrix4x4(JNIEnv *env, jobject instance);
 
-        static jobject create(JNIEnv *env, ultralight::Matrix matrix);
-
-        static jlong construct(JNIEnv *env, jclass caller_class);
-
+        ///
+        /// Set to an orthographic projection matrix suitable for use with our
+        /// vertex shaders. Optionally flip the y-coordinate space (eg, for OpenGL).
+        ///
         static void setOrthographicProjection(
             JNIEnv *env, jobject instance, jdouble width, jdouble height, jboolean flipY);
 
+        ///
+        /// Transform (multiply) by another Matrix
+        ///
         static void transform(JNIEnv *env, jobject instance, jobject transformMatrix);
 
+        static jobject create(JNIEnv *env, ultralight::Matrix matrix);
+
+        static jlong construct(JNIEnv *env, jclass caller_class);
+
         static void _delete(JNIEnv *env, jclass caller_class, jlong handle);
     };
 } // namespace ultralight_java