PATCH: Add more bfd/opncls.c documentation

PATCH: Add more bfd/opncls.c documentation

[Ben Elliston]

[-- Attachment #1: Type: text/plain, Size: 1054 bytes --]

I'm committing the following as obvious, however are bfd_alloc and
bfd_zalloc really internal functions?  They _do_ appear in libbfd.h.

Ben

2005-02-23  Ben Elliston  <bje@au.ibm.com>

        * opncls.c (bfd_zalloc): Document this function.

Index: opncls.c
===================================================================
RCS file: /cvs/src/src/bfd/opncls.c,v
retrieving revision 1.28
diff -u -p -r1.28 opncls.c
--- opncls.c    20 Feb 2005 14:59:07 -0000      1.28
+++ opncls.c    23 Feb 2005 03:48:35 -0000
@@ -820,7 +820,6 @@ DESCRIPTION
         <<abfd>> and return a pointer to it.
  */

-
  void *
  bfd_alloc (bfd *abfd, bfd_size_type size)
  {
@@ -838,6 +837,18 @@ bfd_alloc (bfd *abfd, bfd_size_type size
    return ret;
  }

+/*
+INTERNAL_FUNCTION
+       bfd_zalloc
+
+SYNOPSIS
+       void *bfd_zalloc (bfd *abfd, bfd_size_type wanted);
+
+DESCRIPTION
+       Allocate a block of @var{wanted} bytes of zeroed memory
+       attached to <<abfd>> and return a pointer to it.
+*/
+
  void *
  bfd_zalloc (bfd *abfd, bfd_size_type size)
  {

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 256 bytes --]

Re: PATCH: Add more bfd/opncls.c documentation

[Ian Lance Taylor]

Ben Elliston <bje@au1.ibm.com> writes:

> I'm committing the following as obvious, however are bfd_alloc and
> bfd_zalloc really internal functions?  They _do_ appear in libbfd.h.

libbfd.h is where internal functions are declared.

External functions are declared in bfd-in2.h.

Or do you mean that you think bfd_alloc and bfd_zalloc should be
considered to be external functions?  If so, why?

Ian