% -*- texinfo -*- % @deftypefn {Function File} {} fixedpoint ('help') % @deftypefnx {Function File} {} fixedpoint ('info') % @deftypefnx {Function File} {} fixedpoint ('info', @var{mod}) % @deftypefnx {Function File} {} fixedpoint ('test') % @deftypefnx {Function File} {} fixedpoint ('test', @var{mod}) % % Manual and test code for the Octave Fixed Point toolbox. There are % 5 possible ways to call this function. % % @table @code % @item fixedpoint ('help') % Display this help message. Called with no arguments, this function also % displays this help message % @item fixedpoint ('info') % Open the Fixed Point toolbox manual % @item fixedpoint ('info', @var{mod}) % Open the Fixed Point toolbox manual at the section specified by % @var{mod} % @item fixedpoint ('test') % Run all of the test code for the Fixed Point toolbox. % @var{mod}. % @end table % % Valid values for the varibale @var{mod} are % % @table @asis % @item 'basics' % The section describing the use of the fixed point toolbox within Octave % @item 'programming' % The section descrining how to use the fixed-point type with oct-files % @item 'example' % The section describing an in-depth example of the use of the fixed-point % type % @item 'reference' % The refernce section of all of the specific fixed point operators and % functions % @end table % % Please note that this function file should be used as an example of the % use of this toolbox. % @end deftypefn