[BACK]Return to mandoc_headers.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_headers.3 between version 1.20 and 1.22

version 1.20, 2018/12/12 21:54:35 version 1.22, 2018/12/13 03:40:13
Line 231  from
Line 231  from
 as an opaque type for function prototypes.  as an opaque type for function prototypes.
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Pa libman.h  internals of different parsers.
 or  
 .Pa libroff.h .  
 .It Qq Pa man.h  .It Qq Pa man.h
 Provides the functions  Provides the functions
 .Fn man_*  .Fn man_*
Line 252  from
Line 250  from
 as an opaque type for function prototypes.  as an opaque type for function prototypes.
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Pa libmdoc.h  internals of different parsers.
 or  
 .Pa libroff.h .  
 .El  .El
 .Ss Parser internals  .Ss Parser internals
 The following headers require inclusion of a parser interface header  Most of the following headers require inclusion of a parser interface header
 before they can be included.  before they can be included.
 All parser interface headers should precede all parser internal headers.  All parser interface headers should precede all parser internal headers.
 When any parser internal headers are included, the same file should  When any parser internal headers are included, the same file should
Line 351  from
Line 347  from
 as opaque types for function prototypes.  as opaque types for function prototypes.
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Pa man.h ,  interfaces of different parsers.
 .Pa libman.h ,  
 or  
 .Pa libroff.h .  
 .It Qq Pa libman.h  .It Qq Pa libman.h
 Requires  Requires
 .Qq Pa roff.h  .Qq Pa roff.h
Line 376  from
Line 369  from
 as opaque types for function prototypes.  as opaque types for function prototypes.
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Pa mdoc.h ,  interfaces of different parsers.
 .Pa libmdoc.h ,  .It Qq Pa eqn_parse.h
 or  External interface of the
 .Pa libroff.h .  .Xr eqn 7
 .It Qq Pa libroff.h  parser, for use in the
   .Xr roff 7
   and
   .Xr eqn 7
   parsers only.
   .Pp
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t  .Vt size_t .
   .Pp
   Provides
   .Vt struct eqn_node
   and the functions
   .Fn eqn_alloc ,
   .Fn eqn_box_free ,
   .Fn eqn_free ,
   .Fn eqn_parse ,
   .Fn eqn_read ,
 and  and
 .Qq Pa mandoc.h  .Fn eqn_reset .
 for  .Pp
 .Vt struct tbl_*  Uses the opaque type
   .Vt struct mparse
   from
   .Pa read.c
   for function prototypes.
   Uses the type
   .Vt struct eqn_box
   from
   .Pa mandoc.h
   as an opaque type for function prototypes.
   Uses the types
   .Vt struct roff_node
   from
   .Pa roff.h
 and  and
 .Vt struct eqn_box .  .Vt struct eqn_def
   from
   .Pa eqn.c
   as opaque struct members.
 .Pp  .Pp
 Provides  When this header is included, the same file should not include
 .Vt enum tbl_part ,  internals of different parsers.
 .Vt struct tbl_node ,  .It Qq Pa tbl_parse.h
 .Vt struct eqn_def ,  External interface of the
 .Vt struct eqn_node ,  
 and many functions internal to the  
 .Xr tbl 7  .Xr tbl 7
   parser, for use in the
   .Xr roff 7
 and  and
 .Xr eqn 7  .Xr tbl 7
 parsers.  parsers only.
 .Pp  .Pp
   Provides the functions documented in
   .Xr tbl 3 .
   .Pp
 Uses the opaque type  Uses the opaque type
 .Vt struct mparse  .Vt struct mparse
 from  from
 .Pa read.c .  .Pa read.c .
   Uses the types
   .Vt struct tbl_span
   from
   .Pa tbl.h
   and
   .Vt struct tbl_node
   from
   .Pa tbl_int.h
   as opaque types for function prototypes.
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Pa man.h ,  internals of different parsers.
 .Pa mdoc.h ,  .It Qq Pa tbl_int.h
 .Pa libman.h ,  Internal interfaces of the
 or  .Xr tbl 7
 .Pa libmdoc.h .  parser, for use inside the
   .Xr tbl 7
   parser only.
   .Pp
   Requires
   .Qq Pa tbl.h
   for
   .Vt struct tbl_opts .
   .Pp
   Provides
   .Vt enum tbl_part ,
   .Vt struct tbl_node ,
   and the functions
   .Fn tbl_option ,
   .Fn tbl_layout ,
   .Fn tbl_data ,
   .Fn tbl_cdata ,
   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  .El
 .Ss Formatter interface  .Ss Formatter interface
 These headers should be included after any parser interface headers.  These headers should be included after any parser interface headers.
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.22
CVSweb