aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-05-24 21:41:11 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-05-24 21:41:11 +0000
commit5cfedfff08c35dc808f02a9d36eb9a23ddaa67c9 (patch)
tree8b6c26448ac8fb71039db8a50cab52138446e032 /mandoc.3
parent5f3d81eaf50a34f7f2e677d8c8d33c04efbadf19 (diff)
downloadmandoc-5cfedfff08c35dc808f02a9d36eb9a23ddaa67c9.tar.gz
mandoc-5cfedfff08c35dc808f02a9d36eb9a23ddaa67c9.tar.zst
mandoc-5cfedfff08c35dc808f02a9d36eb9a23ddaa67c9.zip
Document that spec2cp never returns 0.
Diffstat (limited to 'mandoc.3')
-rw-r--r--mandoc.36
1 files changed, 2 insertions, 4 deletions
diff --git a/mandoc.3 b/mandoc.3
index 313b3537..300f2981 100644
--- a/mandoc.3
+++ b/mandoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.3,v 1.9 2011/05/24 21:31:23 kristaps Exp $
+.\" $Id: mandoc.3,v 1.10 2011/05/24 21:41:11 kristaps Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -248,9 +248,7 @@ a Unicode codepoint.
Returns \e0 (the nil character) if the input sequence is malformed.
.It Fn mchars_spec2cp
Convert a special character into a valid Unicode codepoint.
-Returns \-1 on failure and 0 if no code-point exists (if this occurs,
-the caller should fall back to
-.Fn mchars_spec2str ) .
+Returns \-1 on failure or a non-zero Unicode codepoint on success.
.It Fn mchars_spec2str
Convert a special character into an ASCII string.
Returns NULL on failure.