comparison src/strfns.cc @ 14093:050bc580cb60 stable

doc: Various docstring improvements before 3.6.0 release. * NEWS, aspell-octave.en.pws, intro.txi, oop.txi, testfun.txi, tips.txi, FIRfilter.m, FIRfilter_aggregation.m, polynomial.m, polynomial_superiorto.m, usejava.m, pcg.m, pcr.m, nchoosek.m, validatestring.m, assert.m, weekday.m, cellfun.cc, error.cc, strfns.cc: Various docstring improvements before 3.6.0 release.
author Rik <octave@nomad.inbox5.com>
date Wed, 21 Dec 2011 19:46:57 -0800
parents 5fa482628bf6
children 72c96de7a403
comparison
equal deleted inserted replaced
14092:22c50cbad2ce 14093:050bc580cb60
860 columns with an overall maximum width of @var{width}. The argument\n\ 860 columns with an overall maximum width of @var{width}. The argument\n\
861 @var{arg} must be a cell array of character strings or a character array.\n\ 861 @var{arg} must be a cell array of character strings or a character array.\n\
862 If @var{width} is not specified, the width of the terminal screen is used.\n\ 862 If @var{width} is not specified, the width of the terminal screen is used.\n\
863 Newline characters are used to break the lines in the output string.\n\ 863 Newline characters are used to break the lines in the output string.\n\
864 For example:\n\ 864 For example:\n\
865 \n\ 865 @c Set example in small font to prevent overfull line\n\
866 @example\n\ 866 \n\
867 @smallexample\n\
867 @group\n\ 868 @group\n\
868 list_in_columns (@{\"abc\", \"def\", \"ghijkl\", \"mnop\", \"qrs\", \"tuv\"@}, 20)\n\ 869 list_in_columns (@{\"abc\", \"def\", \"ghijkl\", \"mnop\", \"qrs\", \"tuv\"@}, 20)\n\
869 @result{} ans = abc mnop\n\ 870 @result{} ans = abc mnop\n\
870 def qrs\n\ 871 def qrs\n\
871 ghijkl tuv\n\ 872 ghijkl tuv\n\
878 ==== ==== ==== ===== =====\n\ 879 ==== ==== ==== ===== =====\n\
879 ans 1x37 37 char\n\ 880 ans 1x37 37 char\n\
880 \n\ 881 \n\
881 Total is 37 elements using 37 bytes\n\ 882 Total is 37 elements using 37 bytes\n\
882 @end group\n\ 883 @end group\n\
883 @end example\n\ 884 @end smallexample\n\
884 \n\ 885 \n\
885 @seealso{terminal_size}\n\ 886 @seealso{terminal_size}\n\
886 @end deftypefn") 887 @end deftypefn")
887 { 888 {
888 octave_value retval; 889 octave_value retval;