aboutsummaryrefslogtreecommitdiff
path: root/newlib/doc/doc.str
blob: 4d557c6f52761ff2604916be2deb5f17913d4674 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
: 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
	get_stuff_in_command
	"&&~&&~&&\cr\tablerule\n"
	quickref
	;


: ITEM 
	"@item " catstr ;

: 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

	;

: OLDTRAD_SYNOPSIS
	skip_past_newline
	"@strong{Traditional Synopsis}\n" catstr
	"@example\n" catstr
	get_stuff_in_command  
	do_fancy_stuff
	nokill_bogus_lines
	indent
	catstr
	"@end example\n" catstr

	;

: TRAD_SYNOPSIS
	skip_past_newline

	;

: 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
	"@*\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 ;


: WARNINGS
	"@strong{Warnings}@*\n" catstr subhead ;



: INTERNAL_FUNCTION
	func ;


: INTERNAL_DEFINITION 
	func ;


: INTERNAL
	func ;

: TYPEDEF
	FUNCTION ;



: NEWPAGE
	"@page\n" catstr subhead ;