Mercurial > forge

changeset 10658:9410f33d70f5 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
control: doc enhancements
author paramaniac
date Wed, 08 Aug 2012 15:56:29 +0000
parents fcb0502d32bd
children 0acb5a37e057
files main/control/inst/WestlandLynx.m main/control/inst/augw.m main/control/inst/btamodred.m main/control/inst/mixsyn.m main/control/inst/spamodred.m
diffstat 5 files changed, 31 insertions(+), 42 deletions(-) [+]
line wrap: on
line diff
--- a/main/control/inst/WestlandLynx.m	Wed Aug 08 13:19:12 2012 +0000
+++ b/main/control/inst/WestlandLynx.m	Wed Aug 08 15:56:29 2012 +0000
@@ -34,14 +34,12 @@
 ## pitch rate               q           [rad/s]
 ## @end group
 ## @end example
-## @example
-## @group
-## Reference:
-## Skogestad, S. and Postlethwaite I.
-## Multivariable Feedback Control: Analysis and Design
-## Second Edition
-## Wiley 2005
-## http://www.nt.ntnu.no/users/skoge/book/2nd_edition/matlab_m/matfiles.html
+##
+## @strong{References}@*
+## [1] Skogestad, S. and Postlethwaite I. (2005)
+## @cite{Multivariable Feedback Control: Analysis and Design:
+## Second Edition}.  Wiley.
+## @url{http://www.nt.ntnu.no/users/skoge/book/2nd_edition/matlab_m/matfiles.html}
 ## @end group
 ## @end example
 ## @end deftypefn
--- a/main/control/inst/augw.m	Wed Aug 08 13:19:12 2012 +0000
+++ b/main/control/inst/augw.m	Wed Aug 08 15:56:29 2012 +0000
@@ -93,16 +93,12 @@
 ##                +--------+
 ## @end group
 ## @end example
-## @example
-## @group
-## Reference:
-## Skogestad, S. and Postlethwaite I.
-## Multivariable Feedback Control: Analysis and Design
-## Second Edition
-## Wiley 2005
-## Chapter 3.8: General Control Problem Formulation
-## @end group
-## @end example
+##
+## @strong{References}@*
+## [1] Skogestad, S. and Postlethwaite I. (2005)
+## @cite{Multivariable Feedback Control: Analysis and Design:
+## Second Edition}.  Wiley.
+##
 ## @seealso{h2syn, hinfsyn, mixsyn}
 ## @end deftypefn
 
--- a/main/control/inst/btamodred.m	Wed Aug 08 13:19:12 2012 +0000
+++ b/main/control/inst/btamodred.m	Wed Aug 08 15:56:29 2012 +0000
@@ -211,23 +211,23 @@
 ##
 ## @strong{References}@*
 ## [1] Enns, D.
-## Model reduction with balanced realizations: An error bound
-## and a frequency weighted generalization.
+## @cite{Model reduction with balanced realizations: An error bound
+## and a frequency weighted generalization}.
 ## Proc. 23-th CDC, Las Vegas, pp. 127-132, 1984.
 ##
 ## [2] Lin, C.-A. and Chiu, T.-Y.
-## Model reduction via frequency-weighted balanced realization.
+## @cite{Model reduction via frequency-weighted balanced realization}.
 ## Control Theory and Advanced Technology, vol. 8,
 ## pp. 341-351, 1992.
 ##
 ## [3] Sreeram, V., Anderson, B.D.O and Madievski, A.G.
-## New results on frequency weighted balanced reduction
-## technique.
+## @cite{New results on frequency weighted balanced reduction
+## technique}.
 ## Proc. ACC, Seattle, Washington, pp. 4004-4009, 1995.
 ##
 ## [4] Varga, A. and Anderson, B.D.O.
-## Square-root balancing-free methods for the frequency-weighted
-## balancing related model reduction.
+## @cite{Square-root balancing-free methods for the frequency-weighted
+## balancing related model reduction}.
 ## (report in preparation)
 ##
 ##
--- a/main/control/inst/mixsyn.m	Wed Aug 08 13:19:12 2012 +0000
+++ b/main/control/inst/mixsyn.m	Wed Aug 08 15:56:29 2012 +0000
@@ -124,22 +124,17 @@
 ## Closed Loop:     T = feedback (L)
 ## @end group
 ## @end example
-## @example
-## @group
-## Reference:
-## Skogestad, S. and Postlethwaite I.
-## Multivariable Feedback Control: Analysis and Design
-## Second Edition
-## Wiley 2005
-## Chapter 3.8: General Control Problem Formulation
-## @end group
-## @end example
 ##
 ## @strong{Algorithm}@*
 ## Relies on commands @command{augw} and @command{hinfsyn},
 ## which use SLICOT SB10FD and SB10DD by courtesy of
 ## @uref{http://www.slicot.org, NICONET e.V.}
 ##
+## @strong{References}@*
+## [1] Skogestad, S. and Postlethwaite I. (2005)
+## @cite{Multivariable Feedback Control: Analysis and Design:
+## Second Edition}.  Wiley.
+##
 ## @seealso{hinfsyn, augw}
 ## @end deftypefn
 
--- a/main/control/inst/spamodred.m	Wed Aug 08 13:19:12 2012 +0000
+++ b/main/control/inst/spamodred.m	Wed Aug 08 15:56:29 2012 +0000
@@ -194,23 +194,23 @@
 ##
 ## @strong{References}@*
 ## [1] Enns, D.
-## Model reduction with balanced realizations: An error bound
-## and a frequency weighted generalization.
+## @cite{Model reduction with balanced realizations: An error bound
+## and a frequency weighted generalization}.
 ## Proc. 23-th CDC, Las Vegas, pp. 127-132, 1984.
 ##
 ## [2] Lin, C.-A. and Chiu, T.-Y.
-## Model reduction via frequency-weighted balanced realization.
+## @cite{Model reduction via frequency-weighted balanced realization}.
 ## Control Theory and Advanced Technology, vol. 8,
 ## pp. 341-351, 1992.
 ##
 ## [3] Sreeram, V., Anderson, B.D.O and Madievski, A.G.
-## New results on frequency weighted balanced reduction
-## technique.
+## @cite{New results on frequency weighted balanced reduction
+## technique}.
 ## Proc. ACC, Seattle, Washington, pp. 4004-4009, 1995.
 ##
 ## [4] Varga, A. and Anderson, B.D.O.
-## Square-root balancing-free methods for the frequency-weighted
-## balancing related model reduction.
+## @cite{Square-root balancing-free methods for the frequency-weighted
+## balancing related model reduction}.
 ## (report in preparation)
 ##
 ##