diff options
| author | Pavel Janík | 2001-10-20 20:56:10 +0000 |
|---|---|---|
| committer | Pavel Janík | 2001-10-20 20:56:10 +0000 |
| commit | fdb82f93376a6b495c573a6c788b807acffdbfa9 (patch) | |
| tree | 107b731b733908446a3902f6ce0e4f2d23dcd8f9 /src/category.c | |
| parent | c0a53abba1d89bb487e3a38a0e7336bdce46fd1d (diff) | |
| download | emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.tar.gz emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.zip | |
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/category.c')
| -rw-r--r-- | src/category.c | 168 |
1 files changed, 84 insertions, 84 deletions
diff --git a/src/category.c b/src/category.c index c09e32e8d47..40804367528 100644 --- a/src/category.c +++ b/src/category.c | |||
| @@ -53,11 +53,11 @@ Lisp_Object _temp_category_set; | |||
| 53 | /* Category set staff. */ | 53 | /* Category set staff. */ |
| 54 | 54 | ||
| 55 | DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0, | 55 | DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0, |
| 56 | "Return a newly created category-set which contains CATEGORIES.\n\ | 56 | doc: /* Return a newly created category-set which contains CATEGORIES. |
| 57 | CATEGORIES is a string of category mnemonics.\n\ | 57 | CATEGORIES is a string of category mnemonics. |
| 58 | The value is a bool-vector which has t at the indices corresponding to\n\ | 58 | The value is a bool-vector which has t at the indices corresponding to |
| 59 | those categories.") | 59 | those categories. */) |
| 60 | (categories) | 60 | (categories) |
| 61 | Lisp_Object categories; | 61 | Lisp_Object categories; |
| 62 | { | 62 | { |
| 63 | Lisp_Object val; | 63 | Lisp_Object val; |
| @@ -87,12 +87,12 @@ those categories.") | |||
| 87 | Lisp_Object check_category_table (); | 87 | Lisp_Object check_category_table (); |
| 88 | 88 | ||
| 89 | DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0, | 89 | DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0, |
| 90 | "Define CHAR as a category which is described by DOCSTRING.\n\ | 90 | doc: /* Define CHAR as a category which is described by DOCSTRING. |
| 91 | CHAR should be an ASCII printing character in the range ` ' to `~'.\n\ | 91 | CHAR should be an ASCII printing character in the range ` ' to `~'. |
| 92 | DOCSTRING is a documentation string of the category.\n\ | 92 | DOCSTRING is a documentation string of the category. |
| 93 | The category is defined only in category table TABLE, which defaults to\n\ | 93 | The category is defined only in category table TABLE, which defaults to |
| 94 | the current buffer's category table.") | 94 | the current buffer's category table. */) |
| 95 | (category, docstring, table) | 95 | (category, docstring, table) |
| 96 | Lisp_Object category, docstring, table; | 96 | Lisp_Object category, docstring, table; |
| 97 | { | 97 | { |
| 98 | CHECK_CATEGORY (category, 0); | 98 | CHECK_CATEGORY (category, 0); |
| @@ -107,8 +107,8 @@ The category is defined only in category table TABLE, which defaults to\n\ | |||
| 107 | } | 107 | } |
| 108 | 108 | ||
| 109 | DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0, | 109 | DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0, |
| 110 | "Return the documentation string of CATEGORY, as defined in CATEGORY-TABLE.") | 110 | doc: /* Return the documentation string of CATEGORY, as defined in CATEGORY-TABLE. */) |
| 111 | (category, table) | 111 | (category, table) |
| 112 | Lisp_Object category, table; | 112 | Lisp_Object category, table; |
| 113 | { | 113 | { |
| 114 | CHECK_CATEGORY (category, 0); | 114 | CHECK_CATEGORY (category, 0); |
| @@ -119,11 +119,11 @@ DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0, | |||
| 119 | 119 | ||
| 120 | DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category, | 120 | DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category, |
| 121 | 0, 1, 0, | 121 | 0, 1, 0, |
| 122 | "Return a category which is not yet defined in CATEGORY-TABLE.\n\ | 122 | doc: /* Return a category which is not yet defined in CATEGORY-TABLE. If no |
| 123 | If no category remains available, return nil.\n\ | 123 | category remains available, return nil. The optional argument CATEGORY-TABLE |
| 124 | The optional argument CATEGORY-TABLE specifies which category table\n\ | 124 | specifies which category table to modify; it defaults to the current |
| 125 | to modify; it defaults to the current buffer's category table.") | 125 | buffer's category table. */) |
| 126 | (table) | 126 | (table) |
| 127 | Lisp_Object table; | 127 | Lisp_Object table; |
| 128 | { | 128 | { |
| 129 | int i; | 129 | int i; |
| @@ -141,8 +141,8 @@ to modify; it defaults to the current buffer's category table.") | |||
| 141 | /* Category-table staff. */ | 141 | /* Category-table staff. */ |
| 142 | 142 | ||
| 143 | DEFUN ("category-table-p", Fcategory_table_p, Scategory_table_p, 1, 1, 0, | 143 | DEFUN ("category-table-p", Fcategory_table_p, Scategory_table_p, 1, 1, 0, |
| 144 | "Return t if ARG is a category table.") | 144 | doc: /* Return t if ARG is a category table. */) |
| 145 | (arg) | 145 | (arg) |
| 146 | Lisp_Object arg; | 146 | Lisp_Object arg; |
| 147 | { | 147 | { |
| 148 | if (CHAR_TABLE_P (arg) | 148 | if (CHAR_TABLE_P (arg) |
| @@ -169,18 +169,18 @@ check_category_table (table) | |||
| 169 | } | 169 | } |
| 170 | 170 | ||
| 171 | DEFUN ("category-table", Fcategory_table, Scategory_table, 0, 0, 0, | 171 | DEFUN ("category-table", Fcategory_table, Scategory_table, 0, 0, 0, |
| 172 | "Return the current category table.\n\ | 172 | doc: /* Return the current category table. |
| 173 | This is the one specified by the current buffer.") | 173 | This is the one specified by the current buffer. */) |
| 174 | () | 174 | () |
| 175 | { | 175 | { |
| 176 | return current_buffer->category_table; | 176 | return current_buffer->category_table; |
| 177 | } | 177 | } |
| 178 | 178 | ||
| 179 | DEFUN ("standard-category-table", Fstandard_category_table, | 179 | DEFUN ("standard-category-table", Fstandard_category_table, |
| 180 | Sstandard_category_table, 0, 0, 0, | 180 | Sstandard_category_table, 0, 0, 0, |
| 181 | "Return the standard category table.\n\ | 181 | doc: /* Return the standard category table. |
| 182 | This is the one used for new buffers.") | 182 | This is the one used for new buffers. */) |
| 183 | () | 183 | () |
| 184 | { | 184 | { |
| 185 | return Vstandard_category_table; | 185 | return Vstandard_category_table; |
| 186 | } | 186 | } |
| @@ -238,9 +238,9 @@ copy_category_table (table) | |||
| 238 | 238 | ||
| 239 | DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table, | 239 | DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table, |
| 240 | 0, 1, 0, | 240 | 0, 1, 0, |
| 241 | "Construct a new category table and return it.\n\ | 241 | doc: /* Construct a new category table and return it. |
| 242 | It is a copy of the TABLE, which defaults to the standard category table.") | 242 | It is a copy of the TABLE, which defaults to the standard category table. */) |
| 243 | (table) | 243 | (table) |
| 244 | Lisp_Object table; | 244 | Lisp_Object table; |
| 245 | { | 245 | { |
| 246 | if (!NILP (table)) | 246 | if (!NILP (table)) |
| @@ -253,8 +253,8 @@ It is a copy of the TABLE, which defaults to the standard category table.") | |||
| 253 | 253 | ||
| 254 | DEFUN ("make-category-table", Fmake_category_table, Smake_category_table, | 254 | DEFUN ("make-category-table", Fmake_category_table, Smake_category_table, |
| 255 | 0, 0, 0, | 255 | 0, 0, 0, |
| 256 | "Construct a new and empty category table and return it.") | 256 | doc: /* Construct a new and empty category table and return it. */) |
| 257 | () | 257 | () |
| 258 | { | 258 | { |
| 259 | Lisp_Object val; | 259 | Lisp_Object val; |
| 260 | 260 | ||
| @@ -266,8 +266,8 @@ DEFUN ("make-category-table", Fmake_category_table, Smake_category_table, | |||
| 266 | } | 266 | } |
| 267 | 267 | ||
| 268 | DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0, | 268 | DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0, |
| 269 | "Specify TABLE as the category table for the current buffer.") | 269 | doc: /* Specify TABLE as the category table for the current buffer. */) |
| 270 | (table) | 270 | (table) |
| 271 | Lisp_Object table; | 271 | Lisp_Object table; |
| 272 | { | 272 | { |
| 273 | int idx; | 273 | int idx; |
| @@ -281,8 +281,8 @@ DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0, | |||
| 281 | 281 | ||
| 282 | 282 | ||
| 283 | DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0, | 283 | DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0, |
| 284 | "Return the category set of CHAR.") | 284 | doc: /* Return the category set of CHAR. */) |
| 285 | (ch) | 285 | (ch) |
| 286 | Lisp_Object ch; | 286 | Lisp_Object ch; |
| 287 | { | 287 | { |
| 288 | CHECK_NUMBER (ch, 0); | 288 | CHECK_NUMBER (ch, 0); |
| @@ -291,11 +291,11 @@ DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0, | |||
| 291 | 291 | ||
| 292 | DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics, | 292 | DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics, |
| 293 | Scategory_set_mnemonics, 1, 1, 0, | 293 | Scategory_set_mnemonics, 1, 1, 0, |
| 294 | "Return a string containing mnemonics of the categories in CATEGORY-SET.\n\ | 294 | doc: /* Return a string containing mnemonics of the categories in CATEGORY-SET. |
| 295 | CATEGORY-SET is a bool-vector, and the categories \"in\" it are those\n\ | 295 | CATEGORY-SET is a bool-vector, and the categories \"in\" it are those |
| 296 | that are indexes where t occurs the bool-vector.\n\ | 296 | that are indexes where t occurs the bool-vector. |
| 297 | The return value is a string containing those same categories.") | 297 | The return value is a string containing those same categories. */) |
| 298 | (category_set) | 298 | (category_set) |
| 299 | Lisp_Object category_set; | 299 | Lisp_Object category_set; |
| 300 | { | 300 | { |
| 301 | int i, j; | 301 | int i, j; |
| @@ -357,12 +357,12 @@ set_category_set (category_set, category, val) | |||
| 357 | 357 | ||
| 358 | DEFUN ("modify-category-entry", Fmodify_category_entry, | 358 | DEFUN ("modify-category-entry", Fmodify_category_entry, |
| 359 | Smodify_category_entry, 2, 4, 0, | 359 | Smodify_category_entry, 2, 4, 0, |
| 360 | "Modify the category set of CHARACTER by adding CATEGORY to it.\n\ | 360 | doc: /* Modify the category set of CHARACTER by adding CATEGORY to it. |
| 361 | The category is changed only for table TABLE, which defaults to\n\ | 361 | The category is changed only for table TABLE, which defaults to |
| 362 | the current buffer's category table.\n\ | 362 | the current buffer's category table. |
| 363 | If optional fourth argument RESET is non-nil,\n\ | 363 | If optional fourth argument RESET is non-nil, |
| 364 | then delete CATEGORY from the category set instead of adding it.") | 364 | then delete CATEGORY from the category set instead of adding it. */) |
| 365 | (character, category, table, reset) | 365 | (character, category, table, reset) |
| 366 | Lisp_Object character, category, table, reset; | 366 | Lisp_Object character, category, table, reset; |
| 367 | { | 367 | { |
| 368 | int c, charset, c1, c2; | 368 | int c, charset, c1, c2; |
| @@ -553,9 +553,9 @@ describe_category_1 (vector) | |||
| 553 | } | 553 | } |
| 554 | 554 | ||
| 555 | DEFUN ("describe-categories", Fdescribe_categories, Sdescribe_categories, 0, 0, "", | 555 | DEFUN ("describe-categories", Fdescribe_categories, Sdescribe_categories, 0, 0, "", |
| 556 | "Describe the category specifications in the current category table.\n\ | 556 | doc: /* Describe the category specifications in the current category table. |
| 557 | The descriptions are inserted in a buffer, which is then displayed.") | 557 | The descriptions are inserted in a buffer, which is then displayed. */) |
| 558 | () | 558 | () |
| 559 | { | 559 | { |
| 560 | internal_with_output_to_temp_buffer | 560 | internal_with_output_to_temp_buffer |
| 561 | ("*Help*", describe_category_1, current_buffer->category_table); | 561 | ("*Help*", describe_category_1, current_buffer->category_table); |
| @@ -643,45 +643,45 @@ syms_of_category () | |||
| 643 | staticpro (&Qcategory_table_p); | 643 | staticpro (&Qcategory_table_p); |
| 644 | 644 | ||
| 645 | DEFVAR_LISP ("word-combining-categories", &Vword_combining_categories, | 645 | DEFVAR_LISP ("word-combining-categories", &Vword_combining_categories, |
| 646 | "List of pair (cons) of categories to determine word boundary.\n\ | 646 | doc: /* List of pair (cons) of categories to determine word boundary. |
| 647 | \n\ | 647 | |
| 648 | Emacs treats a sequence of word constituent characters as a single\n\ | 648 | Emacs treats a sequence of word constituent characters as a single |
| 649 | word (i.e. finds no word boundary between them) iff they belongs to\n\ | 649 | word (i.e. finds no word boundary between them) iff they belongs to |
| 650 | the same charset. But, exceptions are allowed in the following cases.\n\ | 650 | the same charset. But, exceptions are allowed in the following cases. |
| 651 | \n\ | 651 | |
| 652 | \(1) The case that characters are in different charsets is controlled\n\ | 652 | \(1) The case that characters are in different charsets is controlled |
| 653 | by the variable `word-combining-categories'.\n\ | 653 | by the variable `word-combining-categories'. |
| 654 | \n\ | 654 | |
| 655 | Emacs finds no word boundary between characters of different charsets\n\ | 655 | Emacs finds no word boundary between characters of different charsets |
| 656 | if they have categories matching some element of this list.\n\ | 656 | if they have categories matching some element of this list. |
| 657 | \n\ | 657 | |
| 658 | More precisely, if an element of this list is a cons of category CAT1\n\ | 658 | More precisely, if an element of this list is a cons of category CAT1 |
| 659 | and CAT2, and a multibyte character C1 which has CAT1 is followed by\n\ | 659 | and CAT2, and a multibyte character C1 which has CAT1 is followed by |
| 660 | C2 which has CAT2, there's no word boundary between C1 and C2.\n\ | 660 | C2 which has CAT2, there's no word boundary between C1 and C2. |
| 661 | \n\ | 661 | |
| 662 | For instance, to tell that ASCII characters and Latin-1 characters can\n\ | 662 | For instance, to tell that ASCII characters and Latin-1 characters can |
| 663 | form a single word, the element `(?l . ?l)' should be in this list\n\ | 663 | form a single word, the element `(?l . ?l)' should be in this list |
| 664 | because both characters have the category `l' (Latin characters).\n\ | 664 | because both characters have the category `l' (Latin characters). |
| 665 | \n\ | 665 | |
| 666 | \(2) The case that character are in the same charset is controlled by\n\ | 666 | \(2) The case that character are in the same charset is controlled by |
| 667 | the variable `word-separating-categories'.\n\ | 667 | the variable `word-separating-categories'. |
| 668 | \n\ | 668 | |
| 669 | Emacs find a word boundary between characters of the same charset\n\ | 669 | Emacs find a word boundary between characters of the same charset |
| 670 | if they have categories matching some element of this list.\n\ | 670 | if they have categories matching some element of this list. |
| 671 | \n\ | 671 | |
| 672 | More precisely, if an element of this list is a cons of category CAT1\n\ | 672 | More precisely, if an element of this list is a cons of category CAT1 |
| 673 | and CAT2, and a multibyte character C1 which has CAT1 is followed by\n\ | 673 | and CAT2, and a multibyte character C1 which has CAT1 is followed by |
| 674 | C2 which has CAT2, there's a word boundary between C1 and C2.\n\ | 674 | C2 which has CAT2, there's a word boundary between C1 and C2. |
| 675 | \n\ | 675 | |
| 676 | For instance, to tell that there's a word boundary between Japanese\n\ | 676 | For instance, to tell that there's a word boundary between Japanese |
| 677 | Hiragana and Japanese Kanji (both are in the same charset), the\n\ | 677 | Hiragana and Japanese Kanji (both are in the same charset), the |
| 678 | element `(?H . ?C) should be in this list."); | 678 | element `(?H . ?C) should be in this list. */); |
| 679 | 679 | ||
| 680 | Vword_combining_categories = Qnil; | 680 | Vword_combining_categories = Qnil; |
| 681 | 681 | ||
| 682 | DEFVAR_LISP ("word-separating-categories", &Vword_separating_categories, | 682 | DEFVAR_LISP ("word-separating-categories", &Vword_separating_categories, |
| 683 | "List of pair (cons) of categories to determine word boundary.\n\ | 683 | doc: /* List of pair (cons) of categories to determine word boundary. |
| 684 | See the documentation of the variable `word-combining-categories'."); | 684 | See the documentation of the variable `word-combining-categories'. */); |
| 685 | 685 | ||
| 686 | Vword_separating_categories = Qnil; | 686 | Vword_separating_categories = Qnil; |
| 687 | 687 | ||