* bfd-in.h (bfd_get{b,l}[_signed_]{16,32,64}): Declare argument to

[binutils.git] / bfd / core.c

diff --git a/bfd/core.c b/bfd/core.c
index b4ab497ecf78d508224b5e7acc3d7d8f24be03ff..bcdb9a4de484d467d52b3f09703c0430de95e322 100644 (file)
--- a/bfd/core.c
+++ b/bfd/core.c
@@ -1,19 +1,47 @@
-/*doc*
-@section Core files
-Buff output this facinating topic
+/* Core file generic interface routines for BFD.
+   Copyright (C) 1990-1991 Free Software Foundation, Inc.
+   Written by Cygnus Support.
+
+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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+
+/*
+SECTION
+       Core files
+
+DESCRIPTION
+       These are functions pertaining to core files.
 */
 
-#include "sysdep.h"
 #include "bfd.h"
+#include "sysdep.h"
 #include "libbfd.h"
 
-/** Some core file info commands */
 
-/*proto*i 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
+
+SYNOPSIS
+       CONST char *bfd_core_file_failing_command(bfd *abfd);
+
+DESCRIPTION
+       Return a read-only string explaining which program was running
+       when it failed and produced the core file @var{abfd}.
 
-*; PROTO(CONST char *, bfd_core_file_failing_command, (bfd *));
 */
 
 CONST char *
@@ -27,12 +55,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 attatched to.
+/*
+FUNCTION
+       bfd_core_file_failing_signal
 
-*; PROTO(int, bfd_core_file_failing_signal, (bfd *));
+SYNOPSIS
+       int bfd_core_file_failing_signal(bfd *abfd);
+
+DESCRIPTION
+       Returns the signal number which caused the core dump which
+       generated the file the BFD @var{abfd} is attached to.
 */
+
 int
 bfd_core_file_failing_signal (abfd)
      bfd *abfd;
@@ -45,21 +79,28 @@ bfd_core_file_failing_signal (abfd)
 }
 
 
-/*proto* core_file_matches_executable_p
-Returns @code{true} if the core file attatched to @var{core_bfd} was
-generated by a run of the executable file attatched 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
+
+SYNOPSIS
+       boolean core_file_matches_executable_p
+               (bfd *core_bfd, bfd *exec_bfd);
+
+DESCRIPTION
+       Return <<true>> if the core file attached to @var{core_bfd}
+       was generated by a run of the executable file attached to
+       @var{exec_bfd}, <<false>> otherwise.
 */
 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));
 }