=================================================================== RCS file: /cvs/mandoc/mandoc_headers.3,v retrieving revision 1.1 retrieving revision 1.4 diff -u -p -r1.1 -r1.4 --- mandoc/mandoc_headers.3 2014/12/01 08:09:26 1.1 +++ mandoc/mandoc_headers.3 2015/04/02 21:36:50 1.4 @@ -47,14 +47,13 @@ HTML formatters search tools .El .Pp -Note that mere usage of an opaque type does +Note that mere usage of an opaque struct type does .Em not require inclusion of the header where that type is defined. .Ss Parser interface Each of the following headers can be included without including any other mandoc header. These headers should be included before any other mandoc headers. -Afterwards, any other mandoc headers can be included as needed. .Bl -tag -width Ds .It Qq Pa mandoc_aux.h Requires @@ -117,16 +116,29 @@ and from .Pa libman.h as opaque types for function prototypes. +.It Qq Pa roff.h +Provides +.Vt enum roff_type . +.El +.Pp +The following two require +.Qq Pa roff.h +but no other mandoc headers. +Afterwards, any other mandoc headers can be included as needed. +.Bl -tag -width Ds .It Qq Pa mdoc.h Requires .In sys/types.h for -.Vt size_t . +.Vt size_t +and +.Qq Pa roff.h +for +.Vt enum roff_type . .Pp Provides .Vt enum mdoct , .Vt enum mdocargt , -.Vt enum mdoc_type , .Vt enum mdoc_sec , .Vt enum mdoc_endbody , .Vt enum mdoc_disp , @@ -163,9 +175,13 @@ When this header is included, the same file should not or .Pa libroff.h . .It Qq Pa man.h +Requires +.Qq Pa roff.h +for +.Vt enum roff_type . +.Pp Provides .Vt enum mant , -.Vt enum man_type , .Vt struct man_meta , .Vt struct man_node , and the functions @@ -204,7 +220,11 @@ are included, the same file should not include any for Requires .In sys/types.h for -.Vt size_t . +.Vt size_t +and +.Qq Pa mandoc.h +for +.Vt enum mandocerr . .Pp Provides .Vt enum rofferr , @@ -222,8 +242,7 @@ from .Pa roff.c for function prototypes. Uses the types -.Vt enum mandocerr , -.Vt struct tbl_span , +.Vt struct tbl_span and .Vt struct eqn from @@ -363,8 +382,6 @@ from as an opaque type for function prototypes. .Pp When this header is included, the same file should not include -.Pa manpath.h -or .Pa mansearch.h . .It Qq Pa term.h Requires @@ -403,8 +420,7 @@ from as opaque types for function prototypes. .Pp When this header is included, the same file should not include -.Pa html.h , -.Pa manpath.h +.Pa html.h or .Pa mansearch.h . .It Qq Pa html.h @@ -438,8 +454,7 @@ from .Pa chars.c . .Pp When this header is included, the same file should not include -.Pa term.h , -.Pa manpath.h +.Pa term.h or .Pa mansearch.h . .It Qq Pa main.h @@ -458,25 +473,21 @@ and from .Pa libman.h as opaque types for function prototypes. -.It Qq Pa manpath.h +.It Qq Pa manconf.h Requires .In sys/types.h for .Vt size_t . .Pp Provides -.Vt struct manpaths +.Vt struct manconf , +.Vt struct manpaths , +.Vt struct manoutput , and the functions -.Fn manpath_manconf , -.Fn manpath_parse , +.Fn manconf_parse , +.Fn manconf_output , and -.Fn manpath_free . -.Pp -When this header is included, the same file should not include -.Pa out.h , -.Pa term.h , -or -.Pa html.h . +.Fn manconf_free . .It Qq Pa mansearch.h Requires .In sys/types.h @@ -500,7 +511,7 @@ and Uses .Vt struct manpaths from -.Pa manpath.h +.Pa manconf.h as an opaque type for function prototypes. .Pp When this header is included, the same file should not include