diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-12 21:54:35 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-12 21:54:35 +0000 |
commit | abe535d017ebcf70bf575e3048cb4ea11f75a600 (patch) | |
tree | 89012c9ae6f95bc0cf1e3a34387ff22ae072d23b /mandoc_headers.3 | |
parent | fbcda63a2f8d075778d869bf8b5e39be061e27bb (diff) | |
download | mandoc-abe535d017ebcf70bf575e3048cb4ea11f75a600.tar.gz mandoc-abe535d017ebcf70bf575e3048cb4ea11f75a600.tar.zst mandoc-abe535d017ebcf70bf575e3048cb4ea11f75a600.zip |
Cleanup, no functional change:
No need to expose the tbl(7) syntax tree data structures everywhere.
Move them to their own include file, "tbl.h", and improve comments.
Diffstat (limited to 'mandoc_headers.3')
-rw-r--r-- | mandoc_headers.3 | 50 |
1 files changed, 37 insertions, 13 deletions
diff --git a/mandoc_headers.3 b/mandoc_headers.3 index a70e66c4..e2c8f5a7 100644 --- a/mandoc_headers.3 +++ b/mandoc_headers.3 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: August 24 2018 $ +.Dd $Mdocdate: December 12 2018 $ .Dt MANDOC_HEADERS 3 .Os .Sh NAME @@ -25,13 +25,13 @@ separate from each other: .Pp .Bl -dash -offset indent -compact .It -.Xr mdoc 7 +.Xr roff 7 parser .It -.Xr man 7 +.Xr mdoc 7 parser .It -.Xr roff 7 +.Xr man 7 parser .It .Xr tbl 7 @@ -45,6 +45,8 @@ terminal formatters HTML formatters .It search tools +.It +main programs .El .Pp Note that mere usage of an opaque struct type does @@ -56,14 +58,18 @@ any other mandoc header. These headers should be included before any other mandoc headers. .Bl -tag -width Ds .It Qq Pa mandoc_aux.h +Memory allocation utility functions; can be used everywhere. +.Pp Requires .In sys/types.h for .Vt size_t . .Pp -Provides the utility functions documented in +Provides the functions documented in .Xr mandoc_malloc 3 . .It Qq Pa mandoc_ohash.h +Hashing utility functions; can be used everywhere. +.Pp Requires .In stddef.h for @@ -78,6 +84,9 @@ Includes and provides .Fn mandoc_ohash_init . .It Qq Pa mandoc.h +Error handling utilities and top level parser interface; +can be used everywhere. +.Pp Requires .In sys/types.h for @@ -88,18 +97,10 @@ Provides .Vt enum mandocerr , .Vt enum mandoclevel , .Vt enum mandoc_os , -.Vt enum tbl_cellt , -.Vt enum tbl_datt , -.Vt enum tbl_spant , .Vt enum eqn_boxt , .Vt enum eqn_fontt , .Vt enum eqn_pilet , .Vt enum eqn_post , -.Vt struct tbl_opts , -.Vt struct tbl_cell , -.Vt struct tbl_row , -.Vt struct tbl_dat , -.Vt struct tbl_span , .Vt struct eqn_box , the function prototype typedef .Fn mandocmsg , @@ -122,7 +123,30 @@ Uses the type from .Pa roff.h as an opaque type for function prototypes. +.It Qq Pa tbl.h +Data structures for the +.Xr tbl 7 +parse tree; can be used everywhere. +.Pp +Requires +.In sys/types.h +for +.Vt size_t . +.Pp +Provides +.Vt enum tbl_cellt , +.Vt enum tbl_datt , +.Vt enum tbl_spant , +.Vt struct tbl_opts , +.Vt struct tbl_cell , +.Vt struct tbl_row , +.Vt struct tbl_dat , +and +.Vt struct tbl_span . .It Qq Pa mandoc_xr.h +Cross reference validation; intended for use in the main program +and in parsers, but not in formatters. +.Pp Provides .Vt struct mandoc_xr and the functions |