httpd-bugs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 35975] - Confusing documentation for apr_pool_cleanup_run()
Date Thu, 11 Aug 2005 19:56:26 GMT
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG·
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=35975>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND·
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=35975


zilla@kayari.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #15853|0                           |1
        is obsolete|                            |




------- Additional Comments From zilla@kayari.org  2005-08-11 21:56 -------
Created an attachment (id=16014)
 --> (http://issues.apache.org/bugzilla/attachment.cgi?id=16014&action=view)
Clarify docs for cleanup functions

(Sorry for the delay, I was on holiday.)

This patch adds a Doxygen group for the cleanup functions, fixes some typos and
IMHO clarifies the behaviour of some of the cleanup functions.

For the functions that unregister a cleanup I have said:

  The most recently registered cleanup with the same values of @a p,
  @a data and @a cleanup will be removed.

That description doesn't explicitly say that the cleanup is registered with
pool 'p' but I think saying "the same values of p, data and cleanup" is
accurate enough but also short and pithy.  Would it be better to say something
like this?

  Removes the last cleanup registered with @a p with the same values
  of @a data and @cleanup.

I think the wording I chose is most easily understood by a quick glance at the
docs and/or by people for whom English is not their first language, but I'm
open to better suggestions.


-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

---------------------------------------------------------------------
To unsubscribe, e-mail: bugs-unsubscribe@httpd.apache.org
For additional commands, e-mail: bugs-help@httpd.apache.org


Mime
View raw message