[Orxonox-commit 5218] r9881 - code/branches/radarDreiD/src/libraries/util

[wroennin at orxonox.net]

Author: wroennin
Date: 2013-12-09 14:14:06 +0100 (Mon, 09 Dec 2013)
New Revision: 9881

Modified:
   code/branches/radarDreiD/src/libraries/util/Math.cc
Log:
corrected some documentation

Modified: code/branches/radarDreiD/src/libraries/util/Math.cc
===================================================================
--- code/branches/radarDreiD/src/libraries/util/Math.cc	2013-12-09 13:10:21 UTC (rev 9880)
+++ code/branches/radarDreiD/src/libraries/util/Math.cc	2013-12-09 13:14:06 UTC (rev 9881)
@@ -197,12 +197,9 @@
             @param mydirection My viewing direction
             @param myorthonormal My orthonormalvector (pointing upwards through my head)
             @param otherposition The position of the other object
-            @param mapangle The angle you look on the 3Dmap
+            @param mapangle The angle between line of sight on screen and the 3Dmap-x/z-plain in radian
             @param detectionlimit The limit in which objects are shown on the map
             @return The viewing direction
-
-            Examples:
-             -
     */
     orxonox::Vector2 get3DProjection(const orxonox::Vector3& myposition, const orxonox::Vector3& mydirection, const orxonox::Vector3& myorthonormal, const orxonox::Vector3& otherposition, const float mapangle, const float detectionlimit)
     {
@@ -236,7 +233,7 @@
                @param mydirection My viewing direction
                @param myorthonormal My orthonormalvector (pointing upwards through my head)
                @param otherposition The position of the other object
-               @param mapangle The angle you look on the 3Dmap
+               @param mapangle The angle you look on the 3Dmap in radian
                @return If distancevector to the other object has a positive y-coordinate
 
                Examples: