aboutsummaryrefslogtreecommitdiffstats
path: root/src/data.c
diff options
context:
space:
mode:
authorRichard M. Stallman1997-07-18 18:17:20 +0000
committerRichard M. Stallman1997-07-18 18:17:20 +0000
commitc21241654f763ce51f276c4c71708f3c80d3868e (patch)
tree99e3369d24c6b9b0264d1b82ec532b1b9c390dc1 /src/data.c
parentba704fd4ca1a34291a8082f1ce266181f2816122 (diff)
downloademacs-c21241654f763ce51f276c4c71708f3c80d3868e.tar.gz
emacs-c21241654f763ce51f276c4c71708f3c80d3868e.zip
Many doc fixes.
Diffstat (limited to 'src/data.c')
-rw-r--r--src/data.c70
1 files changed, 35 insertions, 35 deletions
diff --git a/src/data.c b/src/data.c
index f2dd58344d9..942a4f4bed5 100644
--- a/src/data.c
+++ b/src/data.c
@@ -179,7 +179,7 @@ sign_extend_lisp_int (num)
179/* Data type predicates */ 179/* Data type predicates */
180 180
181DEFUN ("eq", Feq, Seq, 2, 2, 0, 181DEFUN ("eq", Feq, Seq, 2, 2, 0,
182 "T if the two args are the same Lisp object.") 182 "Return t if the two args are the same Lisp object.")
183 (obj1, obj2) 183 (obj1, obj2)
184 Lisp_Object obj1, obj2; 184 Lisp_Object obj1, obj2;
185{ 185{
@@ -188,7 +188,7 @@ DEFUN ("eq", Feq, Seq, 2, 2, 0,
188 return Qnil; 188 return Qnil;
189} 189}
190 190
191DEFUN ("null", Fnull, Snull, 1, 1, 0, "T if OBJECT is nil.") 191DEFUN ("null", Fnull, Snull, 1, 1, 0, "Return t if OBJECT is nil.")
192 (object) 192 (object)
193 Lisp_Object object; 193 Lisp_Object object;
194{ 194{
@@ -261,7 +261,7 @@ for example, (type-of 1) returns `integer'.")
261 } 261 }
262} 262}
263 263
264DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0, "T if OBJECT is a cons cell.") 264DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0, "Return t if OBJECT is a cons cell.")
265 (object) 265 (object)
266 Lisp_Object object; 266 Lisp_Object object;
267{ 267{
@@ -270,7 +270,7 @@ DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0, "T if OBJECT is a cons cell.")
270 return Qnil; 270 return Qnil;
271} 271}
272 272
273DEFUN ("atom", Fatom, Satom, 1, 1, 0, "T if OBJECT is not a cons cell. This includes nil.") 273DEFUN ("atom", Fatom, Satom, 1, 1, 0, "Return t if OBJECT is not a cons cell. This includes nil.")
274 (object) 274 (object)
275 Lisp_Object object; 275 Lisp_Object object;
276{ 276{
@@ -279,7 +279,7 @@ DEFUN ("atom", Fatom, Satom, 1, 1, 0, "T if OBJECT is not a cons cell. This inc
279 return Qt; 279 return Qt;
280} 280}
281 281
282DEFUN ("listp", Flistp, Slistp, 1, 1, 0, "T if OBJECT is a list. This includes nil.") 282DEFUN ("listp", Flistp, Slistp, 1, 1, 0, "Return t if OBJECT is a list. This includes nil.")
283 (object) 283 (object)
284 Lisp_Object object; 284 Lisp_Object object;
285{ 285{
@@ -288,7 +288,7 @@ DEFUN ("listp", Flistp, Slistp, 1, 1, 0, "T if OBJECT is a list. This includes
288 return Qnil; 288 return Qnil;
289} 289}
290 290
291DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0, "T if OBJECT is not a list. Lists include nil.") 291DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0, "Return t if OBJECT is not a list. Lists include nil.")
292 (object) 292 (object)
293 Lisp_Object object; 293 Lisp_Object object;
294{ 294{
@@ -297,7 +297,7 @@ DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0, "T if OBJECT is not a list. Lists i
297 return Qt; 297 return Qt;
298} 298}
299 299
300DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0, "T if OBJECT is a symbol.") 300DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0, "Return t if OBJECT is a symbol.")
301 (object) 301 (object)
302 Lisp_Object object; 302 Lisp_Object object;
303{ 303{
@@ -306,7 +306,7 @@ DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0, "T if OBJECT is a symbol.")
306 return Qnil; 306 return Qnil;
307} 307}
308 308
309DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0, "T if OBJECT is a vector.") 309DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0, "Return t if OBJECT is a vector.")
310 (object) 310 (object)
311 Lisp_Object object; 311 Lisp_Object object;
312{ 312{
@@ -315,7 +315,7 @@ DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0, "T if OBJECT is a vector.")
315 return Qnil; 315 return Qnil;
316} 316}
317 317
318DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0, "T if OBJECT is a string.") 318DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0, "Return t if OBJECT is a string.")
319 (object) 319 (object)
320 Lisp_Object object; 320 Lisp_Object object;
321{ 321{
@@ -324,7 +324,7 @@ DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0, "T if OBJECT is a string.")
324 return Qnil; 324 return Qnil;
325} 325}
326 326
327DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0, "T if OBJECT is a char-table.") 327DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0, "Return t if OBJECT is a char-table.")
328 (object) 328 (object)
329 Lisp_Object object; 329 Lisp_Object object;
330{ 330{
@@ -335,7 +335,7 @@ DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0, "T if OBJECT is a
335 335
336DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p, 336DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
337 Svector_or_char_table_p, 1, 1, 0, 337 Svector_or_char_table_p, 1, 1, 0,
338 "T if OBJECT is a char-table or vector.") 338 "Return t if OBJECT is a char-table or vector.")
339 (object) 339 (object)
340 Lisp_Object object; 340 Lisp_Object object;
341{ 341{
@@ -344,7 +344,7 @@ DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
344 return Qnil; 344 return Qnil;
345} 345}
346 346
347DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0, "T if OBJECT is a bool-vector.") 347DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0, "Return t if OBJECT is a bool-vector.")
348 (object) 348 (object)
349 Lisp_Object object; 349 Lisp_Object object;
350{ 350{
@@ -353,7 +353,7 @@ DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0, "T if OBJECT is
353 return Qnil; 353 return Qnil;
354} 354}
355 355
356DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0, "T if OBJECT is an array (string or vector).") 356DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0, "Return t if OBJECT is an array (string or vector).")
357 (object) 357 (object)
358 Lisp_Object object; 358 Lisp_Object object;
359{ 359{
@@ -364,7 +364,7 @@ DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0, "T if OBJECT is an array (string or
364} 364}
365 365
366DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0, 366DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
367 "T if OBJECT is a sequence (list or array).") 367 "Return t if OBJECT is a sequence (list or array).")
368 (object) 368 (object)
369 register Lisp_Object object; 369 register Lisp_Object object;
370{ 370{
@@ -374,7 +374,7 @@ DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
374 return Qnil; 374 return Qnil;
375} 375}
376 376
377DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0, "T if OBJECT is an editor buffer.") 377DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0, "Return t if OBJECT is an editor buffer.")
378 (object) 378 (object)
379 Lisp_Object object; 379 Lisp_Object object;
380{ 380{
@@ -383,7 +383,7 @@ DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0, "T if OBJECT is an editor buffer.
383 return Qnil; 383 return Qnil;
384} 384}
385 385
386DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0, "T if OBJECT is a marker (editor pointer).") 386DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0, "Return t if OBJECT is a marker (editor pointer).")
387 (object) 387 (object)
388 Lisp_Object object; 388 Lisp_Object object;
389{ 389{
@@ -392,7 +392,7 @@ DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0, "T if OBJECT is a marker (editor
392 return Qnil; 392 return Qnil;
393} 393}
394 394
395DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0, "T if OBJECT is a built-in function.") 395DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0, "Return t if OBJECT is a built-in function.")
396 (object) 396 (object)
397 Lisp_Object object; 397 Lisp_Object object;
398{ 398{
@@ -402,7 +402,7 @@ DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0, "T if OBJECT is a built-in function.")
402} 402}
403 403
404DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p, 404DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
405 1, 1, 0, "T if OBJECT is a byte-compiled function object.") 405 1, 1, 0, "Return t if OBJECT is a byte-compiled function object.")
406 (object) 406 (object)
407 Lisp_Object object; 407 Lisp_Object object;
408{ 408{
@@ -412,7 +412,7 @@ DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
412} 412}
413 413
414DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0, 414DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
415 "T if OBJECT is a character (an integer) or a string.") 415 "Return t if OBJECT is a character (an integer) or a string.")
416 (object) 416 (object)
417 register Lisp_Object object; 417 register Lisp_Object object;
418{ 418{
@@ -421,7 +421,7 @@ DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
421 return Qnil; 421 return Qnil;
422} 422}
423 423
424DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0, "T if OBJECT is an integer.") 424DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0, "Return t if OBJECT is an integer.")
425 (object) 425 (object)
426 Lisp_Object object; 426 Lisp_Object object;
427{ 427{
@@ -431,7 +431,7 @@ DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0, "T if OBJECT is an integer.")
431} 431}
432 432
433DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0, 433DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
434 "T if OBJECT is an integer or a marker (editor pointer).") 434 "Return t if OBJECT is an integer or a marker (editor pointer).")
435 (object) 435 (object)
436 register Lisp_Object object; 436 register Lisp_Object object;
437{ 437{
@@ -441,7 +441,7 @@ DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1,
441} 441}
442 442
443DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0, 443DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
444 "T if OBJECT is a nonnegative integer.") 444 "Return t if OBJECT is a nonnegative integer.")
445 (object) 445 (object)
446 Lisp_Object object; 446 Lisp_Object object;
447{ 447{
@@ -451,7 +451,7 @@ DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
451} 451}
452 452
453DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0, 453DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
454 "T if OBJECT is a number (floating point or integer).") 454 "Return t if OBJECT is a number (floating point or integer).")
455 (object) 455 (object)
456 Lisp_Object object; 456 Lisp_Object object;
457{ 457{
@@ -463,7 +463,7 @@ DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
463 463
464DEFUN ("number-or-marker-p", Fnumber_or_marker_p, 464DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
465 Snumber_or_marker_p, 1, 1, 0, 465 Snumber_or_marker_p, 1, 1, 0,
466 "T if OBJECT is a number or a marker.") 466 "Return t if OBJECT is a number or a marker.")
467 (object) 467 (object)
468 Lisp_Object object; 468 Lisp_Object object;
469{ 469{
@@ -474,7 +474,7 @@ DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
474 474
475#ifdef LISP_FLOAT_TYPE 475#ifdef LISP_FLOAT_TYPE
476DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0, 476DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
477 "T if OBJECT is a floating point number.") 477 "Return t if OBJECT is a floating point number.")
478 (object) 478 (object)
479 Lisp_Object object; 479 Lisp_Object object;
480{ 480{
@@ -571,7 +571,7 @@ DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
571 571
572/* Extract and set components of symbols */ 572/* Extract and set components of symbols */
573 573
574DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0, "T if SYMBOL's value is not void.") 574DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0, "Return t if SYMBOL's value is not void.")
575 (symbol) 575 (symbol)
576 register Lisp_Object symbol; 576 register Lisp_Object symbol;
577{ 577{
@@ -587,7 +587,7 @@ DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0, "T if SYMBOL's value is not void.")
587 return (EQ (valcontents, Qunbound) ? Qnil : Qt); 587 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
588} 588}
589 589
590DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0, "T if SYMBOL's function definition is not void.") 590DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0, "Return t if SYMBOL's function definition is not void.")
591 (symbol) 591 (symbol)
592 register Lisp_Object symbol; 592 register Lisp_Object symbol;
593{ 593{
@@ -1086,7 +1086,7 @@ default_value (symbol)
1086} 1086}
1087 1087
1088DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0, 1088DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1089 "Return T if SYMBOL has a non-void default value.\n\ 1089 "Return t if SYMBOL has a non-void default value.\n\
1090This is the value that is seen in buffers that do not have their own values\n\ 1090This is the value that is seen in buffers that do not have their own values\n\
1091for this variable.") 1091for this variable.")
1092 (symbol) 1092 (symbol)
@@ -1794,7 +1794,7 @@ arithcompare (num1, num2, comparison)
1794} 1794}
1795 1795
1796DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0, 1796DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
1797 "T if two args, both numbers or markers, are equal.") 1797 "Return t if two args, both numbers or markers, are equal.")
1798 (num1, num2) 1798 (num1, num2)
1799 register Lisp_Object num1, num2; 1799 register Lisp_Object num1, num2;
1800{ 1800{
@@ -1802,7 +1802,7 @@ DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
1802} 1802}
1803 1803
1804DEFUN ("<", Flss, Slss, 2, 2, 0, 1804DEFUN ("<", Flss, Slss, 2, 2, 0,
1805 "T if first arg is less than second arg. Both must be numbers or markers.") 1805 "Return t if first arg is less than second arg. Both must be numbers or markers.")
1806 (num1, num2) 1806 (num1, num2)
1807 register Lisp_Object num1, num2; 1807 register Lisp_Object num1, num2;
1808{ 1808{
@@ -1810,7 +1810,7 @@ DEFUN ("<", Flss, Slss, 2, 2, 0,
1810} 1810}
1811 1811
1812DEFUN (">", Fgtr, Sgtr, 2, 2, 0, 1812DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
1813 "T if first arg is greater than second arg. Both must be numbers or markers.") 1813 "Return t if first arg is greater than second arg. Both must be numbers or markers.")
1814 (num1, num2) 1814 (num1, num2)
1815 register Lisp_Object num1, num2; 1815 register Lisp_Object num1, num2;
1816{ 1816{
@@ -1818,7 +1818,7 @@ DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
1818} 1818}
1819 1819
1820DEFUN ("<=", Fleq, Sleq, 2, 2, 0, 1820DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
1821 "T if first arg is less than or equal to second arg.\n\ 1821 "Return t if first arg is less than or equal to second arg.\n\
1822Both must be numbers or markers.") 1822Both must be numbers or markers.")
1823 (num1, num2) 1823 (num1, num2)
1824 register Lisp_Object num1, num2; 1824 register Lisp_Object num1, num2;
@@ -1827,7 +1827,7 @@ Both must be numbers or markers.")
1827} 1827}
1828 1828
1829DEFUN (">=", Fgeq, Sgeq, 2, 2, 0, 1829DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
1830 "T if first arg is greater than or equal to second arg.\n\ 1830 "Return t if first arg is greater than or equal to second arg.\n\
1831Both must be numbers or markers.") 1831Both must be numbers or markers.")
1832 (num1, num2) 1832 (num1, num2)
1833 register Lisp_Object num1, num2; 1833 register Lisp_Object num1, num2;
@@ -1836,14 +1836,14 @@ Both must be numbers or markers.")
1836} 1836}
1837 1837
1838DEFUN ("/=", Fneq, Sneq, 2, 2, 0, 1838DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
1839 "T if first arg is not equal to second arg. Both must be numbers or markers.") 1839 "Return t if first arg is not equal to second arg. Both must be numbers or markers.")
1840 (num1, num2) 1840 (num1, num2)
1841 register Lisp_Object num1, num2; 1841 register Lisp_Object num1, num2;
1842{ 1842{
1843 return arithcompare (num1, num2, notequal); 1843 return arithcompare (num1, num2, notequal);
1844} 1844}
1845 1845
1846DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0, "T if NUMBER is zero.") 1846DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0, "Return t if NUMBER is zero.")
1847 (number) 1847 (number)
1848 register Lisp_Object number; 1848 register Lisp_Object number;
1849{ 1849{