Mercurial > forge

changeset 2741:1eab69d6c53d octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix texinfo errors. Don't include the TODO line outside of deftypefn block
author adb014
date Sun, 22 Oct 2006 21:20:30 +0000
parents 75894aa001e6
children 8ff1cc06fa00
files main/odepkg/inst/odepkg_equations_lorenz.m main/odepkg/inst/odepkg_equations_pendulous.m main/odepkg/inst/odepkg_equations_roessler.m
diffstat 3 files changed, 4 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/main/odepkg/inst/odepkg_equations_lorenz.m	Sun Oct 22 17:49:59 2006 +0000
+++ b/main/odepkg/inst/odepkg_equations_lorenz.m	Sun Oct 22 21:20:30 2006 +0000
@@ -18,7 +18,6 @@
 %# -*- texinfo -*-
 %# @deftypefn {Function} {@var{[y]} =} odepkg_equations_lorenz (@var{t}, @var{x})
 %# Returns the states of the ordinary differential equations from the Lorenz equation implementation, ie. the force to a conductor caused by movement in a magnetic field, cf. @url{http://en.wikipedia.org/wiki/Lorenz_equation} for further details. The variable @var{x} has the values for the state variables, @var{y} has the results after each integration step. Both variables are column vectors, the variable @var{t} is the actual time stamp. There is no error handling implemented in this function to achieve the highest performance.
-%# @end deftypefn
 %#
 %# Run
 %# @example
@@ -28,6 +27,7 @@
 %# @end deftypefn
 %#
 %# @seealso{odepkg}
+
 %#
 %# - TODO - REWORK THE HELP TEXT ABOVE BECAUSE IT MAY NOT BE CORRECT -
 
@@ -60,4 +60,4 @@
 
 %# Local Variables: ***
 %# mode: octave ***
-%# End: ***
\ No newline at end of file
+%# End: ***
--- a/main/odepkg/inst/odepkg_equations_pendulous.m	Sun Oct 22 17:49:59 2006 +0000
+++ b/main/odepkg/inst/odepkg_equations_pendulous.m	Sun Oct 22 21:20:30 2006 +0000
@@ -18,7 +18,6 @@
 %# -*- texinfo -*-
 %# @deftypefn {Function} {@var{[ydot]} =} odepkg_equations_pendulous (@var{tvar}, @var{xvar})
 %# Returns the states of the differential equations from a pendulum implementation, i.e. the motion of a simple pendulum with damping. The first state variable @var{ydot(1,1)} describes the angular position and the second state variable @var{ydot(2,1)} describes the velocity of the pendulum. The variables @var{xvar} and @var{ydot} are column vectors, the variable @var{tvar} is the actual time stamp. There is no error handling implemented in this function to achieve the highest processing speed.
-%# @end deftypefn
 %#
 %# Run
 %# @example
--- a/main/odepkg/inst/odepkg_equations_roessler.m	Sun Oct 22 17:49:59 2006 +0000
+++ b/main/odepkg/inst/odepkg_equations_roessler.m	Sun Oct 22 21:20:30 2006 +0000
@@ -18,7 +18,6 @@
 %# -*- texinfo -*-
 %# @deftypefn {Function} {@var{[y]} =} odepkg_equations_roessler (@var{t}, @var{x})
 %# TODO
-%# @end deftypefn
 %#
 %# Run
 %# @example
@@ -28,6 +27,7 @@
 %# @end deftypefn
 %#
 %# @seealso{odepkg}
+
 %#
 %# - TODO - REWORK THE HELP TEXT ABOVE BECAUSE IT MAY NOT BE CORRECT -
 %# - TODO - REWORK THE DEMO TEXT BELOW BECAUSE IT MAY NOT BE CORRECT -
@@ -59,4 +59,4 @@
 
 %# Local Variables: ***
 %# mode: octave ***
-%# End: ***
\ No newline at end of file
+%# End: ***