changeset 5664:81c8c68e393d octave-forge

improved help text
author cdf
date Tue, 19 May 2009 03:58:04 +0000
parents 7ceee0de0b7b
children 5a8f18891625
files extra/nurbs/inst/bspderiv.m extra/nurbs/inst/bspeval.m extra/nurbs/inst/deg2rad.m extra/nurbs/inst/demosurf.m extra/nurbs/inst/demotorus.m extra/nurbs/inst/findspan.m extra/nurbs/inst/nrbbasisfun.m extra/nurbs/inst/nrbbasisfungradient.m extra/nurbs/inst/nrbeval.m extra/nurbs/inst/nrbnumbasisfun.m extra/nurbs/inst/nrbreverse.m extra/nurbs/inst/nrbsrfgradient.m extra/nurbs/inst/nrbtestcrv.m extra/nurbs/inst/nrbtestsrf.m extra/nurbs/inst/nrbtform.m extra/nurbs/inst/numbasisfun.m extra/nurbs/inst/vecmag.m extra/nurbs/inst/vecmag2.m
diffstat 18 files changed, 20 insertions(+), 21 deletions(-) [+]
line wrap: on
line diff
--- a/extra/nurbs/inst/bspderiv.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/bspderiv.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function [dc,dk] = bspderiv(d,c,k)
 
-% BSPDERIV:  B-Spline derivative
+% BSPDERIV:  B-Spline derivative.
 % 
 %  MATLAB SYNTAX:
 % 
--- a/extra/nurbs/inst/bspeval.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/bspeval.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function p = bspeval(d,c,k,u)
 
-% BSPEVAL:  Evaluate B-Spline at parametric points
+% BSPEVAL:  Evaluate B-Spline at parametric points.
 % 
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/deg2rad.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/deg2rad.m	Tue May 19 03:58:04 2009 +0000
@@ -1,6 +1,5 @@
 function rad = deg2rad(deg)
- 
- 
+  
 % DEG2RAD: Convert degrees to radians.
 % 
 % Calling Sequence:
--- a/extra/nurbs/inst/demosurf.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/demosurf.m	Tue May 19 03:58:04 2009 +0000
@@ -1,5 +1,5 @@
 function demosurf
-% Shows a simple test surface
+% DEMOSURF: Shows a simple test surface
 %
 
 % D.M. Spink
--- a/extra/nurbs/inst/demotorus.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/demotorus.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function demotorus
 
-% A second demonstration of surface construction
+% DEMOTORUS: A second demonstration of surface construction
 % by revolution.
 %
 
--- a/extra/nurbs/inst/findspan.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/findspan.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function sv = findspan (n, p, uv, U)                
 
-% FINDSPAN  Find the span of a B-Spline knot vector at a parametric point
+% FINDSPAN:  Find the span of a B-Spline knot vector at a parametric point
 %
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/nrbbasisfun.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbbasisfun.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function [B, id] = nrbbasisfun (points, nrb)
 
-% NRBBASISFUN  Basis functions for NURBS
+% NRBBASISFUN: Basis functions for NURBS
 %
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/nrbbasisfungradient.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbbasisfungradient.m	Tue May 19 03:58:04 2009 +0000
@@ -17,7 +17,7 @@
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {[@var{dRdx}, @var{dRdy}]=} nrbbasisfungradient (@{@var{dzdu}, @var{dzdv}@}, @{@var{dxdu}, @var{dydu}, @var{dxdv}, @var{dydv}@})
 %% @deftypefnx {Function File} {[@var{dRdx}]=} nrbbasisfungradient (@var{dzdu}, @var{dxdu})
-%% Compute the gradient of the basis functions of a NURBS surface at the
+%% NRBBASISFUNGRADIENT Compute the gradient of the basis functions of a NURBS surface at the
 %% specified parametric points.
 %%
 %% INPUT:
--- a/extra/nurbs/inst/nrbeval.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbeval.m	Tue May 19 03:58:04 2009 +0000
@@ -1,6 +1,6 @@
 function [p,w] = nrbeval(nurbs,tt)
 % 
-% NRBEVAL: Evaluate a NURBS at parameteric points
+% NRBEVAL: Evaluate a NURBS at parameteric points.
 % 
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/nrbnumbasisfun.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbnumbasisfun.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function idx = nrbnumbasisfun (points, nrb)
 
-% NRBNUMBASISFUN  Numbering of basis functions for NURBS
+% NRBNUMBASISFUN:  Numbering of basis functions for NURBS
 %
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/nrbreverse.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbreverse.m	Tue May 19 03:58:04 2009 +0000
@@ -1,6 +1,6 @@
 function rnrb = nrbreverse(nrb)
 %
-% NRBREVERSE - Reverse the evaluation direction of a NURBS curve or surface.
+% NRBREVERSE: Reverse the evaluation direction of a NURBS curve or surface.
 % 
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/nrbsrfgradient.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbsrfgradient.m	Tue May 19 03:58:04 2009 +0000
@@ -16,11 +16,11 @@
 
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {[@var{dzdx}, @var{dzdy}]=} nrbsrfgradient (@var{nrb}, @var{nrbder}, @var{u}, @var{v})
-%% Compute the gradient of a NURBS surface.
+%% NRBSRFGRADIENT: Compute the gradient of a NURBS surface.
 %% @seealso{nrbderiv}
 %% @end deftypefn
 
-%% Author: Carlo de Falco <carlo@guglielmo.local>
+%% Author: Carlo de Falco <cdf _AT_ users.sourceforge.net>
 %% Created: 2009-03-17
 
 function [dzdx, dzdy]  = nrbsrfgradient (nrb, nrbder, u, v)
--- a/extra/nurbs/inst/nrbtestcrv.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbtestcrv.m	Tue May 19 03:58:04 2009 +0000
@@ -1,5 +1,5 @@
 function crv = nrbtestcrv
-% Constructs a simple test curve. 
+% NRBTESTCRV: Constructs a simple test curve. 
 
 % D.M. Spink
 % Copyright (c) 2000
--- a/extra/nurbs/inst/nrbtestsrf.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbtestsrf.m	Tue May 19 03:58:04 2009 +0000
@@ -1,5 +1,5 @@
 function srf = nrbtestsrf
-% Constructs a simple test surface.
+% NRBTESTSRF: Constructs a simple test surface.
 
 %  D.M. Spink
 %  Copyright (c) 2000.
--- a/extra/nurbs/inst/nrbtform.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/nrbtform.m	Tue May 19 03:58:04 2009 +0000
@@ -1,7 +1,7 @@
 function nurbs = nrbtform(nurbs,tmat)
 
 % 
-% NRBTFORM - Apply transformation matrix to the NURBS.
+% NRBTFOR: Apply transformation matrix to the NURBS.
 % 
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/numbasisfun.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/numbasisfun.m	Tue May 19 03:58:04 2009 +0000
@@ -15,7 +15,7 @@
 
 function B = numbasisfun (iv, uv, p, U)
 
-% BASISFUN  List non-zero Basis functions for B-Spline in a given knot-span
+% NUMBASISFUN:  List non-zero Basis functions for B-Spline in a given knot-span
 %
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/vecmag.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/vecmag.m	Tue May 19 03:58:04 2009 +0000
@@ -1,6 +1,6 @@
 function mag = vecmag(vec)
 % 
-% VECMAG: Magnitude of the vectors
+% VECMAG: Magnitude of the vectors.
 % 
 % Calling Sequence:
 % 
--- a/extra/nurbs/inst/vecmag2.m	Mon May 18 20:18:10 2009 +0000
+++ b/extra/nurbs/inst/vecmag2.m	Tue May 19 03:58:04 2009 +0000
@@ -1,6 +1,6 @@
 function mag = vecmag2(vec)
 % 
-% VECMAG2: Squared magnitude of the vectors
+% VECMAG2: Squared magnitude of a set of vectors.
 % 
 % Calling Sequence:
 % 
@@ -9,7 +9,7 @@
 % Parameters:
 % 
 %   vec		: An array of column vectors represented by a matrix of
-% 		size (dim,nv), where is the dimension of the vector and
+% 		size (dim,nv), where dim is the dimension of the vector and
 % 		nv the number of vectors.
 % 
 %   mvec	: Squared magnitude of the vectors, vector of size (1,nv).