=================================================================== RCS file: /cvs/mandoc/mandoc_headers.3,v retrieving revision 1.27 retrieving revision 1.30 diff -u -p -r1.27 -r1.30 --- mandoc/mandoc_headers.3 2018/12/14 01:18:25 1.27 +++ mandoc/mandoc_headers.3 2018/12/30 00:49:55 1.30 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: December 14 2018 $ +.Dd $Mdocdate: December 30 2018 $ .Dt MANDOC_HEADERS 3 .Os .Sh NAME @@ -115,7 +115,6 @@ Provides .Vt enum mandoc_os , .Vt enum mdoc_endbody , .Vt enum roff_macroset , -.Vt enum roff_next , .Vt enum roff_sec , .Vt enum roff_tok , .Vt enum roff_type , @@ -124,21 +123,25 @@ Provides .Vt struct roff_node , the constant array .Va roff_name -and the functions -.Fn deroff -and -.Fn roff_validate . +and the function +.Fn deroff . .Pp Uses pointers to the types .Vt struct ohash from -.Pa mandoc_ohash.h -and +.Pa mandoc_ohash.h , .Vt struct mdoc_arg and .Vt union mdoc_data from -.Pa mdoc.h +.Pa mdoc.h , +.Vt struct tbl_span +from +.Pa tbl.h , +and +.Vt struct eqn_box +from +.Pa eqn.h as opaque struct members. .It Qq Pa tbl.h Data structures for the @@ -183,22 +186,21 @@ and in the main parser, but not in formatters. Requires .Pa mandoc.h for -.Vt enum mandocerr , -.Vt enum mandoclevel , +.Vt enum mandocerr and -.Fn mandocmsg , +.Vt enum mandoclevel and .Pa roff.h for .Vt enum mandoc_os . .Pp -Uses to opaque type +Uses the opaque type .Vt struct mparse from .Pa read.c for function prototypes. Uses -.Vt struct roff_man +.Vt struct roff_meta from .Pa roff.h as an opaque type for function prototypes. @@ -246,11 +248,15 @@ and the functions described in .Xr mandoc 3 . .Pp -Uses the type -.Vt struct roff_man +Uses the types +.Vt struct roff_node from .Pa roff.h -as an opaque type for function prototypes. +and +.Vt struct roff_man +from +.Pa roff_int.h +as opaque types for function prototypes. .Pp When this header is included, the same file should not include internals of different parsers. @@ -260,11 +266,6 @@ Provides the functions described in .Xr mandoc 3 . .Pp -Uses the opaque type -.Vt struct mparse -from -.Pa read.c -for function prototypes. Uses the type .Vt struct roff_man from @@ -296,11 +297,7 @@ Provides utility functions needed by multiple parsers, and the top-level functions to call the parsers. .Pp -Uses the opaque types -.Vt struct mparse -from -.Pa read.c -and +Uses the opaque type .Vt struct roff from .Pa roff.c @@ -321,13 +318,17 @@ for and .Vt enum roff_tok . .Pp -Provides functions named +Provides +.Vt enum roff_next , +.Vt struct roff_man , +functions named .Fn roff_* to handle roff nodes, .Fn roffhash_alloc , .Fn roffhash_find , -and .Fn roffhash_free , +and +.Fn roff_validate , and the two special functions .Fn man_breakscope and @@ -336,11 +337,17 @@ because the latter two are needed by .Qq Pa roff.c . .Pp Uses the types -.Vt struct roff_man -and +.Vt struct ohash +from +.Pa mandoc_ohash.h , .Vt struct roff_node +and +.Vt struct roff_meta from -.Pa roff.h +.Pa roff.h , +.Vt struct roff +from +.Pa roff.c , and .Vt struct mdoc_arg from @@ -363,11 +370,12 @@ and many functions internal to the parser. .Pp Uses the types -.Vt struct roff_man -and .Vt struct roff_node from -.Pa roff.h +.Pa roff.h , +.Vt struct roff_man +from +.Pa roff_int.h , and .Vt struct mdoc_arg from @@ -389,11 +397,13 @@ and some functions internal to the parser. .Pp Uses the types -.Vt struct roff_man -and .Vt struct roff_node from .Pa roff.h +and +.Vt struct roff_man +from +.Pa roff_int.h as opaque types for function prototypes. .Pp When this header is included, the same file should not include @@ -424,11 +434,6 @@ and the functions and .Fn eqn_reset . .Pp -Uses the opaque type -.Vt struct mparse -from -.Pa read.c -for function prototypes. Uses the type .Vt struct eqn_box from @@ -458,10 +463,6 @@ parsers only. Provides the functions documented in .Xr tbl 3 . .Pp -Uses the opaque type -.Vt struct mparse -from -.Pa read.c . Uses the types .Vt struct tbl_span from @@ -497,12 +498,6 @@ and the functions and .Fn tbl_reset . .Pp -Uses a pointer to the opaque type -.Vt struct mparse -from -.Pa read.c -as an opaque struct member. -.Pp When this header is included, the same file should not include interfaces of different parsers. .El @@ -580,7 +575,10 @@ or Requires .In sys/types.h for -.Vt size_t +.Vt size_t , +.Pa mandoc.h +for +.Vt enum mandoc_esc , and .Qq Pa out.h for @@ -631,7 +629,7 @@ functionality mentioned in Provides the top level steering functions for all formatters. .Pp Uses the type -.Vt struct roff_man +.Vt struct roff_meta from .Pa roff.h as an opaque type for function prototypes.