aboutsummaryrefslogtreecommitdiffstats
path: root/src/ccl.c
diff options
context:
space:
mode:
authorPavel Janík2001-10-20 20:56:10 +0000
committerPavel Janík2001-10-20 20:56:10 +0000
commitfdb82f93376a6b495c573a6c788b807acffdbfa9 (patch)
tree107b731b733908446a3902f6ce0e4f2d23dcd8f9 /src/ccl.c
parentc0a53abba1d89bb487e3a38a0e7336bdce46fd1d (diff)
downloademacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.tar.gz
emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.zip
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/ccl.c')
-rw-r--r--src/ccl.c126
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)
2010#ifdef emacs 2010#ifdef emacs
2011 2011
2012DEFUN ("ccl-program-p", Fccl_program_p, Sccl_program_p, 1, 1, 0, 2012DEFUN ("ccl-program-p", Fccl_program_p, Sccl_program_p, 1, 1, 0,
2013 "Return t if OBJECT is a CCL program name or a compiled CCL program code.\n\ 2013 doc: /* Return t if OBJECT is a CCL program name or a compiled CCL program code.
2014See the documentation of `define-ccl-program' for the detail of CCL program.") 2014See the documentation of `define-ccl-program' for the detail of CCL program. */)
2015 (object) 2015 (object)
2016 Lisp_Object object; 2016 Lisp_Object object;
2017{ 2017{
2018 Lisp_Object val; 2018 Lisp_Object val;
@@ -2032,22 +2032,22 @@ See the documentation of `define-ccl-program' for the detail of CCL program.")
2032} 2032}
2033 2033
2034DEFUN ("ccl-execute", Fccl_execute, Sccl_execute, 2, 2, 0, 2034DEFUN ("ccl-execute", Fccl_execute, Sccl_execute, 2, 2, 0,
2035 "Execute CCL-PROGRAM with registers initialized by REGISTERS.\n\ 2035 doc: /* Execute CCL-PROGRAM with registers initialized by REGISTERS.
2036\n\ 2036
2037CCL-PROGRAM is a CCL program name (symbol)\n\ 2037CCL-PROGRAM is a CCL program name (symbol)
2038or compiled code generated by `ccl-compile' (for backward compatibility.\n\ 2038or compiled code generated by `ccl-compile' (for backward compatibility.
2039In the latter case, the execution overhead is bigger than in the former).\n\ 2039In the latter case, the execution overhead is bigger than in the former).
2040No I/O commands should appear in CCL-PROGRAM.\n\ 2040No I/O commands should appear in CCL-PROGRAM.
2041\n\ 2041
2042REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value\n\ 2042REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value
2043for the Nth register.\n\ 2043for the Nth register.
2044\n\ 2044
2045As side effect, each element of REGISTERS holds the value of\n\ 2045As side effect, each element of REGISTERS holds the value of
2046the corresponding register after the execution.\n\ 2046the corresponding register after the execution.
2047\n\ 2047
2048See the documentation of `define-ccl-program' for a definition of CCL\n\ 2048See the documentation of `define-ccl-program' for a definition of CCL
2049programs.") 2049programs. */)
2050 (ccl_prog, reg) 2050 (ccl_prog, reg)
2051 Lisp_Object ccl_prog, reg; 2051 Lisp_Object ccl_prog, reg;
2052{ 2052{
2053 struct ccl_program ccl; 2053 struct ccl_program ccl;
@@ -2077,31 +2077,31 @@ programs.")
2077 2077
2078DEFUN ("ccl-execute-on-string", Fccl_execute_on_string, Sccl_execute_on_string, 2078DEFUN ("ccl-execute-on-string", Fccl_execute_on_string, Sccl_execute_on_string,
2079 3, 5, 0, 2079 3, 5, 0,
2080 "Execute CCL-PROGRAM with initial STATUS on STRING.\n\ 2080 doc: /* Execute CCL-PROGRAM with initial STATUS on STRING.
2081\n\ 2081
2082CCL-PROGRAM is a symbol registered by register-ccl-program,\n\ 2082CCL-PROGRAM is a symbol registered by register-ccl-program,
2083or a compiled code generated by `ccl-compile' (for backward compatibility,\n\ 2083or a compiled code generated by `ccl-compile' (for backward compatibility,
2084in this case, the execution is slower).\n\ 2084in this case, the execution is slower).
2085\n\ 2085
2086Read buffer is set to STRING, and write buffer is allocated automatically.\n\ 2086Read buffer is set to STRING, and write buffer is allocated automatically.
2087\n\ 2087
2088STATUS is a vector of [R0 R1 ... R7 IC], where\n\ 2088STATUS is a vector of [R0 R1 ... R7 IC], where
2089 R0..R7 are initial values of corresponding registers,\n\ 2089 R0..R7 are initial values of corresponding registers,
2090 IC is the instruction counter specifying from where to start the program.\n\ 2090 IC is the instruction counter specifying from where to start the program.
2091If R0..R7 are nil, they are initialized to 0.\n\ 2091If R0..R7 are nil, they are initialized to 0.
2092If IC is nil, it is initialized to head of the CCL program.\n\ 2092If IC is nil, it is initialized to head of the CCL program.
2093\n\ 2093
2094If optional 4th arg CONTINUE is non-nil, keep IC on read operation\n\ 2094If optional 4th arg CONTINUE is non-nil, keep IC on read operation
2095when read buffer is exausted, else, IC is always set to the end of\n\ 2095when read buffer is exausted, else, IC is always set to the end of
2096CCL-PROGRAM on exit.\n\ 2096CCL-PROGRAM on exit.
2097\n\ 2097
2098It returns the contents of write buffer as a string,\n\ 2098It returns the contents of write buffer as a string,
2099 and as side effect, STATUS is updated.\n\ 2099 and as side effect, STATUS is updated.
2100If the optional 5th arg UNIBYTE-P is non-nil, the returned string\n\ 2100If the optional 5th arg UNIBYTE-P is non-nil, the returned string
2101is a unibyte string. By default it is a multibyte string.\n\ 2101is a unibyte string. By default it is a multibyte string.
2102\n\ 2102
2103See the documentation of `define-ccl-program' for the detail of CCL program.") 2103See the documentation of `define-ccl-program' for the detail of CCL program. */)
2104 (ccl_prog, status, str, contin, unibyte_p) 2104 (ccl_prog, status, str, contin, unibyte_p)
2105 Lisp_Object ccl_prog, status, str, contin, unibyte_p; 2105 Lisp_Object ccl_prog, status, str, contin, unibyte_p;
2106{ 2106{
2107 Lisp_Object val; 2107 Lisp_Object val;
@@ -2167,11 +2167,11 @@ See the documentation of `define-ccl-program' for the detail of CCL program.")
2167 2167
2168DEFUN ("register-ccl-program", Fregister_ccl_program, Sregister_ccl_program, 2168DEFUN ("register-ccl-program", Fregister_ccl_program, Sregister_ccl_program,
2169 2, 2, 0, 2169 2, 2, 0,
2170 "Register CCL program CCL_PROG as NAME in `ccl-program-table'.\n\ 2170 doc: /* Register CCL program CCL_PROG as NAME in `ccl-program-table'.
2171CCL_PROG should be a compiled CCL program (vector), or nil.\n\ 2171CCL_PROG should be a compiled CCL program (vector), or nil.
2172If it is nil, just reserve NAME as a CCL program name.\n\ 2172If it is nil, just reserve NAME as a CCL program name.
2173Return index number of the registered CCL program.") 2173Return index number of the registered CCL program. */)
2174 (name, ccl_prog) 2174 (name, ccl_prog)
2175 Lisp_Object name, ccl_prog; 2175 Lisp_Object name, ccl_prog;
2176{ 2176{
2177 int len = XVECTOR (Vccl_program_table)->size; 2177 int len = XVECTOR (Vccl_program_table)->size;
@@ -2252,9 +2252,9 @@ Return index number of the registered CCL program.")
2252DEFUN ("register-code-conversion-map", Fregister_code_conversion_map, 2252DEFUN ("register-code-conversion-map", Fregister_code_conversion_map,
2253 Sregister_code_conversion_map, 2253 Sregister_code_conversion_map,
2254 2, 2, 0, 2254 2, 2, 0,
2255 "Register SYMBOL as code conversion map MAP.\n\ 2255 doc: /* Register SYMBOL as code conversion map MAP.
2256Return index number of the registered map.") 2256Return index number of the registered map. */)
2257 (symbol, map) 2257 (symbol, map)
2258 Lisp_Object symbol, map; 2258 Lisp_Object symbol, map;
2259{ 2259{
2260 int len = XVECTOR (Vcode_conversion_map_vector)->size; 2260 int len = XVECTOR (Vcode_conversion_map_vector)->size;
@@ -2319,20 +2319,20 @@ syms_of_ccl ()
2319 staticpro (&Qcode_conversion_map_id); 2319 staticpro (&Qcode_conversion_map_id);
2320 2320
2321 DEFVAR_LISP ("code-conversion-map-vector", &Vcode_conversion_map_vector, 2321 DEFVAR_LISP ("code-conversion-map-vector", &Vcode_conversion_map_vector,
2322 "Vector of code conversion maps."); 2322 doc: /* Vector of code conversion maps. */);
2323 Vcode_conversion_map_vector = Fmake_vector (make_number (16), Qnil); 2323 Vcode_conversion_map_vector = Fmake_vector (make_number (16), Qnil);
2324 2324
2325 DEFVAR_LISP ("font-ccl-encoder-alist", &Vfont_ccl_encoder_alist, 2325 DEFVAR_LISP ("font-ccl-encoder-alist", &Vfont_ccl_encoder_alist,
2326 "Alist of fontname patterns vs corresponding CCL program.\n\ 2326 doc: /* Alist of fontname patterns vs corresponding CCL program.
2327Each element looks like (REGEXP . CCL-CODE),\n\ 2327Each element looks like (REGEXP . CCL-CODE),
2328 where CCL-CODE is a compiled CCL program.\n\ 2328 where CCL-CODE is a compiled CCL program.
2329When a font whose name matches REGEXP is used for displaying a character,\n\ 2329When a font whose name matches REGEXP is used for displaying a character,
2330 CCL-CODE is executed to calculate the code point in the font\n\ 2330 CCL-CODE is executed to calculate the code point in the font
2331 from the charset number and position code(s) of the character which are set\n\ 2331 from the charset number and position code(s) of the character which are set
2332 in CCL registers R0, R1, and R2 before the execution.\n\ 2332 in CCL registers R0, R1, and R2 before the execution.
2333The code point in the font is set in CCL registers R1 and R2\n\ 2333The code point in the font is set in CCL registers R1 and R2
2334 when the execution terminated.\n\ 2334 when the execution terminated.
2335If the font is single-byte font, the register R2 is not used."); 2335 If the font is single-byte font, the register R2 is not used. */);
2336 Vfont_ccl_encoder_alist = Qnil; 2336 Vfont_ccl_encoder_alist = Qnil;
2337 2337
2338 defsubr (&Sccl_program_p); 2338 defsubr (&Sccl_program_p);