Home | History | Annotate | Line # | Download | only in doc
      1  1.1.1.2  christos - Documentation extraction program for chew.
      2  1.1.1.4  christos -  Copyright (C) 1990-2026 Free Software Foundation, Inc.
      3  1.1.1.2  christos -  This file is part of BFD, the Binary File Descriptor library.
      4  1.1.1.2  christos 
      5  1.1.1.2  christos -  This program is free software; you can redistribute it and/or modify
      6  1.1.1.2  christos -  it under the terms of the GNU General Public License as published by
      7  1.1.1.2  christos -  the Free Software Foundation; either version 3 of the License, or
      8  1.1.1.2  christos -  (at your option) any later version.
      9  1.1.1.2  christos 
     10  1.1.1.2  christos -  This program is distributed in the hope that it will be useful,
     11  1.1.1.2  christos -  but WITHOUT ANY WARRANTY; without even the implied warranty of
     12  1.1.1.2  christos -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     13  1.1.1.2  christos -  GNU General Public License for more details.
     14  1.1.1.2  christos 
     15  1.1.1.2  christos -  You should have received a copy of the GNU General Public License
     16  1.1.1.2  christos -  along with this program; if not, write to the Free Software
     17  1.1.1.2  christos -  Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
     18  1.1.1.2  christos 
     19  1.1.1.2  christos - chew.c keywords defined here put output into doc/*.texi files
     20  1.1.1.2  christos - from comments in the source.  See also proto.str.
     21  1.1.1.2  christos 
     22  1.1.1.2  christos -  True if SYNOPSIS was seen.
     23  1.1.1.2  christos variable synopsis_seen
     24  1.1.1.2  christos 
     25      1.1     skrll : DOCDD
     26      1.1     skrll 	skip_past_newline
     27      1.1     skrll 	get_stuff_in_command kill_bogus_lines catstr
     28      1.1     skrll 	;
     29      1.1     skrll 
     30      1.1     skrll : ENDDD
     31      1.1     skrll 	skip_past_newline
     32      1.1     skrll 	;
     33      1.1     skrll 
     34      1.1     skrll : EXAMPLE
     35      1.1     skrll 	skip_past_newline	
     36      1.1     skrll 	get_stuff_in_command kill_bogus_lines do_fancy_stuff translatecomments 
     37      1.1     skrll 	courierize catstr
     38      1.1     skrll 	;
     39      1.1     skrll 
     40      1.1     skrll : INODE 
     41      1.1     skrll 	"@node " catstr skip_past_newline copy_past_newline catstr 
     42      1.1     skrll 	;
     43      1.1     skrll 
     44      1.1     skrll : CODE_FRAGMENT
     45      1.1     skrll 	EXAMPLE 
     46      1.1     skrll 	;
     47      1.1     skrll 
     48      1.1     skrll : COMMENT
     49      1.1     skrll 	skip_past_newline
     50      1.1     skrll 	get_stuff_in_command
     51      1.1     skrll 	drop
     52      1.1     skrll 	;
     53      1.1     skrll 
     54      1.1     skrll : SYNOPSIS
     55      1.1     skrll 	skip_past_newline
     56  1.1.1.2  christos 	1 synopsis_seen !
     57  1.1.1.2  christos 	"@deftypefn {Function} " catstr
     58      1.1     skrll 	get_stuff_in_command  
     59      1.1     skrll 	kill_bogus_lines
     60  1.1.1.2  christos 	collapse_whitespace
     61      1.1     skrll 	indent
     62      1.1     skrll 	catstr
     63  1.1.1.2  christos 	"\n" catstr
     64      1.1     skrll 	;
     65      1.1     skrll 
     66      1.1     skrll : func
     67      1.1     skrll 	"@findex "	- a
     68      1.1     skrll 	skip_past_newline
     69      1.1     skrll 	copy_past_newline
     70      1.1     skrll 	dup		- a x x 
     71      1.1     skrll 	"@subsubsection @code{" - a x x b 
     72      1.1     skrll 	swap
     73      1.1     skrll 	remchar
     74      1.1     skrll 	"}\n" - a x b x c
     75      1.1     skrll 	catstr 	catstr 	catstr 	catstr 	catstr 
     76      1.1     skrll 	;
     77      1.1     skrll 
     78      1.1     skrll : bodytext
     79      1.1     skrll 	get_stuff_in_command 
     80      1.1     skrll 	bulletize
     81      1.1     skrll 	kill_bogus_lines
     82      1.1     skrll 	do_fancy_stuff
     83      1.1     skrll 	courierize
     84      1.1     skrll 	catstr
     85      1.1     skrll 	"\n" catstr
     86      1.1     skrll 	;
     87      1.1     skrll 
     88      1.1     skrll : asection
     89      1.1     skrll 	skip_past_newline
     90      1.1     skrll 	catstr
     91      1.1     skrll 	copy_past_newline 	
     92      1.1     skrll 	do_fancy_stuff catstr 	
     93      1.1     skrll 	bodytext	
     94      1.1     skrll 	;
     95      1.1     skrll 
     96      1.1     skrll : SECTION 
     97      1.1     skrll 	"@section " asection  ;
     98      1.1     skrll 
     99      1.1     skrll : SUBSECTION
    100      1.1     skrll 	"@subsection " asection  ;
    101      1.1     skrll 
    102      1.1     skrll : SUBSUBSECTION
    103      1.1     skrll 	"@subsubsection " asection  ;
    104      1.1     skrll 
    105      1.1     skrll : subhead
    106      1.1     skrll 	skip_past_newline
    107      1.1     skrll 	bodytext
    108      1.1     skrll 	;
    109      1.1     skrll 
    110      1.1     skrll : DESCRIPTION 
    111  1.1.1.2  christos 	subhead
    112  1.1.1.2  christos 	"@end deftypefn\n" synopsis_seen @ catstrif
    113  1.1.1.2  christos 	0 synopsis_seen !
    114  1.1.1.2  christos 	;
    115      1.1     skrll 
    116  1.1.1.2  christos : FUNCTION
    117  1.1.1.2  christos 	func ;
    118      1.1     skrll 
    119      1.1     skrll : INTERNAL_FUNCTION
    120      1.1     skrll 	func ;
    121      1.1     skrll 
    122  1.1.1.2  christos : DEFINITION
    123  1.1.1.2  christos 	func ;
    124      1.1     skrll 
    125  1.1.1.2  christos : INTERNAL_DEFINITION
    126      1.1     skrll 	func ;
    127      1.1     skrll 
    128  1.1.1.2  christos : EXTERNAL
    129  1.1.1.2  christos 	COMMENT ;
    130      1.1     skrll 
    131      1.1     skrll : INTERNAL
    132  1.1.1.2  christos 	COMMENT ;
    133      1.1     skrll 
    134      1.1     skrll : SENUM
    135      1.1     skrll 	skip_past_newline
    136      1.1     skrll 	"Here are the possible values for @code{enum "
    137      1.1     skrll 	copy_past_newline remchar catstr
    138      1.1     skrll 	"}:\n\n" catstr catstr
    139      1.1     skrll 	;
    140      1.1     skrll : ENUM
    141      1.1     skrll 	skip_past_newline
    142      1.1     skrll 	"@deffn {} "
    143      1.1     skrll 	copy_past_newline catstr catstr
    144      1.1     skrll 	;
    145      1.1     skrll : ENUMX
    146      1.1     skrll 	skip_past_newline
    147      1.1     skrll 	"@deffnx {} "
    148      1.1     skrll 	copy_past_newline catstr
    149      1.1     skrll 	catstr
    150      1.1     skrll 	;
    151      1.1     skrll : ENUMEQ
    152      1.1     skrll 	skip_past_newline
    153      1.1     skrll 	"@deffn {} "
    154      1.1     skrll 	copy_past_newline catstr catstr
    155      1.1     skrll 	skip_past_newline
    156      1.1     skrll 	;
    157      1.1     skrll : ENUMEQX
    158      1.1     skrll 	skip_past_newline
    159      1.1     skrll 	"@deffnx {} "
    160      1.1     skrll 	copy_past_newline catstr
    161      1.1     skrll 	catstr
    162      1.1     skrll 	skip_past_newline
    163      1.1     skrll 	;
    164      1.1     skrll : ENUMDOC
    165      1.1     skrll 	skip_past_newline
    166      1.1     skrll 	get_stuff_in_command
    167      1.1     skrll 	strip_trailing_newlines
    168      1.1     skrll 	catstr
    169      1.1     skrll 	"\n@end deffn\n" catstr
    170      1.1     skrll 	;
    171