Added tags, standalone comment line of form %## taglist to assist in building doco with help2doc

petercorke · petercorke · commit 1e2719299401 · 2020-01-26T12:47:29.000+10:00
diff --git a/t2r.m b/t2r.m
@@ -12,6 +12,8 @@
 %
 % See also R2T, TR2RT, RT2TR.
 
+%## 2d 3d homogeneous
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tb_optparse.m b/tb_optparse.m
@@ -76,6 +76,8 @@
 % - Any input argument or element of the opt struct can be a string instead
 %   of a char array.
 
+%## utility
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2angvec.m b/tr2angvec.m
@@ -22,6 +22,8 @@
 %
 % See also ANGVEC2R, ANGVEC2TR, TRLOG.
 
+%## 3d homogeneous rotation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2delta.m b/tr2delta.m
@@ -22,6 +22,8 @@
 %
 % See also DELTA2TR, SKEW, SE3.todelta.
 
+%## 3d differential homogeneous
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2eul.m b/tr2eul.m
@@ -22,6 +22,8 @@
 %
 % See also  EUL2TR, TR2RPY.
 
+%## 3d rotation homogeneous
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2jac.m b/tr2jac.m
@@ -11,6 +11,8 @@
 %
 % See also WTRANS, TR2DELTA, DELTA2TR, SE3.velxform.
 
+%## 3d homogeneous differential
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2rpy.m b/tr2rpy.m
@@ -32,6 +32,8 @@
 %
 % See also  rpy2tr, tr2eul.
 
+%## 3d rotation homogeneous
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tr2rt.m b/tr2rt.m
@@ -17,6 +17,8 @@
 %
 % See also RT2TR, R2T, T2R.
 
+%## 2d 3d homogeneous rotation translation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tranimate.m b/tranimate.m
@@ -28,6 +28,8 @@
 %
 % See also TRPLOT, Animate, SE3.animate.
 
+%## 3d rotation trajectory graphics
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/tranimate2.m b/tranimate2.m
@@ -28,6 +28,8 @@
 %
 % See also TRPLOT, Animate, SE3.animate.
 
+%## 2d homogeneous rotation graphics
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
@@ -208,4 +210,4 @@ function timer_callback(timerObj, ~)
     
     guts(ud, i);
     
-end
+end
diff --git a/transl.m b/transl.m
@@ -28,6 +28,8 @@
 %
 % See also SE3.t, SE3.transl.
 
+%## 3d homogeneous translation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/transl2.m b/transl2.m
@@ -23,6 +23,8 @@
 %
 % See also SE2.t, ROT2, ISHOMOG2, TRPLOT2, TRANSL.
 
+%## 2d homogeneous translation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
@@ -89,4 +91,4 @@
     else
         h = false;
     end
-end
+end
diff --git a/trchain.m b/trchain.m
@@ -40,6 +40,7 @@
 %
 % See also trchain2, trotx, troty, trotz, transl, SerialLink.trchain, ETS.
 
+%## 3d homogeneous 
 
 % Copyright (C) 1993-2017, by Peter I. Corke
 %
diff --git a/trchain2.m b/trchain2.m
@@ -40,6 +40,8 @@
 %
 % See also trchain2, trotx, troty, trotz, transl, SerialLink.trchain, ETS.
 
+%## 2d homogeneous 
+
 
 % Copyright (C) 1993-2017, by Peter I. Corke
 %
diff --git a/trexp.m b/trexp.m
@@ -39,6 +39,9 @@
 %
 % See also ANGVEC2R, TRLOG, TREXP2, SKEW, SKEWA, Twist.
 
+%## 3d homogeneous differential
+
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trinterp.m b/trinterp.m
@@ -24,6 +24,8 @@
 %
 % See also TRINTERP2, CTRAJ, SE3.interp, UnitQuaternion, TPOLY, LSPB.
 
+%## 3d homogeneous trajectory
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trinterp2.m b/trinterp2.m
@@ -23,6 +23,9 @@
 %
 % See also TRINTERP, SE3.interp, UnitQuaternion, TPOLY, LSPB.
 
+%## 2d homogeneous trajectory
+
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trlog.m b/trlog.m
@@ -28,6 +28,8 @@
 %
 % See also trexp, trexp2, Twist, LOGM.
 
+%## 3d homogeneous differential
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trnorm.m b/trnorm.m
@@ -21,6 +21,8 @@
 %
 % See also OA2TR, SO3.trnorm, SE3.trnorm.
 
+%## 3d homogeneous 
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trot2.m b/trot2.m
@@ -10,6 +10,8 @@
 %
 % See also rot2, transl2, ishomog2, trplot2, trotx, troty, trotz, SE2.
 
+%## 2d homogeneous rotation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trotx.m b/trotx.m
@@ -10,6 +10,8 @@
 %
 % See also rotx, troty, trotz, trot2, SE3.Rx.
 
+%## 3d rotation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/troty.m b/troty.m
@@ -10,6 +10,9 @@
 %
 % See also roty, trotx, trotz, trot2, SE3.Ry.
 
+%## 3d homogeneous rotation
+
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trotz.m b/trotz.m
@@ -10,6 +10,8 @@
 %
 % See also rotz, trotx, troty, trot2, SE3.Rz.
 
+%## 3d homogeneous rotation
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trplot.m b/trplot.m
@@ -70,6 +70,8 @@
 %   'thick', 5.
 % - The 'arrow' option requires https://www.mathworks.com/matlabcentral/fileexchange/14056-arrow3
 
+%## 3d homogeneous graphics
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trplot2.m b/trplot2.m
@@ -52,6 +52,8 @@
 %
 % See also TRPLOT.
 
+%## 2d homogeneous graphics
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trprint.m b/trprint.m
@@ -39,6 +39,8 @@
 %
 % See also TR2EUL, TR2RPY, TR2ANGVEC.
 
+%## 3d homogeneous 
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trprint2.m b/trprint2.m
@@ -22,6 +22,9 @@
 %
 % See also TRPRINT.
 
+%## 2d homogeneous 
+
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).
diff --git a/trscale.m b/trscale.m
@@ -6,10 +6,12 @@
 % z-directions.
 %
 % Note::
-% - This matrix does not belong to SE(3) and should not be compounded with
-%   any SE(3) matrix.
+% - This matrix does not belong to SE(3) and if compounded with
+%   any SE(3) matrix the result will not be in SE(3).
 %
 
+%## 3d homogeneous 
+
 % Copyright (C) 1993-2019 Peter I. Corke
 %
 % This file is part of The Spatial Math Toolbox for MATLAB (SMTB).

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`%`
`13`	`13`	`% See also R2T, TR2RT, RT2TR.`
`14`	`14`
	`15`	`+%## 2d 3d homogeneous`
	`16`	`+`
`15`	`17`	`% Copyright (C) 1993-2019 Peter I. Corke`
`16`	`18`	`%`
`17`	`19`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@`
`76`	`76`	`% - Any input argument or element of the opt struct can be a string instead`
`77`	`77`	`% of a char array.`
`78`	`78`
	`79`	`+%## utility`
	`80`	`+`
`79`	`81`	`% Copyright (C) 1993-2019 Peter I. Corke`
`80`	`82`	`%`
`81`	`83`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`	`%`
`23`	`23`	`% See also ANGVEC2R, ANGVEC2TR, TRLOG.`
`24`	`24`
	`25`	`+%## 3d homogeneous rotation`
	`26`	`+`
`25`	`27`	`% Copyright (C) 1993-2019 Peter I. Corke`
`26`	`28`	`%`
`27`	`29`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`%`
`12`	`12`	`% See also WTRANS, TR2DELTA, DELTA2TR, SE3.velxform.`
`13`	`13`
	`14`	`+%## 3d homogeneous differential`
	`15`	`+`
`14`	`16`	`% Copyright (C) 1993-2019 Peter I. Corke`
`15`	`17`	`%`
`16`	`18`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@`
`32`	`32`	`%`
`33`	`33`	`% See also rpy2tr, tr2eul.`
`34`	`34`
	`35`	`+%## 3d rotation homogeneous`
	`36`	`+`
`35`	`37`	`% Copyright (C) 1993-2019 Peter I. Corke`
`36`	`38`	`%`
`37`	`39`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`%`
`18`	`18`	`% See also RT2TR, R2T, T2R.`
`19`	`19`
	`20`	`+%## 2d 3d homogeneous rotation translation`
	`21`	`+`
`20`	`22`	`% Copyright (C) 1993-2019 Peter I. Corke`
`21`	`23`	`%`
`22`	`24`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@`
`28`	`28`	`%`
`29`	`29`	`% See also TRPLOT, Animate, SE3.animate.`
`30`	`30`
	`31`	`+%## 3d rotation trajectory graphics`
	`32`	`+`
`31`	`33`	`% Copyright (C) 1993-2019 Peter I. Corke`
`32`	`34`	`%`
`33`	`35`	`% This file is part of The Spatial Math Toolbox for MATLAB (SMTB).`