diff libinterp/parse-tree/pt-arg-list.cc @ 17756:9aff1c9fd70f

doc: Add missing functions to manual. * doc/interpreter/doccheck/mk_undocumented_list: Mark 'end' as an exception not required to be in manual. * doc/interpreter/gui.txi: Add isguirunning() and desktop() to list of GUI utility functions. * doc/interpreter/octave.texi: Add new subsection "Missing Components" to menu. * doc/interpreter/package.txi: Add "Missing Components" section with DOCSTRING reference for missing_component_hook(). * libinterp/corefcn/variables.cc: Add seealso links between missing_component_hook() and missing_function_hook(). * libinterp/parse-tree/pt-arg-list.cc(Fend): Write docstring for 'end' index keyword.
author Rik <rik@octave.org>
date Thu, 24 Oct 2013 14:44:23 -0700
parents d63878346099
children 175b392e91fe
line wrap: on
line diff
--- a/libinterp/parse-tree/pt-arg-list.cc
+++ b/libinterp/parse-tree/pt-arg-list.cc
@@ -127,7 +127,26 @@
 static int num_indices = 0;
 
 DEFCONSTFUN (end, , ,
-  "internal function")
+  "-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {} end\n\
+The magic index @qcode{\"end\"} refers to the last valid entry in an indexing\n\
+operation.\n\
+\n\
+Example:\n\
+\n\
+@example\n\
+@group\n\
+@var{x} = [ 1 2 3 \n\
+      4 5 6 ];\n\
+@var{x}(1,end)\n\
+    @result{} 3\n\
+@var{x}(end,1)\n\
+    @result{} 4\n\
+@var{x}(end,end)\n\
+    @result{} 6\n\
+@end group\n\
+@end example\n\
+@end deftypefn")
 {
   octave_value retval;