move the documentation of cylindrical coordinate transform to doc dir…

…ectory
786hmhk · Mar 11, 2015 · fd2a420 · fd2a420
1 parent b8217c7
commit fd2a420
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/...ction/+geometry/cartesian2cylindrical.svg → doc/cartesian2cylindrical.svg b/...ction/+geometry/cartesian2cylindrical.svg → doc/cartesian2cylindrical.svg
diff --git a/...n/+geometry/doc_cartesian2cylindrical.pdf → doc/doc_cartesian2cylindrical.pdf b/...n/+geometry/doc_cartesian2cylindrical.pdf → doc/doc_cartesian2cylindrical.pdf
diff --git a/...n/+geometry/doc_cartesian2cylindrical.tex → doc/doc_cartesian2cylindrical.tex b/...n/+geometry/doc_cartesian2cylindrical.tex → doc/doc_cartesian2cylindrical.tex
diff --git a/solvers/+drakeFunction/+geometry/Cartesian2CylindricalTransform.m b/solvers/+drakeFunction/+geometry/Cartesian2CylindricalTransform.m
@@ -1,8 +1,9 @@
 classdef Cartesian2CylindricalTransform < drakeFunction.DrakeFunction
   % Given a cartesian coordinate frame, transform its coordinates to a
-  % cylindrical coordinates
+  % cylindrical coordinates. Please refer to
+  % drake/doc/doc_cartesian2cylindrical.pdf for details on the coordinates.
   properties(SetAccess = protected)
-    T_cylinder % This is a homogeneous transformation matrix, T_cylinder transforms a cylinder with [0;0;1] being its axis, and nd the angle theta measured with respect to the x-axis
+    T_cylinder % This is a homogeneous transformation matrix, T_cylinder transforms a cylinder with [0;0;1] being its axis, and the angle theta measured with respect to the x-axis
   end
 
   methods

diff --git a/solvers/+drakeFunction/+geometry/Cylindrical2CartesianTransform.m b/solvers/+drakeFunction/+geometry/Cylindrical2CartesianTransform.m
@@ -1,6 +1,6 @@
 classdef Cylindrical2CartesianTransform < drakeFunction.DrakeFunction
   % Given a cylindrical coordinate frame, transform its coordinates to a
-  % Cartesian coordinate. Refer to doc_cartesian2cylindrical.pdf for the
+  % Cartesian coordinate. Refer to drake/doc/doc_cartesian2cylindrical.pdf for the
   % transformation
   properties(SetAccess = protected)
     T_cylinder % This is a homogeneous transformation matrix, T_cylinder transforms a cylinder with [0;0;1] being its axis, and nd the angle theta measured with respect to the x-axis
@@ -18,7 +18,7 @@
     end
 
     function [x_cartesian,J] = eval(obj,x_cylinder)
-      % Refer to doc_cartesian2cylindrical.pdf for the transformation
+      % Refer to drake/doc/doc_cartesian2cylindrical.pdf for the transformation
       % @retval x_cartesian = [x;y;z;roll;pitch;yaw];
       % @param x_cylinder =
       % [radius;theta;height;roll_tangent,pitch_tangent,yaw_tangent]