aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc_headers.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2018-12-13 06:18:20 +0000
committerIngo Schwarze <schwarze@openbsd.org>2018-12-13 06:18:20 +0000
commitef4eacb2307e8303d7e4555864132f376af2ac59 (patch)
tree202e7b3ffd4ddb1199d4efc1c3392e240fc0f9ea /mandoc_headers.3
parent32c0933851c645dfc5d1af1bda32e80c9f237254 (diff)
downloadmandoc-ef4eacb2307e8303d7e4555864132f376af2ac59.tar.gz
mandoc-ef4eacb2307e8303d7e4555864132f376af2ac59.tar.zst
mandoc-ef4eacb2307e8303d7e4555864132f376af2ac59.zip
Cleanup, no functional change:
Move the roffhash_*() functions from roff.h to roff_int.h because they are only intended for use by parsers, neither by main programs nor by formatters.
Diffstat (limited to 'mandoc_headers.3')
-rw-r--r--mandoc_headers.322
1 files changed, 16 insertions, 6 deletions
diff --git a/mandoc_headers.3 b/mandoc_headers.3
index 0adbf5a2..4c8ce5c2 100644
--- a/mandoc_headers.3
+++ b/mandoc_headers.3
@@ -167,6 +167,9 @@ and the functions
and
.Fn mandoc_xr_free .
.It Qq Pa roff.h
+Common data types for all syntax trees and related functions;
+can be used everywhere.
+.Pp
Requires
.Qq Pa mandoc_ohash.h
for
@@ -189,10 +192,7 @@ Provides
the constant array
.Va roff_name
and the functions
-.Fn deroff ,
-.Fn roffhash_alloc ,
-.Fn roffhash_find ,
-.Fn roffhash_free ,
+.Fn deroff
and
.Fn roff_validate .
.Pp
@@ -300,14 +300,24 @@ from
.Pa roff.h
as an opaque type for function prototypes.
.It Qq Pa roff_int.h
+Parser internals shared by multiple parsers.
+Can be used in all parsers, but not in main programs or formatters.
+.Pp
Requires
.Qq Pa roff.h
for
-.Vt enum roff_type .
+.Vt enum roff_type
+and
+.Vt enum roff_tok .
.Pp
Provides functions named
.Fn roff_*
-to handle roff nodes and the two special functions
+to handle roff nodes,
+.Fn roffhash_alloc ,
+.Fn roffhash_find ,
+and
+.Fn roffhash_free ,
+and the two special functions
.Fn man_breakscope
and
.Fn mdoc_argv_free