diff options
author | Pavel Janík <Pavel@Janik.cz> | 2001-10-20 20:56:10 +0000 |
---|---|---|
committer | Pavel Janík <Pavel@Janik.cz> | 2001-10-20 20:56:10 +0000 |
commit | fdb82f93376a6b495c573a6c788b807acffdbfa9 (patch) | |
tree | 107b731b733908446a3902f6ce0e4f2d23dcd8f9 /src/ccl.c | |
parent | c0a53abba1d89bb487e3a38a0e7336bdce46fd1d (diff) | |
download | emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.tar.gz |
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/ccl.c')
-rw-r--r-- | src/ccl.c | 126 |
1 files changed, 63 insertions, 63 deletions
diff --git a/src/ccl.c b/src/ccl.c index 52a4ff3c388..e8ddc959d2c 100644 --- a/src/ccl.c +++ b/src/ccl.c @@ -2010,9 +2010,9 @@ setup_ccl_program (ccl, ccl_prog) #ifdef emacs DEFUN ("ccl-program-p", Fccl_program_p, Sccl_program_p, 1, 1, 0, - "Return t if OBJECT is a CCL program name or a compiled CCL program code.\n\ -See the documentation of `define-ccl-program' for the detail of CCL program.") - (object) + doc: /* Return t if OBJECT is a CCL program name or a compiled CCL program code. +See the documentation of `define-ccl-program' for the detail of CCL program. */) + (object) Lisp_Object object; { Lisp_Object val; @@ -2032,22 +2032,22 @@ See the documentation of `define-ccl-program' for the detail of CCL program.") } DEFUN ("ccl-execute", Fccl_execute, Sccl_execute, 2, 2, 0, - "Execute CCL-PROGRAM with registers initialized by REGISTERS.\n\ -\n\ -CCL-PROGRAM is a CCL program name (symbol)\n\ -or compiled code generated by `ccl-compile' (for backward compatibility.\n\ -In the latter case, the execution overhead is bigger than in the former).\n\ -No I/O commands should appear in CCL-PROGRAM.\n\ -\n\ -REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value\n\ -for the Nth register.\n\ -\n\ -As side effect, each element of REGISTERS holds the value of\n\ -the corresponding register after the execution.\n\ -\n\ -See the documentation of `define-ccl-program' for a definition of CCL\n\ -programs.") - (ccl_prog, reg) + doc: /* Execute CCL-PROGRAM with registers initialized by REGISTERS. + +CCL-PROGRAM is a CCL program name (symbol) +or compiled code generated by `ccl-compile' (for backward compatibility. +In the latter case, the execution overhead is bigger than in the former). +No I/O commands should appear in CCL-PROGRAM. + +REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value +for the Nth register. + +As side effect, each element of REGISTERS holds the value of +the corresponding register after the execution. + +See the documentation of `define-ccl-program' for a definition of CCL +programs. */) + (ccl_prog, reg) Lisp_Object ccl_prog, reg; { struct ccl_program ccl; @@ -2077,31 +2077,31 @@ programs.") DEFUN ("ccl-execute-on-string", Fccl_execute_on_string, Sccl_execute_on_string, 3, 5, 0, - "Execute CCL-PROGRAM with initial STATUS on STRING.\n\ -\n\ -CCL-PROGRAM is a symbol registered by register-ccl-program,\n\ -or a compiled code generated by `ccl-compile' (for backward compatibility,\n\ -in this case, the execution is slower).\n\ -\n\ -Read buffer is set to STRING, and write buffer is allocated automatically.\n\ -\n\ -STATUS is a vector of [R0 R1 ... R7 IC], where\n\ - R0..R7 are initial values of corresponding registers,\n\ - IC is the instruction counter specifying from where to start the program.\n\ -If R0..R7 are nil, they are initialized to 0.\n\ -If IC is nil, it is initialized to head of the CCL program.\n\ -\n\ -If optional 4th arg CONTINUE is non-nil, keep IC on read operation\n\ -when read buffer is exausted, else, IC is always set to the end of\n\ -CCL-PROGRAM on exit.\n\ -\n\ -It returns the contents of write buffer as a string,\n\ - and as side effect, STATUS is updated.\n\ -If the optional 5th arg UNIBYTE-P is non-nil, the returned string\n\ -is a unibyte string. By default it is a multibyte string.\n\ -\n\ -See the documentation of `define-ccl-program' for the detail of CCL program.") - (ccl_prog, status, str, contin, unibyte_p) + doc: /* Execute CCL-PROGRAM with initial STATUS on STRING. + +CCL-PROGRAM is a symbol registered by register-ccl-program, +or a compiled code generated by `ccl-compile' (for backward compatibility, +in this case, the execution is slower). + +Read buffer is set to STRING, and write buffer is allocated automatically. + +STATUS is a vector of [R0 R1 ... R7 IC], where + R0..R7 are initial values of corresponding registers, + IC is the instruction counter specifying from where to start the program. +If R0..R7 are nil, they are initialized to 0. +If IC is nil, it is initialized to head of the CCL program. + +If optional 4th arg CONTINUE is non-nil, keep IC on read operation +when read buffer is exausted, else, IC is always set to the end of +CCL-PROGRAM on exit. + +It returns the contents of write buffer as a string, + and as side effect, STATUS is updated. +If the optional 5th arg UNIBYTE-P is non-nil, the returned string +is a unibyte string. By default it is a multibyte string. + +See the documentation of `define-ccl-program' for the detail of CCL program. */) + (ccl_prog, status, str, contin, unibyte_p) Lisp_Object ccl_prog, status, str, contin, unibyte_p; { Lisp_Object val; @@ -2167,11 +2167,11 @@ See the documentation of `define-ccl-program' for the detail of CCL program.") DEFUN ("register-ccl-program", Fregister_ccl_program, Sregister_ccl_program, 2, 2, 0, - "Register CCL program CCL_PROG as NAME in `ccl-program-table'.\n\ -CCL_PROG should be a compiled CCL program (vector), or nil.\n\ -If it is nil, just reserve NAME as a CCL program name.\n\ -Return index number of the registered CCL program.") - (name, ccl_prog) + doc: /* Register CCL program CCL_PROG as NAME in `ccl-program-table'. +CCL_PROG should be a compiled CCL program (vector), or nil. +If it is nil, just reserve NAME as a CCL program name. +Return index number of the registered CCL program. */) + (name, ccl_prog) Lisp_Object name, ccl_prog; { int len = XVECTOR (Vccl_program_table)->size; @@ -2252,9 +2252,9 @@ Return index number of the registered CCL program.") DEFUN ("register-code-conversion-map", Fregister_code_conversion_map, Sregister_code_conversion_map, 2, 2, 0, - "Register SYMBOL as code conversion map MAP.\n\ -Return index number of the registered map.") - (symbol, map) + doc: /* Register SYMBOL as code conversion map MAP. +Return index number of the registered map. */) + (symbol, map) Lisp_Object symbol, map; { int len = XVECTOR (Vcode_conversion_map_vector)->size; @@ -2319,20 +2319,20 @@ syms_of_ccl () staticpro (&Qcode_conversion_map_id); DEFVAR_LISP ("code-conversion-map-vector", &Vcode_conversion_map_vector, - "Vector of code conversion maps."); + doc: /* Vector of code conversion maps. */); Vcode_conversion_map_vector = Fmake_vector (make_number (16), Qnil); DEFVAR_LISP ("font-ccl-encoder-alist", &Vfont_ccl_encoder_alist, - "Alist of fontname patterns vs corresponding CCL program.\n\ -Each element looks like (REGEXP . CCL-CODE),\n\ - where CCL-CODE is a compiled CCL program.\n\ -When a font whose name matches REGEXP is used for displaying a character,\n\ - CCL-CODE is executed to calculate the code point in the font\n\ - from the charset number and position code(s) of the character which are set\n\ - in CCL registers R0, R1, and R2 before the execution.\n\ -The code point in the font is set in CCL registers R1 and R2\n\ - when the execution terminated.\n\ -If the font is single-byte font, the register R2 is not used."); + doc: /* Alist of fontname patterns vs corresponding CCL program. +Each element looks like (REGEXP . CCL-CODE), + where CCL-CODE is a compiled CCL program. +When a font whose name matches REGEXP is used for displaying a character, + CCL-CODE is executed to calculate the code point in the font + from the charset number and position code(s) of the character which are set + in CCL registers R0, R1, and R2 before the execution. +The code point in the font is set in CCL registers R1 and R2 + when the execution terminated. + If the font is single-byte font, the register R2 is not used. */); Vfont_ccl_encoder_alist = Qnil; defsubr (&Sccl_program_p); |