Bug 55133 - Several comment errors in the APR header files
Summary: Several comment errors in the APR header files
Status: RESOLVED FIXED
Alias: None
Product: APR
Classification: Unclassified
Component: APR (show other bugs)
Version: HEAD
Hardware: All All
: P2 trivial (vote)
Target Milestone: ---
Assignee: Apache Portable Runtime bugs mailinglist
URL:
Keywords: PatchAvailable
Depends on:
Blocks:
 
Reported: 2013-06-24 20:17 UTC by Mike Rumph
Modified: 2013-06-25 20:45 UTC (History)
0 users



Attachments
A collection of comment corrections to the APR header files (21.49 KB, patch)
2013-06-24 20:20 UTC, Mike Rumph
Details | Diff
Comment changes for apr-1.5.x header files (13.15 KB, patch)
2013-06-25 20:31 UTC, Mike Rumph
Details | Diff
Comment changes for apr-util-1.5.x header files (5.71 KB, patch)
2013-06-25 20:33 UTC, Mike Rumph
Details | Diff
A slight correction to apr-util-1.5.x_comment changes. (5.71 KB, patch)
2013-06-25 20:45 UTC, Mike Rumph
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Mike Rumph 2013-06-24 20:17:59 UTC
I have been trying to gain a more in depth knowledge of the Apache httpd and APR source. In the process of studying through the APR headers, I noticed several comment errors. So I will submit a patch containing 52 corrections within a total of 14 of the APR header files.

These are a mix of comment typos and places where the comments and code do not match.

I limited this patch to comment changes only.
In the case of the mismatches, it might be preferred to change the code in some cases, such as the changes for apr_escape.h.

But I also noticed the following code blemishes:

The file apr_global_mutex.h includes apr_proc_mutex.h twice:

#include "apr.h"
#include "apr_proc_mutex.h"    /* only for apr_lockmech_e */
#include "apr_pools.h"
#include "apr_errno.h"
#if APR_PROC_MUTEX_IS_GLOBAL
#include "apr_proc_mutex.h"
#endif
 
And the file apr_thread_proc.h defines APR_NO_FILE twice.

I hope that this set of changes will help to improve the generated documentation for APR and APR-util.

Thanks,

Mike
Comment 1 Mike Rumph 2013-06-24 20:20:46 UTC
Created attachment 30481 [details]
A collection of comment corrections to the APR header files
Comment 2 Jeff Trawick 2013-06-25 10:59:27 UTC
Committed to apr trunk as r1496407.
If you'll split this up by apr-1.5.x/apr-util-1.5.x I'll commit there as well.
Comment 3 Mike Rumph 2013-06-25 20:31:49 UTC
Created attachment 30486 [details]
Comment changes for apr-1.5.x header files
Comment 4 Mike Rumph 2013-06-25 20:33:11 UTC
Created attachment 30487 [details]
Comment changes for apr-util-1.5.x header files
Comment 5 Mike Rumph 2013-06-25 20:45:16 UTC
Created attachment 30488 [details]
A slight correction to apr-util-1.5.x_comment changes.