Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[11025] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2012-09-15 07:07:25
|
Revision: 11025
http://octave.svn.sourceforge.net/octave/?rev=11025&view=rev
Author: paramaniac
Date: 2012-09-15 07:07:18 +0000 (Sat, 15 Sep 2012)
Log Message:
-----------
control: document multiplot feature in helpstring (deftypefn)
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/bode.m
trunk/octave-forge/main/control/inst/bodemag.m
trunk/octave-forge/main/control/inst/nichols.m
trunk/octave-forge/main/control/inst/nyquist.m
trunk/octave-forge/main/control/inst/pzmap.m
trunk/octave-forge/main/control/inst/sigma.m
Modified: trunk/octave-forge/main/control/inst/bode.m
===================================================================
--- trunk/octave-forge/main/control/inst/bode.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/bode.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -16,7 +16,11 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{mag}, @var{pha}, @var{w}] =} bode (@var{sys})
+## @deftypefn {Function File} bode (@var{sys})
+## @deftypefnx {Function File} bode (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} bode (@var{sys1}, @var{sys2}, @dots{}, @var{sysN}, @var{w})
+## @deftypefnx {Function File} bode (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
+## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} bode (@var{sys})
## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} bode (@var{sys}, @var{w})
## Bode diagram of frequency response. If no output arguments are given,
## the response is printed on the screen.
Modified: trunk/octave-forge/main/control/inst/bodemag.m
===================================================================
--- trunk/octave-forge/main/control/inst/bodemag.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/bodemag.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -16,7 +16,11 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{mag}, @var{w}] =} bodemag (@var{sys})
+## @deftypefn {Function File} bodemag (@var{sys})
+## @deftypefnx {Function File} bodemag (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} bodemag (@var{sys1}, @var{sys2}, @dots{}, @var{sysN}, @var{w})
+## @deftypefnx {Function File} bodemag (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
+## @deftypefnx {Function File} {[@var{mag}, @var{w}] =} bodemag (@var{sys})
## @deftypefnx {Function File} {[@var{mag}, @var{w}] =} bodemag (@var{sys}, @var{w})
## Bode magnitude diagram of frequency response. If no output arguments are given,
## the response is printed on the screen.
Modified: trunk/octave-forge/main/control/inst/nichols.m
===================================================================
--- trunk/octave-forge/main/control/inst/nichols.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/nichols.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -16,7 +16,11 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{mag}, @var{pha}, @var{w}] =} nichols (@var{sys})
+## @deftypefn {Function File} nichols (@var{sys})
+## @deftypefnx {Function File} nichols (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} nichols (@var{sys1}, @var{sys2}, @dots{}, @var{sysN}, @var{w})
+## @deftypefnx {Function File} nichols (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
+## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} nichols (@var{sys})
## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} nichols (@var{sys}, @var{w})
## Nichols chart of frequency response. If no output arguments are given,
## the response is printed on the screen.
Modified: trunk/octave-forge/main/control/inst/nyquist.m
===================================================================
--- trunk/octave-forge/main/control/inst/nyquist.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/nyquist.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -16,7 +16,11 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{re}, @var{im}, @var{w}] =} nyquist (@var{sys})
+## @deftypefn {Function File} nyquist (@var{sys})
+## @deftypefnx {Function File} nyquist (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} nyquist (@var{sys1}, @var{sys2}, @dots{}, @var{sysN}, @var{w})
+## @deftypefnx {Function File} nyquist (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
+## @deftypefnx {Function File} {[@var{re}, @var{im}, @var{w}] =} nyquist (@var{sys})
## @deftypefnx {Function File} {[@var{re}, @var{im}, @var{w}] =} nyquist (@var{sys}, @var{w})
## Nyquist diagram of frequency response. If no output arguments are given,
## the response is printed on the screen.
Modified: trunk/octave-forge/main/control/inst/pzmap.m
===================================================================
--- trunk/octave-forge/main/control/inst/pzmap.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/pzmap.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -17,6 +17,8 @@
## -*- texinfo -*-
## @deftypefn {Function File} pzmap (@var{sys})
+## @deftypefnx {Function File} pzmap (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} pzmap (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
## @deftypefnx {Function File} {[@var{p}, @var{z}] =} pzmap (@var{sys})
## Plot the poles and zeros of an LTI system in the complex plane.
## If no output arguments are given, the result is plotted on the screen.
Modified: trunk/octave-forge/main/control/inst/sigma.m
===================================================================
--- trunk/octave-forge/main/control/inst/sigma.m 2012-09-14 21:33:53 UTC (rev 11024)
+++ trunk/octave-forge/main/control/inst/sigma.m 2012-09-15 07:07:18 UTC (rev 11025)
@@ -16,7 +16,11 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys})
+## @deftypefn {Function File} sigma (@var{sys})
+## @deftypefnx {Function File} sigma (@var{sys1}, @var{sys2}, @dots{}, @var{sysN})
+## @deftypefnx {Function File} sigma (@var{sys1}, @var{sys2}, @dots{}, @var{sysN}, @var{w})
+## @deftypefnx {Function File} sigma (@var{sys1}, @var{'style1'}, @dots{}, @var{sysN}, @var{'styleN'})
+## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys})
## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys}, @var{w})
## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys}, @var{[]}, @var{ptype})
## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys}, @var{w}, @var{ptype})
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
