changeset 9601:3f9bfc8db45d octave-forge

control-devel: fix docstrings
author paramaniac
date Thu, 08 Mar 2012 16:22:56 +0000
parents e106e1d1c083
children ea1ae710473c
files extra/control-devel/inst/@iddata/get.m extra/control-devel/inst/@iddata/plot.m extra/control-devel/inst/@iddata/set.m
diffstat 3 files changed, 36 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/extra/control-devel/inst/@iddata/get.m	Thu Mar 08 16:21:23 2012 +0000
+++ b/extra/control-devel/inst/@iddata/get.m	Thu Mar 08 16:22:56 2012 +0000
@@ -17,8 +17,8 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} get (@var{sys})
-## @deftypefnx {Function File} {@var{value} =} get (@var{sys}, @var{"property"})
-## Access property values of LTI objects.
+## @deftypefnx {Function File} {@var{value} =} get (@var{dat}, @var{"property"})
+## Access property values of iddata objects.
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
--- a/extra/control-devel/inst/@iddata/plot.m	Thu Mar 08 16:21:23 2012 +0000
+++ b/extra/control-devel/inst/@iddata/plot.m	Thu Mar 08 16:22:56 2012 +0000
@@ -1,3 +1,29 @@
+## Copyright (C) 2012   Lukas F. Reichlin
+##
+## This file is part of LTI Syncope.
+##
+## LTI Syncope is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## LTI Syncope is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} plot (@var{dat})
+## Plot.
+## @end deftypefn
+
+## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
+## Created: February 2012
+## Version: 0.1
+
 function plot (dat)
 
   [n, p, m, e] = size (dat)
--- a/extra/control-devel/inst/@iddata/set.m	Thu Mar 08 16:21:23 2012 +0000
+++ b/extra/control-devel/inst/@iddata/set.m	Thu Mar 08 16:22:56 2012 +0000
@@ -16,14 +16,14 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} set (@var{sys})
-## @deftypefnx {Function File} set (@var{sys}, @var{"property"}, @var{value}, @dots{})
-## @deftypefnx {Function File} {@var{retsys} =} set (@var{sys}, @var{"property"}, @var{value}, @dots{})
-## Set or modify properties of LTI objects.
-## If no return argument @var{retsys} is specified, the modified LTI object is stored
-## in input argument @var{sys}.  @command{set} can handle multiple properties in one call:
-## @code{set (sys, 'prop1', val1, 'prop2', val2, 'prop3', val3)}.
-## @code{set (sys)} prints a list of the object's property names.
+## @deftypefn {Function File} set (@var{dat})
+## @deftypefnx {Function File} set (@var{retdat}, @var{"property"}, @var{value}, @dots{})
+## @deftypefnx {Function File} {@var{dat} =} set (@var{dat}, @var{"property"}, @var{value}, @dots{})
+## Set or modify properties of iddata objects.
+## If no return argument @var{retdat} is specified, the modified LTI object is stored
+## in input argument @var{dat}.  @command{set} can handle multiple properties in one call:
+## @code{set (dat, 'prop1', val1, 'prop2', val2, 'prop3', val3)}.
+## @code{set (dat)} prints a list of the object's property names.
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>