← Back to branch summary

~ubuntu-branches/ubuntu/raring/octave-miscellaneous/raring

« back to all changes in this revision

Viewing changes to inst/infoskeleton.m

  • Committer: Package Import Robot
  • Author(s): Sébastien Villemot, Sébastien Villemot, Rafael Laboissiere
  • Date: 2012-04-02 13:20:23 UTC
  • mfrom: (8.1.4 sid)
  • Revision ID: package-import@ubuntu.com-20120402132023-03ksp2he2ty1qfis
Tags: 1.1.0-1
http://bugs.debian.org/666294
[ Sébastien Villemot ]
* Imported Upstream version 1.1.0
* debian/patches/match-cell-array.patch: remove patch (applied upstream)
* debian/patches/waitbar-rename.patch: remove patch (applied upstream)
* debian/patches/no-flexml.patch: remove obsolete patch, flex no longer used
  (Closes: #666294)
* debian/copyright: reflect upstream changes
* debian/octave-miscellaneous.docs: remove, no more docs in the package
* debian/clean: remove obsolete file
* debian/rules: remove hack for wrong permissions in upstream tarball

[ Rafael Laboissiere ]
* debian/watch: Use the SourceForge redirector

Show diffs side-by-side

added added

removed removed

Lines of Context:
inst/infoskeleton.m
1
 
## Copyright (C) 2008 Muthiah Annamalai
2
 
##
3
 
## This program is distributed in the hope that it will be useful,
4
 
## but WITHOUT ANY WARRANTY; without even the implied warranty of
5
 
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
6
 
## GNU General Public License for more details. 
7
 
##
8
 
## You should have received a copy of the GNU General Public License
9
 
## along with this program; If not, see <http://www.gnu.org/licenses/>.
10
 
##
 
1
## Copyright (C) 2008 Muthiah Annamalai <muthiah.annamalai@mavs.uta.edu>
 
2
##
 
3
## This program is free software; you can redistribute it and/or modify it under
 
4
## the terms of the GNU General Public License as published by the Free Software
 
5
## Foundation; either version 3 of the License, or (at your option) any later
 
6
## version.
 
7
##
 
8
## This program is distributed in the hope that it will be useful, but WITHOUT
 
9
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
10
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 
11
## details.
 
12
##
 
13
## You should have received a copy of the GNU General Public License along with
 
14
## this program; if not, see <http://www.gnu.org/licenses/>.
11
15
 
12
16
##-*- texinfo -*-
13
17
## @deftypefn{Function File} infoskeleton(@var{prototype}, @var{index_str}, @var{see_also})
14
 
## @cindex infoskeleton
15
 
## The function @var{infoskeleton} generates TeXinfo skeleton documentation of the
16
 
## given @var{prototype}. Optionally @var{index_str} and @var{see_also}
17
 
## can be specified. 
 
18
## Generate TeXinfo skeleton documentation of @var{prototype}.
 
19
##
 
20
## Optionally @var{index_str} and @var{see_also} can be specified.
18
21
##
19
22
## Usage of this function is typically,
20
23
## @example
89
92
  ## generate the code
90
93
  fprintf("## -*- texinfo -*-\n")
91
94
  if ( length( retval ) > 0 )
92
 
    fprintf("## @deftypefn{Function File} {@var{%s} = } %s (", \
93
 
            retval,fname );
 
95
    fprintf("## @deftypefn{Function File} {@var{%s} = } %s (", ...
 
96
            retval,fname );
94
97
  else
95
 
    fprintf("## @deftypefn{Function File} { } %s (", \
96
 
            fname );
 
98
    fprintf("## @deftypefn{Function File} { } %s (", ...
 
99
            fname );
97
100
  end
98
101
 
99
102
  pos = 0;
120
123
  fprintf("## @seealso{%s}\n",seealso);
121
124
  fprintf("## @end deftypefn\n");
122
125
end
123
 
##   examples: 
124
 
##   infoskeleton( ' [x,y,z]=infoskeleton(func , z , z9 , jj, fjh, x)  ')
125
 
##   infoskeleton('[V,Q] = eig( A )','linear algebra','eigs, chol, qr, det')
126
 
##   infoskeleton( 'function [x,y,z] =  indian_languages ( x)  ')
127
 
##
 
126
 
 
127
%!demo infoskeleton( ' [x,y,z]=infoskeleton(func , z , z9 , jj, fjh, x)  ')
 
128
%!demo infoskeleton('[V,Q] = eig( A )','linear algebra','eigs, chol, qr, det')
 
129
%!demo infoskeleton( 'function [x,y,z] =  indian_languages ( x)  ')