mirror of
https://github.com/espressif/binutils-gdb.git
synced 2025-06-13 03:48:49 +08:00
f370ae88a8
When reading the BFD manual, I noticed text like this:
-- Function: bool bfd_close (bfd *abfd);
Close a BFD. If the BFD was open for writing, then pending
operations are completed and the file written out and closed. If
...
*Returns*
'TRUE' is returned if all is ok, otherwise 'FALSE'.
The *Returns*, like the *Synopsis* in the earlier patch, is
un-info-like. It's also used inconsistently.
This patch removes all the uses of the RETURNS word and removes it
entirely from the chew scripts. Now this example reads:
-- Function: bool bfd_close (bfd *abfd);
Close a BFD. If the BFD was open for writing, then pending
operations are completed and the file written out and closed. If
...
'TRUE' is returned if all is ok, otherwise 'FALSE'.
In a few cases I had to slightly reword the comment. There were also
a couple of cases where there was redundant text. In these cases I
just dropped the RETURNS copy.
2023-02-07 Tom Tromey <tom@tromey.com>
* bfd.c, cache.c, compress.c, opncls.c: Remove RETURNS from
documentation comments.
* doc/doc.str, doc/proto.str (RETURNS): Remove.
178 lines
3.0 KiB
Plaintext
178 lines
3.0 KiB
Plaintext
- Documentation extraction program for chew.
|
|
- Copyright (C) 1990-2023 Free Software Foundation, Inc.
|
|
- This file is part of BFD, the Binary File Descriptor library.
|
|
|
|
- This program is free software; you can redistribute it and/or modify
|
|
- it under the terms of the GNU General Public License as published by
|
|
- the Free Software Foundation; either version 3 of the License, or
|
|
- (at your option) any later version.
|
|
|
|
- This program is distributed in the hope that it will be useful,
|
|
- but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
- GNU General Public License for more details.
|
|
|
|
- You should have received a copy of the GNU General Public License
|
|
- along with this program; if not, write to the Free Software
|
|
- Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
- True if SYNOPSIS was seen.
|
|
variable synopsis_seen
|
|
|
|
: DOCDD
|
|
skip_past_newline
|
|
get_stuff_in_command kill_bogus_lines catstr
|
|
;
|
|
|
|
: ENDDD
|
|
skip_past_newline
|
|
;
|
|
|
|
: EXAMPLE
|
|
skip_past_newline
|
|
get_stuff_in_command kill_bogus_lines do_fancy_stuff translatecomments
|
|
courierize catstr
|
|
|
|
;
|
|
|
|
: INODE
|
|
"@node " catstr skip_past_newline copy_past_newline catstr
|
|
;
|
|
|
|
: CODE_FRAGMENT
|
|
EXAMPLE
|
|
;
|
|
|
|
: COMMENT
|
|
skip_past_newline
|
|
get_stuff_in_command
|
|
drop
|
|
;
|
|
|
|
: SYNOPSIS
|
|
skip_past_newline
|
|
1 synopsis_seen !
|
|
"@deftypefn {Function} " catstr
|
|
get_stuff_in_command
|
|
kill_bogus_lines
|
|
indent
|
|
catstr
|
|
;
|
|
|
|
: func
|
|
"@findex " - a
|
|
skip_past_newline
|
|
copy_past_newline
|
|
dup - a x x
|
|
"@subsubsection @code{" - a x x b
|
|
swap
|
|
remchar
|
|
"}\n" - a x b x c
|
|
catstr catstr catstr catstr catstr
|
|
;
|
|
|
|
: FUNCTION
|
|
"@findex " - a
|
|
skip_past_newline
|
|
copy_past_newline
|
|
dup - a x x
|
|
"@subsubsection @code{" - a x x b
|
|
swap
|
|
remchar
|
|
"}\n" - a x b x c
|
|
catstr catstr catstr catstr catstr
|
|
;
|
|
|
|
: bodytext
|
|
get_stuff_in_command
|
|
bulletize
|
|
kill_bogus_lines
|
|
do_fancy_stuff
|
|
courierize
|
|
catstr
|
|
"\n" catstr
|
|
;
|
|
|
|
: asection
|
|
skip_past_newline
|
|
catstr
|
|
copy_past_newline
|
|
do_fancy_stuff catstr
|
|
bodytext
|
|
;
|
|
|
|
: SECTION
|
|
"@section " asection ;
|
|
|
|
: SUBSECTION
|
|
"@subsection " asection ;
|
|
|
|
: SUBSUBSECTION
|
|
"@subsubsection " asection ;
|
|
|
|
: subhead
|
|
skip_past_newline
|
|
bodytext
|
|
;
|
|
|
|
|
|
|
|
|
|
: DESCRIPTION
|
|
subhead
|
|
"@end deftypefn\n" synopsis_seen @ catstrif
|
|
0 synopsis_seen !
|
|
;
|
|
|
|
: INTERNAL_FUNCTION
|
|
func ;
|
|
|
|
|
|
: INTERNAL_DEFINITION
|
|
func ;
|
|
|
|
|
|
: INTERNAL
|
|
func ;
|
|
|
|
: TYPEDEF
|
|
FUNCTION ;
|
|
|
|
: SENUM
|
|
skip_past_newline
|
|
"Here are the possible values for @code{enum "
|
|
copy_past_newline remchar catstr
|
|
"}:\n\n" catstr catstr
|
|
;
|
|
: ENUM
|
|
skip_past_newline
|
|
"@deffn {} "
|
|
copy_past_newline catstr catstr
|
|
;
|
|
: ENUMX
|
|
skip_past_newline
|
|
"@deffnx {} "
|
|
copy_past_newline catstr
|
|
catstr
|
|
;
|
|
: ENUMEQ
|
|
skip_past_newline
|
|
"@deffn {} "
|
|
copy_past_newline catstr catstr
|
|
skip_past_newline
|
|
;
|
|
: ENUMEQX
|
|
skip_past_newline
|
|
"@deffnx {} "
|
|
copy_past_newline catstr
|
|
catstr
|
|
skip_past_newline
|
|
;
|
|
: ENUMDOC
|
|
skip_past_newline
|
|
get_stuff_in_command
|
|
strip_trailing_newlines
|
|
catstr
|
|
"\n@end deffn\n" catstr
|
|
;
|