Added documentation

matlab/@dynSeries/subsref.m

-function B = subsref(ts, S)
-    if isequal(S.type,'.')
-        switch S.subs
-          case {'data','nobs','vobs','name','tex','freq','time','init','last'} % Public members.
-            B = builtin('subsref', ts, S);
-          case {'log','exp'}                                                   % Give "dot access" to public methods.
-            B = feval(S.subs,ts);
-          otherwise                                                            % Extract a sub-object by selecting one variable.
-            ndx = strmatch(S.subs,ts.name);
-            if ~isempty(ndx)
-                B = dynSeries();
-                B.data = ts.data(:,ndx);
-                B.name = deblank(ts.name(ndx,:));
-                B.tex  = deblank(ts.tex(ndx,:));
-                B.nobs = ts.nobs;
-                B.vobs = 1;
-                B.freq = ts.freq;
-                B.time = ts.time;
-                B.init = ts.init;
-                B.last = ts.last;
-                return
-            else
-                error('dynSeries::subsref: Unknown public method, public member or variable!')
-            end
+function us = subsref(ts, S)
+%@info:
+%! @deftypefn {Function File} {@var{us} =} subsref (@var{ts},S)
+%! @anchor{subsref}
+%! @sp 1
+%! Overloads the subsref method for the Dynare time series class (@ref{dynSeries}).
+%! @sp 2
+%! @strong{Inputs}
+%! @sp 1
+%! @table @ @var
+%! @item ts
+%! Dynare time series object instantiated by @ref{dynSeries}.
+%! @item S
+%! Matlab's structure array S with two fields, type and subs. The type field is string containing '()', '@{@}', or '.', where '()' specifies
+%! integer subscripts, '@{@}' specifies cell array subscripts, and '.' specifies subscripted structure fields. The subs field is a cell array
+%! or a string containing the actual subscripts (see matlab's documentation).
+%! @end table
+%! @sp 1
+%! @strong{Outputs}
+%! @sp 1
+%! @table @ @var
+%! @item us
+%! Dynare time series object. Depending on the calling sequence @var{us} is a transformation of @var{ts} obtained by applying a public method on @var{ts},
+%! or a dynSeries object built by extracting a variable from @var{ts}, or a dynSeries object containing a subsample of the all the variable in @var{ts}.
+%! @end table
+%! @sp 2
+%! @strong{Example 1.} Let @var{ts} be a dynSeries object containing three variables named 'A1', 'A2' and 'A3'. Then the following syntax:
+%! @example
+%!   us = ts.A1;
+%! @end example
+%!will create a new dynSeries object @var{us} containing the variable 'A1'.
+%! @sp 1
+%! @strong{Example 2.} Let @var{ts} be a dynSeries object. Then the following syntax:
+%! @example
+%!   us = ts.log;
+%! @end example
+%!will create a new dynSeries object @var{us} containing all the variables of @var{ts} transformed by the neperian logarithm.
+%! @sp 1
+%! @strong{Example 3.} Let @var{ts} be a dynSeries object. The following syntax:
+%! @example
+%!   us = ts(3:50);
+%! @end example
+%!will create a new dynSeries object @var{us} by selecting a subsample out of @var{ts}.
+%! @sp 2
+%! @strong{This function is called by:}
+%! @sp 2
+%! @strong{This function calls:}
+%! @ref{dynSeries}, @ref{log}, @ref{exp}
+%!
+%! @end deftypefn
+%@eod:
+
+if isequal(S.type,'.')
+    switch S.subs
+      case {'data','nobs','vobs','name','tex','freq','time','init','last'} % Public members.
+        us = builtin('subsref', ts, S);
+      case {'log','exp'}                                                   % Give "dot access" to public methods.
+        us = feval(S.subs,ts);
+      otherwise                                                            % Extract a sub-object by selecting one variable.
+        ndx = strmatch(S.subs,ts.name);
+        if ~isempty(ndx)
+            us = dynSeries();
+            us.data = ts.data(:,ndx);
+            us.name = deblank(ts.name(ndx,:));
+            us.tex  = deblank(ts.tex(ndx,:));
+            us.nobs = ts.nobs;
+            us.vobs = 1;
+            us.freq = ts.freq;
+            us.time = ts.time;
+            us.init = ts.init;
+            us.last = ts.last;
+            return
+        else
+            error('dynSeries::subsref: Unknown public method, public member or variable!')
         end
-        return
     end
-    if isequal(S.type,'()')                                                    % Extract a sub-object by selecting a sub-sample.
-        B = dynSeries();
-        if size(ts.data,2)>1
-            S.subs = [S.subs, ':'];
-        end
-        B.data = builtin('subsref', ts.data, S);
-        B.nobs = size(B.data,1);
-        B.vobs = ts.vobs;
-        B.freq = ts.freq;
-        B.time = builtin('subsref', ts.time, S);
-        B.init = B.time(1,:);
-        B.last = B.time(end,:);
-        B.name = ts.name;
-        B.tex  = ts.tex;
+    return
+end
+if isequal(S.type,'()')                                                    % Extract a sub-object by selecting a sub-sample.
+    us = dynSeries();
+    if size(ts.data,2)>1
+        S.subs = [S.subs, ':'];
     end
+    us.data = builtin('subsref', ts.data, S);
+    us.nobs = size(us.data,1);
+    us.vobs = ts.vobs;
+    us.freq = ts.freq;
+    us.time = builtin('subsref', ts.time, S);
+    us.init = us.time(1,:);
+    us.last = us.time(end,:);
+    us.name = ts.name;
+    us.tex  = ts.tex;
+end
 
 %@test:1
 %$ addpath ../matlab