diff options
| author | Tom Tromey <tom@tromey.com> | 2023-02-07 21:43:37 -0700 |
|---|---|---|
| committer | Tom Tromey <tom@tromey.com> | 2023-02-15 10:27:34 -0700 |
| commit | f370ae88a81ce5775c008e9509a53d34d6707d65 (patch) | |
| tree | 72bffa54983a135f01af26b2cf1493b735a64a80 /bfd/doc | |
| parent | b8e81f19cbbe978c7376795129ee90ee8e73cf0a (diff) | |
| download | gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.zip gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.tar.gz gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.tar.bz2 | |
Remove RETURNS from BFD chew comments
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.
Diffstat (limited to 'bfd/doc')
| -rw-r--r-- | bfd/doc/doc.str | 3 | ||||
| -rw-r--r-- | bfd/doc/proto.str | 1 |
2 files changed, 0 insertions, 4 deletions
diff --git a/bfd/doc/doc.str b/bfd/doc/doc.str index 4576d49..2a0953a 100644 --- a/bfd/doc/doc.str +++ b/bfd/doc/doc.str @@ -124,9 +124,6 @@ variable synopsis_seen 0 synopsis_seen ! ; -: RETURNS - "@strong{Returns}@*\n" catstr subhead ; - : INTERNAL_FUNCTION func ; diff --git a/bfd/doc/proto.str b/bfd/doc/proto.str index 5206f7f..3b77673 100644 --- a/bfd/doc/proto.str +++ b/bfd/doc/proto.str @@ -144,7 +144,6 @@ : INTERNAL_DEFINITION internal ; : DESCRIPTION ignore ; : FUNCTION external ; -: RETURNS ignore ; : TYPEDEF external ; : INTERNAL_FUNCTION internal ; : INTERNAL internal ; |