[Octave-cvsupdate] SF.net SVN: octave:[9477] trunk/octave-forge/extra/quaternion_oo

[<par...@us...>]

Revision: 9477
          http://octave.svn.sourceforge.net/octave/?rev=9477&view=rev
Author:   paramaniac
Date:     2011-12-29 13:32:23 +0000 (Thu, 29 Dec 2011)
Log Message:
-----------
quaternion_oo: add docstring to remaining functions

Modified Paths:
--------------
    trunk/octave-forge/extra/quaternion_oo/INDEX
    trunk/octave-forge/extra/quaternion_oo/inst/qi.m
    trunk/octave-forge/extra/quaternion_oo/inst/qj.m
    trunk/octave-forge/extra/quaternion_oo/inst/qk.m

Modified: trunk/octave-forge/extra/quaternion_oo/INDEX
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/INDEX	2011-12-29 13:12:23 UTC (rev 9476)
+++ trunk/octave-forge/extra/quaternion_oo/INDEX	2011-12-29 13:32:23 UTC (rev 9477)
@@ -1,6 +1,9 @@
 quaternion >> Quaternion
 Quaternions
   quaternion
+  qi
+  qj
+  qk
   q2rot
   rot2q
 Methods

Modified: trunk/octave-forge/extra/quaternion_oo/inst/qi.m
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/inst/qi.m	2011-12-29 13:12:23 UTC (rev 9476)
+++ trunk/octave-forge/extra/quaternion_oo/inst/qi.m	2011-12-29 13:32:23 UTC (rev 9477)
@@ -1,3 +1,42 @@
+## Copyright (C) 2010   Lukas F. Reichlin
+##
+## This program is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## @deftypefn {Function File} {} qi
+## Create x-component of a quaternion's vector part.
+##
+## @example
+## q = w + x*qi + y*qj + z*qk
+## @end example
+##
+## @strong{Example}
+## @example
+## @group
+## octave:1> q1 = quaternion (1, 2, 3, 4)
+## q1 = 1 + 2i + 3j + 4k
+## octave:2> q2 = 1 + 2*qi + 3*qj + 4*qk
+## q2 = 1 + 2i + 3j + 4k
+## octave:3> 
+## @end group
+## @end example
+##
+## @end deftypefn
+
+## Author: Lukas Reichlin <luk...@gm...>
+## Created: May 2010
+## Version: 0.1
+
 function q = qi
 
   if (nargin != 0)

Modified: trunk/octave-forge/extra/quaternion_oo/inst/qj.m
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/inst/qj.m	2011-12-29 13:12:23 UTC (rev 9476)
+++ trunk/octave-forge/extra/quaternion_oo/inst/qj.m	2011-12-29 13:32:23 UTC (rev 9477)
@@ -1,3 +1,42 @@
+## Copyright (C) 2010   Lukas F. Reichlin
+##
+## This program is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## @deftypefn {Function File} {} qj
+## Create y-component of a quaternion's vector part.
+##
+## @example
+## q = w + x*qi + y*qj + z*qk
+## @end example
+##
+## @strong{Example}
+## @example
+## @group
+## octave:1> q1 = quaternion (1, 2, 3, 4)
+## q1 = 1 + 2i + 3j + 4k
+## octave:2> q2 = 1 + 2*qi + 3*qj + 4*qk
+## q2 = 1 + 2i + 3j + 4k
+## octave:3> 
+## @end group
+## @end example
+##
+## @end deftypefn
+
+## Author: Lukas Reichlin <luk...@gm...>
+## Created: May 2010
+## Version: 0.1
+
 function q = qj
 
   if (nargin != 0)

Modified: trunk/octave-forge/extra/quaternion_oo/inst/qk.m
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/inst/qk.m	2011-12-29 13:12:23 UTC (rev 9476)
+++ trunk/octave-forge/extra/quaternion_oo/inst/qk.m	2011-12-29 13:32:23 UTC (rev 9477)
@@ -1,3 +1,42 @@
+## Copyright (C) 2010   Lukas F. Reichlin
+##
+## This program is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## @deftypefn {Function File} {} qk
+## Create z-component of a quaternion's vector part.
+##
+## @example
+## q = w + x*qi + y*qj + z*qk
+## @end example
+##
+## @strong{Example}
+## @example
+## @group
+## octave:1> q1 = quaternion (1, 2, 3, 4)
+## q1 = 1 + 2i + 3j + 4k
+## octave:2> q2 = 1 + 2*qi + 3*qj + 4*qk
+## q2 = 1 + 2i + 3j + 4k
+## octave:3> 
+## @end group
+## @end example
+##
+## @end deftypefn
+
+## Author: Lukas Reichlin <luk...@gm...>
+## Created: May 2010
+## Version: 0.1
+
 function q = qk
 
   if (nargin != 0)

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