summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul A. Patience <paul@apatience.com>2021-09-16 19:31:12 -0400
committerKaz Kylheku <kaz@kylheku.com>2021-09-17 06:18:46 -0700
commit5db43d77185d18e98a953d79475d17513ef8e628 (patch)
treee7380564ab88de484c6b5efc8fa918f096503ddd
parent5a4f79f5ae2d14a5ed128cbda00055de39b00719 (diff)
downloadtxr-5db43d77185d18e98a953d79475d17513ef8e628.tar.gz
txr-5db43d77185d18e98a953d79475d17513ef8e628.tar.bz2
txr-5db43d77185d18e98a953d79475d17513ef8e628.zip
doc: interchange buf-str and str-buf descriptions.
* txr.1: Interchange the first arguments of buf-str and str-buf, and their descriptions also.
-rw-r--r--txr.130
1 files changed, 15 insertions, 15 deletions
diff --git a/txr.1 b/txr.1
index 452ec105..c07556f8 100644
--- a/txr.1
+++ b/txr.1
@@ -27444,19 +27444,31 @@ operation which is implicitly performed.
.coNP Functions @ buf-str and @ str-buf
.synb
-.mets (buf-str < buf <> [ null-term-p ])
-.mets (str-buf < str <> [ null-term-p ])
+.mets (buf-str < str <> [ null-term-p ])
+.mets (str-buf < buf <> [ null-term-p ])
.syne
.desc
The
.code buf-str
and
.code str-buf
-functions perform UTF-8 conversion between the buffer and character string
+functions perform UTF-8 conversion between the character string and buffer
data types.
The
.code buf-str
+function UTF-8-encodes
+.meta str
+and returns a buffer containing the converted representation.
+If a true argument is given to the
+.meta null-term-p
+parameter, then a null terminating byte is added to the buffer.
+This byte is added even if the previous byte is already a null byte
+from the conversion of a pseudo-null character occurring in
+.metn str .
+
+The
+.code str-buf
function takes the contents of buffer
.meta buf
to be UTF-8 data, which is converted to a character string and returned.
@@ -27468,18 +27480,6 @@ parameter, then if the contents of
.meta buf
end in a null byte, that byte is not included in the conversion.
-The
-.code str-buf
-function UTF-8-encodes
-.meta str
-and returns a buffer containing the converted representation.
-If a true argument is given to the
-.meta null-term-p
-parameter, then a null terminating byte is added to the buffer.
-This byte is added even if the previous byte is already a null byte
-from the conversion of a pseudo-null character occurring in
-.metn str .
-
.coNP Functions @ buf-int and @ buf-uint
.synb
.mets (buf-int << integer )