You are viewing a plain text version of this content. The canonical link for it is here.
Posted to apreq-dev@httpd.apache.org by "Philip M. Gollucci" <pg...@p6m7g8.com> on 2005/12/14 07:27:23 UTC

doxygen

Is it worth fixing these ?
usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:40: 
Warning: Member APREQ_DECLARE(d) of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:41: 
Warning: Member APREQ_DECLARE_NONSTD(d) of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:42: 
Warning: Member APREQ_DECLARE_DATA of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:49: 
Warning: Member APREQ_DEFAULT_READ_BLOCK_SIZE of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:50: 
Warning: Member APREQ_DEFAULT_READ_LIMIT of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:51: 
Warning: Member APREQ_DEFAULT_BRIGADE_LIMIT of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:52: 
Warning: Member APREQ_DEFAULT_NELTS of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:56: 
Warning: Member APREQ_FLAGS_OFF(f, name) of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:57: 
Warning: Member APREQ_FLAGS_ON(f, name) of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:58: 
Warning: Member APREQ_FLAGS_GET(f, name) of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:61: 
Warning: Member APREQ_FLAGS_SET(f, name, value) of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:64: 
Warning: Member APREQ_CHARSET_BIT of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:65: 
Warning: Member APREQ_CHARSET_MASK of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:67: 
Warning: Member APREQ_TAINTED_BIT of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:68: 
Warning: Member APREQ_TAINTED_MASK of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:70: 
Warning: Member APREQ_COOKIE_VERSION_BIT of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:71: 
Warning: Member APREQ_COOKIE_VERSION_MASK of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:73: 
Warning: Member APREQ_COOKIE_SECURE_BIT of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:74: 
Warning: Member APREQ_COOKIE_SECURE_MASK of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:119: 
Warning: Member apreq_attr_to_type(T, A, P) of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:115: 
Warning: Member apreq_value_table_add(const apreq_value_t *v, apr_table_t 
*t) of file apreq.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq_error.h:43: 
Warning: Member APR_EBADARG of file apreq_error.h is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/module/apache2/apreq_module_apache2.h:142: 
Warning: Member APREQ_FILTER_NAME of group mod_apreq2 is not documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/module/apache2/apreq_module_apache2.h:143: 
Warning: Member APREQ_APACHE2_MMN of group mod_apreq2 is not documented.



------------------------------------------------------------------------
"Love is not the one you can picture yourself marrying,
but the one you can't picture the rest of your life without."

"It takes a minute to have a crush on someone, an hour to like someone,
and a day to love someone, but it takes a lifetime to forget someone..."

Philip M. Gollucci (pgollucci@p6m7g8.com) 301.254.5198
Consultant / http://p6m7g8.net/Resume/resume.shtml
Senior Software Engineer - TicketMaster - http://ticketmaster.com


Re: doxygen [ALL AS 1]

Posted by Joe Schaefer <jo...@sunstarsys.com>.
"Philip M. Gollucci" <pg...@p6m7g8.com> writes:

> Hi,
>
> I've just commited the DOCS portion of that.
>
> The below was spliced in which I didn't commit.  Sine this is actually
> a code change, I'll just double check one more time before adding this part.

+1 to commit.

-- 
Joe Schaefer


Re: doxygen [ALL AS 1]

Posted by "Philip M. Gollucci" <pg...@p6m7g8.com>.
Hi,

I've just commited the DOCS portion of that.

The below was spliced in which I didn't commit.  Sine this is actually
a code change, I'll just double check one more time before adding this part.

Index: include/apreq_version.h
===================================================================
--- include/apreq_version.h (revision 359541)
+++ include/apreq_version.h (working copy)
@@ -61,7 +61,7 @@
  #define APREQ_MINOR_VERSION       5

  /** patch level */
-#define APREQ_PATCH_VERSION       6
+#define APREQ_PATCH_VERSION       7

  /**
   *  This symbol is defined for internal, "development" copies of libapreq.
Index: module/apache2/filter.c
===================================================================
--- module/apache2/filter.c (revision 359541)
+++ module/apache2/filter.c (working copy)
@@ -36,7 +36,7 @@
      /* d == OR_ALL */
      struct dir_config *dc = apr_palloc(p, sizeof *dc);
      dc->temp_dir      = NULL;
-    dc->read_limit    = (apr_uint64_t)-1;
+    dc->read_limit    = APREQ_DEFAULT_READ_LIMIT;
      dc->brigade_limit = APREQ_DEFAULT_BRIGADE_LIMIT;
      return dc;
  }
Index: CHANGES
===================================================================
--- CHANGES (revision 359541)
+++ CHANGES (working copy)
@@ -4,6 +4,8 @@

  @section v2_07 Changes with libapreq2-2.07

+- C API [Philip M. Gollucci]
+  Use the APREQ_DEFAULT_READ_LIMIT constant for the read_limit

  - C API [Ville Skyttä, Dirk Nehring]
    Add explicit cast in apreq_escape()/apreq_util.h to keep
-- 
------------------------------------------------------------------------
"Love is not the one you can picture yourself marrying,
but the one you can't picture the rest of your life without."

"It takes a minute to have a crush on someone, an hour to like someone,
and a day to love someone, but it takes a lifetime to forget someone..."

Philip M. Gollucci (pgollucci@p6m7g8.com) 301.254.5198
Consultant / http://p6m7g8.net/Resume/resume.shtml
Senior Software Engineer - TicketMaster - http://ticketmaster.com


Re: doxygen [ALL AS 1]

Posted by "Philip M. Gollucci" <pg...@p6m7g8.com>.
>(gmake docs > stdout) |& grep -i apreq
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/5.8.7_svn_prefork/include/apreq.h:239: 
Warning: Member apreq_attr_to_type(T, A, P) of file apreq.h is not 
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/5.8.7_svn_prefork/include/apreq_error.h:43: 
Warning: Member APR_EBADARG of file apreq_error.h is not documented.

Full patch attached



------------------------------------------------------------------------
"Love is not the one you can picture yourself marrying,
but the one you can't picture the rest of your life without."

"It takes a minute to have a crush on someone, an hour to like someone,
and a day to love someone, but it takes a lifetime to forget someone..."

Philip M. Gollucci (pgollucci@p6m7g8.com) 301.254.5198
Consultant / http://p6m7g8.net/Resume/resume.shtml
Senior Software Engineer - TicketMaster - http://ticketmaster.com

Re: doxygen

Posted by "Philip M. Gollucci" <pg...@p6m7g8.com>.
> /usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:50: 
> Warning: Member APREQ_DEFAULT_READ_LIMIT of file apreq.h is not documented.
AFAIK this isn't used.  Just defined:
#define APREQ_DEFAULT_READ_LIMIT        (64 * 1024 * 1024)

I believe it supposed to be used here:

diff module/apache2/filter.c
-    dc->read_limit    = (apr_uint64_t)-1;
+    dc->read_limit    = APREQ_DEFAULT_READ_LIMIT;
[full patch attached]

Also included documentation for
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:49:
Warning: Member APREQ_DEFAULT_READ_BLOCK_SIZE of file apreq.h is not
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:51:
Warning: Member APREQ_DEFAULT_BRIGADE_LIMIT of file apreq.h is not
documented.
/usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:52:
Warning: Member APREQ_DEFAULT_NELTS of file apreq.h is not documented.

[Patch attached]





Re: doxygen

Posted by "Philip M. Gollucci" <pg...@p6m7g8.com>.
On Wed, 14 Dec 2005, Philip M. Gollucci wrote:

> Is it worth fixing these ?
> usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:40: 
> Warning: Member APREQ_DECLARE(d) of file apreq.h is not documented.
> /usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:41: 
> Warning: Member APREQ_DECLARE_NONSTD(d) of file apreq.h is not documented.
> /usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:42: 
> Warning: Member APREQ_DECLARE_DATA of file apreq.h is not documented.
Steal/Tweak some documentation for these for APR.

Attached.



------------------------------------------------------------------------
"Love is not the one you can picture yourself marrying,
but the one you can't picture the rest of your life without."

"It takes a minute to have a crush on someone, an hour to like someone,
and a day to love someone, but it takes a lifetime to forget someone..."

Philip M. Gollucci (pgollucci@p6m7g8.com) 301.254.5198
Consultant / http://p6m7g8.net/Resume/resume.shtml
Senior Software Engineer - TicketMaster - http://ticketmaster.com

Re: doxygen

Posted by Joe Schaefer <jo...@sunstarsys.com>.
"Philip M. Gollucci" <pg...@p6m7g8.com> writes:

> Is it worth fixing these ?

Sure, wanna take a crack at it?

-- 
Joe Schaefer