Revision: 55037
          http://brlcad.svn.sourceforge.net/brlcad/?rev=55037&view=rev
Author:   brlcad
Date:     2013-04-04 03:44:18 +0000 (Thu, 04 Apr 2013)
Log Message:
-----------
document the JOIN1 macros

Modified Paths:
--------------
    brlcad/trunk/include/vmath.h

Modified: brlcad/trunk/include/vmath.h
===================================================================
--- brlcad/trunk/include/vmath.h        2013-04-04 03:32:12 UTC (rev 55036)
+++ brlcad/trunk/include/vmath.h        2013-04-04 03:44:18 UTC (rev 55037)
@@ -1149,17 +1149,38 @@
     } while (0)
 
 
+/**
+ * Compose 3D vector at `a' of:
+ * vector at `b' plus
+ * scalar `c' times vector at `d'
+ *
+ * This is basically a shorthand for VSCALE();VADD2();.
+ */
 #define VJOIN1(a, b, c, d) do { \
        (a)[X] = (b)[X] + (c) * (d)[X]; \
        (a)[Y] = (b)[Y] + (c) * (d)[Y]; \
        (a)[Z] = (b)[Z] + (c) * (d)[Z]; \
     } while (0)
 
+/**
+ * Compose 2D vector at `a' of:
+ * vector at `b' plus
+ * scalar `c' times vector at `d'
+ *
+ * This is basically a shorthand for V2SCALE();V2ADD2();.
+ */
 #define V2JOIN1(a, b, c, d) do { \
        (a)[X] = (b)[X] + (c) * (d)[X]; \
        (a)[Y] = (b)[Y] + (c) * (d)[Y]; \
     } while (0)
 
+/**
+ * Compose 4D vector at `a' of:
+ * vector at `b' plus
+ * scalar `c' times vector at `d'
+ *
+ * This is basically a shorthand for HSCALE();HADD2();.
+ */
 #define HJOIN1(a, b, c, d) do { \
        (a)[X] = (b)[X] + (c) * (d)[X]; \
        (a)[Y] = (b)[Y] + (c) * (d)[Y]; \
@@ -1167,6 +1188,13 @@
        (a)[W] = (b)[W] + (c) * (d)[W]; \
     } while (0)
 
+/**
+ * Compose `n'-D vector at `a' of:
+ * vector at `b' plus
+ * scalar `c' times vector at `d'
+ *
+ * This is basically a shorthand for VSCALEN();VADD2N();.
+ */
 #define VJOIN1N(a, b, c, d, n) do { \
        register int _vjoin1; \
        for (_vjoin1 = 0; \

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
Minimize network downtime and maximize team effectiveness.
Reduce network management and security costs.Learn how to hire 
the most talented Cisco Certified professionals. Visit the 
Employer Resources Portal
http://www.cisco.com/web/learning/employer_resources/index.html
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits

Reply via email to