# HG changeset patch # User Luc Teirlinck # Date 1077248419 0 # Node ID 15dabc5988ff7be3478a01aee10b1bdad833be33 # Parent e83349d94786ebb548efa627cfb08626ee18df57 (Fdefine_category, Fcategory_docstring) (Fget_unused_category, Fset_category_table) (Fcategory_set_mnemonics): Doc fixes. diff -r e83349d94786 -r 15dabc5988ff src/category.c --- a/src/category.c Fri Feb 20 02:41:02 2004 +0000 +++ b/src/category.c Fri Feb 20 03:40:19 2004 +0000 @@ -87,11 +87,11 @@ Lisp_Object check_category_table (); DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0, - doc: /* Define CHAR as a category which is described by DOCSTRING. -CHAR should be an ASCII printing character in the range ` ' to `~'. -DOCSTRING is a documentation string of the category. + doc: /* Define CATEGORY as a category which is described by DOCSTRING. +CATEGORY should be an ASCII printing character in the range ` ' to `~'. +DOCSTRING is the documentation string of the category. The category is defined only in category table TABLE, which defaults to - the current buffer's category table. */) +the current buffer's category table. */) (category, docstring, table) Lisp_Object category, docstring, table; { @@ -107,7 +107,9 @@ } DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0, - doc: /* Return the documentation string of CATEGORY, as defined in CATEGORY-TABLE. */) + doc: /* Return the documentation string of CATEGORY, as defined in TABLE. +TABLE should be a category table and defaults to the current buffer's +category table. */) (category, table) Lisp_Object category, table; { @@ -119,10 +121,9 @@ DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category, 0, 1, 0, - doc: /* Return a category which is not yet defined in CATEGORY-TABLE. + doc: /* Return a category which is not yet defined in TABLE. If no category remains available, return nil. -The optional argument CATEGORY-TABLE -specifies which category table to modify; +The optional argument TABLE specifies which category table to modify; it defaults to the current buffer's category table. */) (table) Lisp_Object table; @@ -267,7 +268,8 @@ } DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0, - doc: /* Specify TABLE as the category table for the current buffer. */) + doc: /* Specify TABLE as the category table for the current buffer. +Return TABLE. */) (table) Lisp_Object table; { @@ -294,7 +296,7 @@ Scategory_set_mnemonics, 1, 1, 0, doc: /* Return a string containing mnemonics of the categories in CATEGORY-SET. CATEGORY-SET is a bool-vector, and the categories \"in\" it are those -that are indexes where t occurs the bool-vector. +that are indexes where t occurs in the bool-vector. The return value is a string containing those same categories. */) (category_set) Lisp_Object category_set;