aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-07-11 08:43:27 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-07-11 08:43:27 +0000
commitdd9f5fd79b03dfad93430831db5b5be5cb3b98ec (patch)
treef5648a9c2f5dbd3315182967b12992233183cfb9 /mandoc.3
parent48039f39b1c03d6324782b64ebb1081fb30afb2b (diff)
downloadmandoc-dd9f5fd79b03dfad93430831db5b5be5cb3b98ec.tar.gz
mandoc-dd9f5fd79b03dfad93430831db5b5be5cb3b98ec.tar.zst
mandoc-dd9f5fd79b03dfad93430831db5b5be5cb3b98ec.zip
Make sure constants in mandoc.3 use the `Dv' macro.
Diffstat (limited to 'mandoc.3')
-rw-r--r--mandoc.322
1 files changed, 15 insertions, 7 deletions
diff --git a/mandoc.3 b/mandoc.3
index 16aa6125..5fc05a85 100644
--- a/mandoc.3
+++ b/mandoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.3,v 1.11 2011/06/22 22:10:02 kristaps Exp $
+.\" $Id: mandoc.3,v 1.12 2011/07/11 08:43:27 kristaps Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: June 22 2011 $
+.Dd $Mdocdate: July 11 2011 $
.Dt MANDOC 3
.Os
.Sh NAME
@@ -199,7 +199,7 @@ See
.It Vt "enum mparset"
The type of parser when reading input.
This should usually be
-.Va MPARSE_AUTO
+.Dv MPARSE_AUTO
for auto-detection.
.It Vt "struct mparse"
An opaque pointer to a running parse sequence.
@@ -222,9 +222,14 @@ Scan an escape sequence, i.e., a character string beginning with
Pass a pointer to this string as
.Va end ;
it will be set to the supremum of the parsed escape sequence unless
-returning ESCAPE_ERROR, in which case the string is bogus and should be
+returning
+.Dv ESCAPE_ERROR ,
+in which case the string is bogus and should be
thrown away.
-If not ESCAPE_ERROR or ESCAPE_IGNORE,
+If not
+.Dv ESCAPE_ERROR
+or
+.Dv ESCAPE_IGNORE ,
.Va start
is set to the first relevant character of the substring (font, glyph,
whatever) of length
@@ -233,7 +238,8 @@ Both
.Va start
and
.Va sz
-may be NULL.
+may be
+.Dv NULL .
.It Fn man_meta
Obtain the meta-data of a successful parse.
This may only be used on a pointer returned by
@@ -267,7 +273,9 @@ Convert a special character into a valid Unicode codepoint.
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.
+Returns
+.Dv NULL
+on failure.
.It Fn mdoc_meta
Obtain the meta-data of a successful parse.
This may only be used on a pointer returned by