From d9674620bc4f03dff9611a785a27dd41b1b72648 Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Mon, 20 Jul 2015 02:58:17 +0200
Subject: Clarify code in stereo/ovr: Comments, states, names, formatting.
---
src/jogl/classes/com/jogamp/opengl/util/stereo/EyeParameter.java | 4 ++--
src/jogl/classes/com/jogamp/opengl/util/stereo/ViewerPose.java | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
(limited to 'src/jogl/classes/com/jogamp/opengl/util')
diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/EyeParameter.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/EyeParameter.java
index 075da340b..43a6cfc58 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/stereo/EyeParameter.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/EyeParameter.java
@@ -30,7 +30,7 @@ package com.jogamp.opengl.util.stereo;
import com.jogamp.opengl.math.FovHVHalves;
/**
- * Constant parameter for one eye.
+ * Constant single eye parameter of the viewer, relative to its {@link ViewerPose}.
*/
public final class EyeParameter {
/** Eye number, <code>0</code> for the left eye and <code>1</code> for the right eye. */
@@ -39,7 +39,7 @@ public final class EyeParameter {
/** float[3] eye position vector used to define eye height in meter relative to <i>actor</i>. */
public final float[] positionOffset;
- /** Field of view in both directions, may not be centered, either in radians or tangent. */
+ /** Field of view in both directions, may not be centered, either {@link FovHVHalves#inTangents} or radians. */
public final FovHVHalves fovhv;
/** IPD related horizontal distance from nose to pupil in meter. */
diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/ViewerPose.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/ViewerPose.java
index 40411ac88..10ee4c994 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/stereo/ViewerPose.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/ViewerPose.java
@@ -30,7 +30,7 @@ package com.jogamp.opengl.util.stereo;
import com.jogamp.opengl.math.Quaternion;
/**
- * Position and orientation of viewer.
+ * {@link #position} and {@link #orientation} of viewer.
*/
public final class ViewerPose {
/**
--
cgit v1.2.3