formated source documentation pattern for generating docs

1 files changed, 14 insertions, 23 deletions

diff --git a/macros/invfreqz.sci b/macros/invfreqz.sci
index 433100b..ed60b7a 100644
--- a/macros/invfreqz.sci
+++ b/macros/invfreqz.sci
@@ -10,31 +10,22 @@
 // Organization: FOSSEE, IIT Bombay
 // Email: toolbox@scilab.in
 // FIXME: check invfreq.sci for todo's
-/*
-  : [B,A] = invfreqz(H,F,nB,nA) ¶
-  : [B,A] = invfreqz(H,F,nB,nA,W) ¶
-  : [B,A] = invfreqz(H,F,nB,nA,W,iter,tol,'trace') ¶
-
-  Fit filter B(z)/A(z)to the complex frequency response H at frequency points F.
-
-  A and B are real polynomial coefficients of order nA and nB. Optionally, the fit-errors can be weighted vs frequency according to the weights W.
-
-  Note: all the guts are in invfreq.m
-
-  H: desired complex frequency response
-
-  F: normalized frequency (0 to pi) (must be same length as H)
 
-  nA: order of the denominator polynomial A
-
-  nB: order of the numerator polynomial B
-
-  W: vector of weights (must be same length as F)
-
-*/
-// Dependencies
-// invfreq
 function [B, A, SigN] = invfreqz(H, F, nB, nA, W, iter, tol, tr, varargin)
+  // Fit filter B(z)/A(z)to the complex frequency response H at frequency points F.
+  // Calling Sequence
+  // [B,A] = invfreqz(H,F,nB,nA) ¶
+  // [B,A] = invfreqz(H,F,nB,nA,W) ¶
+  // [B,A] = invfreqz(H,F,nB,nA,W,iter,tol,'trace') ¶
+  // Parameters
+  // A and B are real polynomial coefficients of order nA and nB. Optionally, the fit-errors can be weighted vs frequency according to the weights W.
+  // H: desired complex frequency response
+  // F: normalized frequency (0 to pi) (must be same length as H)
+  // nA: order of the denominator polynomial A
+  // nB: order of the numerator polynomial B
+  // W: vector of weights (must be same length as F)
+// See also
+// invfreq
 
   if nargin < 9
     varargin = {};