From 368fa54f784b60034946d7cd1b42cfceeff55006 Mon Sep 17 00:00:00 2001 From: Christophe Jaillet Date: Fri, 20 Apr 2018 21:06:39 +0000 Subject: [PATCH] Improve highlight and make these doc much more readable. Use the "c" highlight for API description. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1829678 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_slotmem_plain.xml | 52 ++++++++++----------- docs/manual/mod/mod_slotmem_shm.xml | 65 +++++++++++++-------------- 2 files changed, 56 insertions(+), 61 deletions(-) diff --git a/docs/manual/mod/mod_slotmem_plain.xml b/docs/manual/mod/mod_slotmem_plain.xml index e7ccc39d3a3..71e933ab982 100644 --- a/docs/manual/mod/mod_slotmem_plain.xml +++ b/docs/manual/mod/mod_slotmem_plain.xml @@ -29,7 +29,7 @@ slotmem_plain_module -

mod_slotmem_plain is a memory provider which +

mod_slotmem_plain is a memory provider which provides for creation and access to a plain memory segment in which the datasets are organized in "slots."

@@ -39,43 +39,43 @@ mod_slotmem_shm.

-

mod_slotmem_plain provides the following API functions: +

mod_slotmem_plain provides the following API functions:

-
-
apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
-
call the callback on all worker slots
+ +/* call the callback on all worker slots */ +apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool) -
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool)
-
create a new slotmem with each item size is item_size.
+/* create a new slotmem with each item size is item_size */ +apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool) -
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool)
-
attach to an existing slotmem.
+/* attach to an existing slotmem */ +apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool) -
apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)
-
get the direct pointer to the memory associated with this worker slot.
+/* get the direct pointer to the memory associated with this worker slot */ +apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void **mem) -
apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)
-
get/read the memory from this slot to dest
+/* get/read the memory from this slot to dest */ +apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len) -
apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)
-
put/write the data from src to this slot
+/* put/write the data from src to this slot */ +apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len) -
unsigned int num_slots(ap_slotmem_instance_t *s)
-
return the total number of slots in the segment
+/* return the total number of slots in the segment */ +unsigned int num_slots(ap_slotmem_instance_t *s) -
apr_size_t slot_size(ap_slotmem_instance_t *s)
-
return the total data size, in bytes, of a slot in the segment
+/* return the total data size, in bytes, of a slot in the segment */ +apr_size_t slot_size(ap_slotmem_instance_t *s) -
apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id);
-
grab or allocate the first free slot and mark as in-use (does not do any data copying)
+/* grab or allocate the first free slot and mark as in-use (does not do any data copying) */ +apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id) -
apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id);
-
forced grab or allocate the specified slot and mark as in-use (does not do any data copying)
+/* forced grab or allocate the specified slot and mark as in-use (does not do any data copying) */ +apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id) -
apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);
-
release or free a slot and mark as not in-use (does not do any data copying)
-
+/* release or free a slot and mark as not in-use (does not do any data copying) */ +apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id) + diff --git a/docs/manual/mod/mod_slotmem_shm.xml b/docs/manual/mod/mod_slotmem_shm.xml index 4c45aa2c655..5312d12e1d5 100644 --- a/docs/manual/mod/mod_slotmem_shm.xml +++ b/docs/manual/mod/mod_slotmem_shm.xml @@ -29,7 +29,7 @@ slotmem_shm_module -

mod_slotmem_shm is a memory provider which +

mod_slotmem_shm is a memory provider which provides for creation and access to a shared memory segment in which the datasets are organized in "slots."

@@ -43,52 +43,47 @@ DefaultRuntimeDir directive.

-

mod_slotmem_shm provides the following API functions: +

mod_slotmem_shm provides the following API functions:

-
-
apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
-
call the callback on all worker slots
+ +/* call the callback on all worker slots */ +apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool) -
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool)
-
create a new slotmem with each item size is item_size. name is used to generate a filename for the persistent store of - the shared memory if configured. Values are: -
-
"none"
-
Anonymous shared memory and no persistent store
-
"file-name"
-
[DefaultRuntimeDir]/file-name
-
"/absolute-file-name"
-
Absolute file name
-
+/* create a new slotmem with each item size is item_size. 'name' is used to generate a filename for the persistent + store of the shared memory if configured. Values are: + "none" - Anonymous shared memory and no persistent store + "file-name" - [DefaultRuntimeDir]/file-name + "/absolute-file-name" - Absolute file name */ +apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool) -
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool)
-
attach to an existing slotmem. See create for description of name parameter.
+/* attach to an existing slotmem. See 'create()' for description of 'name' parameter */ +apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool) -
apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)
-
get the direct pointer to the memory associated with this worker slot.
+/* get the direct pointer to the memory associated with this worker slot */ +apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void **mem) -
apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)
-
get/read the memory from this slot to dest
+/* get/read the memory from this slot to dest */ +apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len) -
apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)
-
put/write the data from src to this slot
+/* put/write the data from src to this slot */ +apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len) -
unsigned int num_slots(ap_slotmem_instance_t *s)
-
return the total number of slots in the segment
+/* return the total number of slots in the segment */ +unsigned int num_slots(ap_slotmem_instance_t *s) -
apr_size_t slot_size(ap_slotmem_instance_t *s)
-
return the total data size, in bytes, of a slot in the segment
+/* return the total data size, in bytes, of a slot in the segment */ +apr_size_t slot_size(ap_slotmem_instance_t *s) -
apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id);
-
grab or allocate the first free slot and mark as in-use (does not do any data copying)
+/* grab or allocate the first free slot and mark as in-use (does not do any data copying) */ +apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id) -
apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id);
-
forced grab or allocate the specified slot and mark as in-use (does not do any data copying)
+/* forced grab or allocate the specified slot and mark as in-use (does not do any data copying) */ +apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id) -
apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);
-
release or free a slot and mark as not in-use (does not do any data copying)
-
+/* release or free a slot and mark as not in-use (does not do any data copying) */ +apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id) + -- 2.47.3