[Octave-cvsupdate] SF.net SVN: octave:[8622] trunk/octave-forge/main/mechanics/inst/ inertia_moment_poly2d.m

[<jpi...@us...>]

Revision: 8622
          http://octave.svn.sourceforge.net/octave/?rev=8622&view=rev
Author:   jpicarbajal
Date:     2011-09-27 17:08:03 +0000 (Tue, 27 Sep 2011)
Log Message:
-----------
mechanics. Docstring improvements

Modified Paths:
--------------
    trunk/octave-forge/main/mechanics/inst/inertia_moment_poly2d.m

Modified: trunk/octave-forge/main/mechanics/inst/inertia_moment_poly2d.m
===================================================================
--- trunk/octave-forge/main/mechanics/inst/inertia_moment_poly2d.m	2011-09-27 16:52:31 UTC (rev 8621)
+++ trunk/octave-forge/main/mechanics/inst/inertia_moment_poly2d.m	2011-09-27 17:08:03 UTC (rev 8622)
@@ -20,14 +20,16 @@
 %% The polygon is described in @var{p}, where each row is a different vertex.
 %% @var{m} is the total mass of the polygon, assumed uniformly distributed.
 %% The optional argument @var{offset} is an origin translation vector. All vertex 
-%% are transformed to the reference frame with origin at @var{offset} respect to
-%% the center of mass.
+%% are transformed to the reference frame with origin at @var{offset}. 
 %%
 %% This expression assumes that the polygon is star-shaped. The position of the
 %% vertices is assumed to be given from the center of mass of the polygon.
 %% To change a general polygon to this description you can use:
 %% @code{P = P - repmat(center_mass_poly2d(P),size(P,1))}.
+%% or call the function using the offset:
+%% @code{inertia_moment_poly2d (@var{p}, @var{m}, center_mass_poly2d(P))}
 %%
+%% @seealso{inertia_moment_ncpoly2d, center_mass_poly2d}
 %% @end deftypefn
 
 function I = inertia_moment_poly2d(poly,mass,offset=[0 0])

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