libc/newlib/doc/doc.str
Jon Turney 2ce4e1e5ad makedoc: warn about some obsolete and deprecated commands
To follow up the thread starting at [1], since all uses of TRAD_SYNOPSIS
have been removed, and all uses of ANSI_SYNOPSIS have been renamed to
SYNOPSIS, we can now warn about the use of these.

[1] https://sourceware.org/ml/newlib/2017/msg01182.html

Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2017-12-08 12:09:03 +00:00

161 lines
2.1 KiB
Plaintext

: nokill_bogus_lines ;
: ENDDD
skip_past_newline
;
: TABLE
skip_past_newline
"@table @code\n" catstr
;
: ENDTABLE
skip_past_newline
"@end table\n"
catstr
;
: QUICKREF
skip_past_newline
;
: MATHREF
skip_past_newline
;
: EXAMPLE
skip_past_newline
get_stuff_in_command nokill_bogus_lines translatecomments
courierize catstr
;
: INODE
"@node " catstr skip_past_newline copy_past_newline catstr
;
: CODE_FRAGMENT
EXAMPLE
;
: SYNOPSIS
skip_past_newline
"@strong{Synopsis}\n" catstr
"@example\n" catstr
get_stuff_in_command
do_fancy_stuff
nokill_bogus_lines
indent
catstr
"@end example\n" catstr
;
: ANSI_SYNOPSIS
skip_past_newline
"@strong{Synopsis}\n" catstr
"@example\n" catstr
get_stuff_in_command
do_fancy_stuff
nokill_bogus_lines
indent
catstr
"@end example\n" catstr
"ANSI_SYNOPSIS is deprecated, use SYNOPSIS instead" warn
;
: TRAD_SYNOPSIS
skip_past_newline
"TRAD_SYNOPSIS is obsolete and ignored" warn
;
: INDEX
"@findex " skip_past_newline copy_past_newline catstr catstr
;
: FUNCTION
"@node " - a
skip_past_newline
copy_past_newline
dup - a x x
get_stuff_in_angle -a x y
swap
do_fancy_stuff
"@section " - a x x b
swap
remchar
"\n" - a x b x c
catstr catstr catstr catstr catstr
;
: bodytext
get_stuff_in_command
bulletize
courierize
do_fancy_stuff
catstr
"@sp 1\n" catstr
;
: asection
skip_past_newline
catstr
copy_past_newline
do_fancy_stuff catstr
bodytext
;
: SECTION
"@section " asection ;
: SUBSECTION
"@section " asection ;
: SUBSUBSECTION
"@subsection " asection ;
: subhead
skip_past_newline
bodytext
;
: DESCRIPTION
"@strong{Description}@*\n" catstr subhead ;
: RETURNS
"@strong{Returns}@*\n" catstr subhead ;
: ERRORS
"@strong{Errors}@*\n" catstr subhead ;
: PORTABILITY
"@strong{Portability}@*\n" catstr subhead ;
: BUGS
"@strong{Bugs}@*\n" catstr subhead ;
: WARNINGS
"@strong{Warnings}@*\n" catstr subhead ;
: SEEALSO
"@strong{See Also}@*\n" catstr subhead ;
: NOTES
"@strong{Notes}@*\n" catstr subhead ;
: INTERNAL_FUNCTION
;
: INTERNAL_DEFINITION
;
: INTERNAL
;
: TYPEDEF
FUNCTION ;
: NEWPAGE
"@page\n" catstr subhead ;