Commit 237e5ad3 authored by Erick's avatar Erick

Fixed typos in Doc

parent a92c10e7
......@@ -18,7 +18,7 @@
;; USA.
;; Author: Erick Gallesio [eg@unice.fr]
;; Creation date: 26-Nov-2000 18:19 (eg)
;; Last file update: 6-Jul-2018 15:41 (eg)
;; Last file update: 6-Jul-2018 19:22 (eg)
;;
;; ======================================================================
......@@ -335,20 +335,26 @@ legibility.])))
(index "SRFI-13")
(p [The following string primitives are compatible with ,(link-srfi 13)
and their documentation comes from the SRFI document.])
(p [,(bold "Note:") The string SRFI is supported by ,(stklos). The
function listed below just don't need to load the full SRFI to be used])
(p [,(bold "Notes:")
,(itemize
(item [The string SRFI is supported by ,(stklos). The
function listed below just don't need to load the full SRFI to be
used])
(item [The functions ,(code "string-upcase"), ,(code "string-downcase") and
,(code "string-foldcase") are also defined in ,(rseven).]))])
(insertdoc 'string-downcase)
(insertdoc 'string-downcase!)
(insertdoc 'string-upcase)
(insertdoc 'string-upcase!)
(insertdoc 'string-titlecase)
(insertdoc 'string-titlecase!))
(insertdoc 'string-titlecase!)
(p [The functions ,(tt "string-foldcase") and ,(tt "string-foldcase!") described
below are inspired from R6RS.])
(insertdoc 'string-foldcase)
(insertdoc 'string-foldcase!)
)
;;;
......@@ -387,13 +393,15 @@ following: ,(fontified-code [#(0 (2 2 2 2) "Anna")])])
(insertdoc 'vector-set!)
(insertdoc 'list->vector)
(insertdoc 'string->vector)
(insertdoc 'vector-append)
(insertdoc 'vector-fill!)
(insertdoc 'vector-copy)
(insertdoc 'vector-copy!)
(insertdoc 'vector-resize)
(insertdoc 'vector-mutable?)
(insertdoc 'sort))
(insertdoc 'sort)
)
;;;
......@@ -443,8 +451,18 @@ when the bytevector is created. The ,(emph "valid indexes") of a
bytevector are the exact non-negative integers less than the length of
the bytevector, starting at index zero as with vectors.])
(p [Bytevectors are written using the notation ,(code "#u8(byte ...").
For example, a bytevector of length 3 containing the byte
0 in element 0, the byte 10 in element 1, and the byte 5 in
element 2 can be written as follows: ,(code "#u8(0 10 5)")])
(p [Bytevector constants are self-evaluating, so they do not
need to be quoted in programs.])
(insertdoc 'bytevector?)
(insertdoc 'make-bytevector)
(insertdoc 'bytevector)
(insertdoc 'bytevector-length)
(insertdoc 'bytevector-u8-ref)
(insertdoc 'bytevector-u8-set!)
......@@ -452,7 +470,7 @@ the bytevector, starting at index zero as with vectors.])
(insertdoc 'bytevector-copy!)
(insertdoc 'bytevector-copy-partial)
(insertdoc 'bytevector-copy-partial!)
)
)
;;;
......
;; ======================================================================
;;
;; STklos Reference Manual
;; STklos Reference Manual
;;
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
......@@ -18,7 +18,7 @@
;; USA.
;; Author: Erick Gallesio [eg@unice.fr]
;; Creation date: 26-Nov-2000 18:19 (eg)
;; Last file update: 14-Aug-2011 12:54 (eg)
;; Last file update: 6-Jul-2018 18:57 (eg)
;;
;; ======================================================================
......@@ -28,7 +28,7 @@
;; ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
(define stklos-language stklos) ;; Save stklos which will be redefined
(define stklos-language stklos) ;; Save stklos which will be redefined
(define (stklos) (sc "STklos"))
(define (stk) (sc "STk"))
......@@ -63,13 +63,13 @@
;;; Document
;;;
(document :title [STklos Reference Manual]
:subtitle [(version ,(begin *stklos-version*))]
:author (author :name (font :size "+2" (bold "Erick Gallesio"))
:affiliation "Université de Nice - Sophia Antipolis"
:address (list "930 route des Colles, BP 145"
"F-06903 Sophia Antipolis, Cedex"
"France"
*logo-for-tex*))
:subtitle [(version ,(begin *stklos-version*))]
:author (author :name (font :size "+2" (bold "Erick Gallesio"))
:affiliation "Université de Nice - Sophia Antipolis"
:address (list "930 route des Colles, BP 145"
"F-06903 Sophia Antipolis, Cedex"
"France"
*logo-for-tex*))
(linebreak 3)
[This document provides a complete list of procedures and special
......
......@@ -22,7 +22,7 @@
*
* Author: Erick Gallesio [eg@unice.fr]
* Creation date: ??????
* Last file update: 5-Jul-2018 17:20 (eg)
* Last file update: 6-Jul-2018 19:38 (eg)
*/
#include <ctype.h>
......@@ -540,8 +540,8 @@ DEFINE_PRIMITIVE("string-set!", string_set, subr3, (SCM str, SCM index, SCM valu
* characters in the same positions, otherwise returns |#f|. |String-ci=?|
* treats upper and lower case letters as though they were the same character,
* but |string=?| treats upper and lower case as distinct characters.
*
* ,@(bold "Note"): R5RS version of these functions accept only two arguments.
* @l
* ,(bold "Note"): R5RS version of these functions accept only two arguments.
doc>
*/
......@@ -562,8 +562,8 @@ doc>
* characters. If two strings differ in length but are the same up to the
* length of the shorter string, the shorter string is considered to be
* lexicographically less than the longer string.
*
* ,@(bold "Note"): R5RS version of these functions accept only two arguments.
* @l
* ,(bold "Note"): R5RS version of these functions accept only two arguments.
doc>
*/
......@@ -685,7 +685,8 @@ DEFINE_PRIMITIVE("string-append", string_append, vsubr, (int argc, SCM* argv))
* which must be a list of characters. |String->list| and
* |list->string| are inverses so far as |equal?| is concerned.
*
* ,@("Note"): The R5RS version of |string->list| accepts only one
* @l
* ,(bold "Note"): The R5RS version of |string->list| accepts only one
* parameter.
doc>
*/
......@@ -750,8 +751,8 @@ DEFINE_PRIMITIVE("list->string", list2string, subr1, (SCM l))
*
* Returns a newly allocated copy of the part of the given |string|
* between |start| and |stop|.
*
* ,@(bold "Note"): The R5RS version of |string-copy| accepts only one argument.
* @l
* ,(bold "Note"): The R5RS version of |string-copy| accepts only one argument.
doc>
*/
DEFINE_PRIMITIVE("string-copy", string_copy, vsubr, (int argc, SCM *argv))
......@@ -773,8 +774,8 @@ DEFINE_PRIMITIVE("string-copy", string_copy, vsubr, (int argc, SCM *argv))
* (string-fill! string char start end)
*
* Stores |char| in every element of the given |string| between |start| and |end|.
*
* ,@(bold "Note"): The R5RS version of |string-fill!| accepts only one argument.
* @l
* ,(bold "Note"): The R5RS version of |string-fill!| accepts only one argument.
doc>
*/
DEFINE_PRIMITIVE("string-fill!", string_fill, subr2, (SCM str, SCM c))
......@@ -968,7 +969,7 @@ DEFINE_PRIMITIVE("string-mutable?", string_mutable, subr1, (SCM obj))
/*
<doc EXT string-downcase
<doc R7RS string-downcase
* (string-downcase str)
* (string-downcase str start)
* (string-downcase str start end)
......@@ -983,7 +984,7 @@ DEFINE_PRIMITIVE("string-mutable?", string_mutable, subr1, (SCM obj))
* (string-downcase "Foo BAR" 4 6) => "ba"
* @end lisp
*
* ,@(bold "Note"): In R7RS, |string-downcase| accepts only one argument.
* ,(bold "Note"): In R7RS, |string-downcase| accepts only one argument.
doc>
*/
static SCM string_xxcase(int argc, SCM *argv, int (*toxx)(int),
......@@ -1077,7 +1078,7 @@ DEFINE_PRIMITIVE("string-downcase!", string_ddowncase, vsubr, (int argc, SCM *ar
}
/*
<doc EXT string-upcase
<doc R7RS string-upcase
* (string-upcase str)
* (string-upcase str start)
* (string-upcase str start end)
......@@ -1086,8 +1087,8 @@ DEFINE_PRIMITIVE("string-downcase!", string_ddowncase, vsubr, (int argc, SCM *ar
* |start| and |end| indices have been replaced by their upper case equivalent.
* If |start| is omited, it defaults to 0. If |end| is omited, it defaults to
* the length of |str|.
*
* ,@(bold "Note"): In R7RS, |string-upcase| accepts only one argument.
* @l
* ,(bold "Note"): In R7RS, |string-upcase| accepts only one argument.
doc>
*/
DEFINE_PRIMITIVE("string-upcase", string_upcase, vsubr, (int argc, SCM *argv))
......@@ -1111,7 +1112,7 @@ DEFINE_PRIMITIVE("string-upcase!", string_dupcase, vsubr, (int argc, SCM *argv))
/*
<doc EXT string-foldcase
<doc R7RS string-foldcase
* (string-foldcase str)
* (string-foldcase str start)
* (string-foldcase str start end)
......@@ -1120,8 +1121,8 @@ DEFINE_PRIMITIVE("string-upcase!", string_dupcase, vsubr, (int argc, SCM *argv))
* been applied on |str| between the |start| and |end| indices.
* If |start| is omited, it defaults to 0. If |end| is omited, it defaults to
* the length of |str|.
*
* ,@(bold "Note"): In R7RS, |string-foldcase| accepts only one argument.
* @l
* ,(bold "Note"): In R7RS, |string-foldcase| accepts only one argument.
doc>
*/
DEFINE_PRIMITIVE("string-foldcase", string_foldcase, vsubr, (int argc, SCM *argv))
......
......@@ -22,7 +22,7 @@
*
* Author: Erick Gallesio [eg@unice.fr]
* Creation date: ??? 1993
* Last file update: 6-Jul-2018 16:20 (eg)
* Last file update: 6-Jul-2018 19:39 (eg)
*/
#include <string.h>
......@@ -295,7 +295,7 @@ DEFINE_PRIMITIVE("vector-set!", vector_set, subr3, (SCM v, SCM index, SCM value)
* (list->vector '(dididit dah)) => #(dididit dah)
* @end lisp
*
*,@("Note"): The R5RS version of |vector->list| accepts only one
* ,(bold "Note"): The R5RS version of |vector->list| accepts only one
* parameter.
doc>
*/
......@@ -415,8 +415,8 @@ DEFINE_PRIMITIVE("vector-append", vector_append, vsubr, (int argc, SCM *argv))
* (vector-fill! vector fill start end)
*
* Stores |fill| in every element of |vector| between |start| and |end|.
*
* ,@("Note"): The R5RS version of |vector-fill!| accepts only one
* @l
* ,(bold "Note"): The R5RS version of |vector-fill!| accepts only one
* parameter.
doc>
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment