diff options
author | Steve Chamberlain <sac@cygnus> | 1991-12-01 00:39:12 +0000 |
---|---|---|
committer | Steve Chamberlain <sac@cygnus> | 1991-12-01 00:39:12 +0000 |
commit | 0cda46cff12b3ee596b1d1ac521a3014e92b5492 (patch) | |
tree | fee107a1424a5ffc7b6a17b5ba4ca91565fb8cad /bfd/core.c | |
parent | 93351e91c53c3a4dcc69950f6542c2e7788d7851 (diff) | |
download | binutils-gdb-0cda46cff12b3ee596b1d1ac521a3014e92b5492.tar.gz |
New documentation style
Diffstat (limited to 'bfd/core.c')
-rw-r--r-- | bfd/core.c | 67 |
1 files changed, 44 insertions, 23 deletions
diff --git a/bfd/core.c b/bfd/core.c index 49fa7dc9a42..993df114525 100644 --- a/bfd/core.c +++ b/bfd/core.c @@ -18,22 +18,29 @@ 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., 675 Mass Ave, Cambridge, MA 02139, USA. */ -/*doc* -@section Core files -Buff output this facinating topic +/* +SECTION + Core files + +DESCRIPTION + Buff output this facinating topic */ #include "bfd.h" #include "sysdep.h" #include "libbfd.h" -/** Some core file info commands */ -/*proto* bfd_core_file_failing_command -Returns a read-only string explaining what program was running when -it failed and produced the core file being read +/* +FUNCTION + bfd_core_file_failing_command + +DESCRIPTION + Returns a read-only string explaining what program was running + when it failed and produced the core file being read -*; PROTO(CONST char *, bfd_core_file_failing_command, (bfd *)); +SYNOPSIS + CONST char *bfd_core_file_failing_command(bfd *); */ CONST char * @@ -47,12 +54,18 @@ DEFUN(bfd_core_file_failing_command,(abfd), return BFD_SEND (abfd, _core_file_failing_command, (abfd)); } -/*proto* bfd_core_file_failing_signal -Returns the signal number which caused the core dump which generated -the file the BFD is attached to. +/* +FUNCTION + bfd_core_file_failing_signal -*; PROTO(int, bfd_core_file_failing_signal, (bfd *)); +DESCRIPTION + Returns the signal number which caused the core dump which + generated the file the BFD is attached to. + +SYNOPSIS + int bfd_core_file_failing_signal(bfd *); */ + int bfd_core_file_failing_signal (abfd) bfd *abfd; @@ -65,21 +78,29 @@ bfd_core_file_failing_signal (abfd) } -/*proto* core_file_matches_executable_p -Returns @code{true} if the core file attached to @var{core_bfd} was -generated by a run of the executable file attached to @var{exec_bfd}, -or else @code{false}. -*; PROTO(boolean, core_file_matches_executable_p, - (bfd *core_bfd, bfd *exec_bfd)); +/* +FUNCTION + core_file_matches_executable_p + +DESCRIPTION + Returns <<true>> if the core file attached to @var{core_bfd} + was generated by a run of the executable file attached to + @var{exec_bfd}, or else <<false>>. + +SYNOPSIS + boolean core_file_matches_executable_p + (bfd *core_bfd, bfd *exec_bfd); */ + boolean core_file_matches_executable_p (core_bfd, exec_bfd) bfd *core_bfd, *exec_bfd; { - if ((core_bfd->format != bfd_core) || (exec_bfd->format != bfd_object)) { - bfd_error = wrong_format; - return false; - } + if ((core_bfd->format != bfd_core) || (exec_bfd->format != bfd_object)) { + bfd_error = wrong_format; + return false; + } - return BFD_SEND (core_bfd, _core_file_matches_executable_p, (core_bfd, exec_bfd)); + return BFD_SEND (core_bfd, _core_file_matches_executable_p, + (core_bfd, exec_bfd)); } |