public inbox for gcc-bugs@sourceware.org
help / color / mirror / Atom feed
* [Bug other/44414]  New: hashtab.h functions are undocumented
@ 2010-06-04 12:29 ro at gcc dot gnu dot org
  2010-06-04 12:32 ` [Bug other/44414] " rguenth at gcc dot gnu dot org
  2010-06-04 12:58 ` ro at gcc dot gnu dot org
  0 siblings, 2 replies; 3+ messages in thread
From: ro at gcc dot gnu dot org @ 2010-06-04 12:29 UTC (permalink / raw)
  To: gcc-bugs

When I recently needed to use htab_* functions from libiberty's hashtab.h, I
found
that they are completely undocumented: the comments in the header aren't enough
to use them, so I had to look at both the implementation and other uses to
figure
things out.


-- 
           Summary: hashtab.h functions are undocumented
           Product: gcc
           Version: 4.6.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: normal
          Priority: P3
         Component: other
        AssignedTo: unassigned at gcc dot gnu dot org
        ReportedBy: ro at gcc dot gnu dot org


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=44414


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [Bug other/44414] hashtab.h functions are undocumented
  2010-06-04 12:29 [Bug other/44414] New: hashtab.h functions are undocumented ro at gcc dot gnu dot org
@ 2010-06-04 12:32 ` rguenth at gcc dot gnu dot org
  2010-06-04 12:58 ` ro at gcc dot gnu dot org
  1 sibling, 0 replies; 3+ messages in thread
From: rguenth at gcc dot gnu dot org @ 2010-06-04 12:32 UTC (permalink / raw)
  To: gcc-bugs



------- Comment #1 from rguenth at gcc dot gnu dot org  2010-06-04 12:32 -------
libiberty has documentation in source libiberty/hashtab.c.


-- 

rguenth at gcc dot gnu dot org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |RESOLVED
         Resolution|                            |WORKSFORME


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=44414


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [Bug other/44414] hashtab.h functions are undocumented
  2010-06-04 12:29 [Bug other/44414] New: hashtab.h functions are undocumented ro at gcc dot gnu dot org
  2010-06-04 12:32 ` [Bug other/44414] " rguenth at gcc dot gnu dot org
@ 2010-06-04 12:58 ` ro at gcc dot gnu dot org
  1 sibling, 0 replies; 3+ messages in thread
From: ro at gcc dot gnu dot org @ 2010-06-04 12:58 UTC (permalink / raw)
  To: gcc-bugs



------- Comment #2 from ro at gcc dot gnu dot org  2010-06-04 12:58 -------
This is not proper documentation: most part of libiberty use comments which
can be extracted and put into the .texi files, while hashtab.c does not.


-- 

ro at gcc dot gnu dot org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |UNCONFIRMED
         Resolution|WORKSFORME                  |


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=44414


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2010-06-04 12:58 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-06-04 12:29 [Bug other/44414] New: hashtab.h functions are undocumented ro at gcc dot gnu dot org
2010-06-04 12:32 ` [Bug other/44414] " rguenth at gcc dot gnu dot org
2010-06-04 12:58 ` ro at gcc dot gnu dot org

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).