Permalink
Browse files

[codingstd] gerd++ reported failures in c_function_docs.t. These can be

cleared up by running 'make headerizer', which will bring function
signatures in POD back into line with revised signatures in the
functions themselves.
  • Loading branch information...
1 parent 0889a4a commit 5f8ff5d9d9f4e8e0546b93f3a36d42b3d6503e14 @jkeenan jkeenan committed Oct 10, 2011
Showing with 63 additions and 51 deletions.
  1. +4 −2 src/gc/alloc_resources.c
  2. +8 −7 src/gc/api.c
  3. +10 −9 src/gc/gc_gms.c
  4. +8 −7 src/gc/gc_inf.c
  5. +10 −9 src/gc/gc_ms.c
  6. +10 −9 src/gc/gc_ms2.c
  7. +11 −6 src/gc/string_gc.c
  8. +2 −2 src/string/api.c
View
@@ -41,7 +41,8 @@ typedef struct string_callback_data {
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
-static const char * buffer_location(PARROT_INTERP, ARGIN(const Parrot_Buffer *b))
+static const char * buffer_location(PARROT_INTERP,
+ ARGIN(const Parrot_Buffer *b))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
@@ -131,7 +132,8 @@ static int sweep_cb_pmc(PARROT_INTERP,
/*
-=item C<static const char * buffer_location(PARROT_INTERP, const Buffer *b)>
+=item C<static const char * buffer_location(PARROT_INTERP, const Parrot_Buffer
+*b)>
Returns a constant string representing the location of the given
Buffer C<b> in one of the PMC registers. If the PMC is not located
View
@@ -394,7 +394,8 @@ Parrot_gc_free_string_header(PARROT_INTERP, ARGMOD(STRING *s))
/*
-=item C<Parrot_Buffer * Parrot_gc_new_bufferlike_header(PARROT_INTERP, size_t size)>
+=item C<Parrot_Buffer * Parrot_gc_new_bufferlike_header(PARROT_INTERP, size_t
+size)>
Returns a new buffer-like header from the appropriate sized pool.
A "bufferlike object" is an object that is considered to be isomorphic to the
@@ -417,8 +418,8 @@ Parrot_gc_new_bufferlike_header(PARROT_INTERP, size_t size)
/*
-=item C<void Parrot_gc_free_bufferlike_header(PARROT_INTERP, Buffer *obj, size_t
-size)>
+=item C<void Parrot_gc_free_bufferlike_header(PARROT_INTERP, Parrot_Buffer *obj,
+size_t size)>
Free a bufferlike header that is not being used, so that Parrot can recycle
it and use it again.
@@ -438,8 +439,8 @@ Parrot_gc_free_bufferlike_header(PARROT_INTERP, ARGMOD(Parrot_Buffer *obj),
/*
-=item C<void Parrot_gc_allocate_buffer_storage_aligned(PARROT_INTERP, Parrot_Buffer
-*buffer, size_t size)>
+=item C<void Parrot_gc_allocate_buffer_storage_aligned(PARROT_INTERP,
+Parrot_Buffer *buffer, size_t size)>
Allocates a chunk of memory of at least size C<size> for the given Parrot_Buffer.
buffer is guaranteed to be properly aligned for things like C<FLOATVALS>,
@@ -460,8 +461,8 @@ Parrot_gc_allocate_buffer_storage_aligned(PARROT_INTERP,
/*
-=item C<void Parrot_gc_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *buffer,
-size_t newsize)>
+=item C<void Parrot_gc_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer
+*buffer, size_t newsize)>
Reallocate the Parrot_Buffer's buffer memory to the given size. The
allocated buffer will not shrink. If the buffer was allocated with
View
@@ -210,7 +210,8 @@ static void failed_allocation(unsigned int line, size_t size);
PARROT_MALLOC
PARROT_CAN_RETURN_NULL
-static Parrot_Buffer* gc_gms_allocate_buffer_header(PARROT_INTERP, size_t size)
+static Parrot_Buffer* gc_gms_allocate_buffer_header(PARROT_INTERP,
+ size_t size)
__attribute__nonnull__(1);
static void gc_gms_allocate_buffer_storage(PARROT_INTERP,
@@ -1230,11 +1231,11 @@ size_t size)>
=item C<static void gc_gms_reallocate_string_storage(PARROT_INTERP, STRING *str,
size_t size)>
-=item C<static void gc_gms_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
-size_t size)>
+=item C<static void gc_gms_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer
+*str, size_t size)>
-=item C<static void gc_gms_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
-size_t size)>
+=item C<static void gc_gms_reallocate_buffer_storage(PARROT_INTERP,
+Parrot_Buffer *str, size_t size)>
=item C<static void* gc_gms_allocate_fixed_size_storage(PARROT_INTERP, size_t
size)>
@@ -1500,11 +1501,11 @@ gc_gms_is_pmc_ptr(PARROT_INTERP, ARGIN_NULLOK(void *ptr))
=item C<gc_gms_free_string_header(PARROT_INTERP, STRING *s)>
-=item C<static Parrot_Buffer* gc_gms_allocate_buffer_header(PARROT_INTERP, size_t
-size)>
+=item C<static Parrot_Buffer* gc_gms_allocate_buffer_header(PARROT_INTERP,
+size_t size)>
-=item C<static void gc_gms_free_buffer_header(PARROT_INTERP, Parrot_Buffer *s, size_t
-size)>
+=item C<static void gc_gms_free_buffer_header(PARROT_INTERP, Parrot_Buffer *s,
+size_t size)>
Allocate/free string/buffer headers.
View
@@ -49,7 +49,8 @@ static void gc_inf_allocate_buffer_storage(PARROT_INTERP,
PARROT_MALLOC
PARROT_CAN_RETURN_NULL
-static Parrot_Buffer* gc_inf_allocate_bufferlike_header(PARROT_INTERP, size_t size);
+static Parrot_Buffer* gc_inf_allocate_bufferlike_header(PARROT_INTERP,
+ size_t size);
PARROT_CAN_RETURN_NULL
static void* gc_inf_allocate_fixed_size_storage(PARROT_INTERP, size_t size);
@@ -227,12 +228,12 @@ flags)>
=item C<static void gc_inf_free_string_header(PARROT_INTERP, STRING *s)>
-=item C<static Parrot_Buffer* gc_inf_allocate_bufferlike_header(PARROT_INTERP, size_t
-size)>
-
-=item C<static void gc_inf_free_bufferlike_header(PARROT_INTERP, Parrot_Buffer *b,
+=item C<static Parrot_Buffer* gc_inf_allocate_bufferlike_header(PARROT_INTERP,
size_t size)>
+=item C<static void gc_inf_free_bufferlike_header(PARROT_INTERP, Parrot_Buffer
+*b, size_t size)>
+
=item C<static void* gc_inf_allocate_pmc_attributes(PARROT_INTERP, PMC *pmc)>
=item C<static void gc_inf_free_pmc_attributes(PARROT_INTERP, PMC *pmc)>
@@ -246,8 +247,8 @@ size_t size)>
=item C<static void gc_inf_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer
*buffer, size_t size)>
-=item C<static void gc_inf_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer
-*buffer, size_t size)>
+=item C<static void gc_inf_reallocate_buffer_storage(PARROT_INTERP,
+Parrot_Buffer *buffer, size_t size)>
=item C<static void* gc_inf_allocate_fixed_size_storage(PARROT_INTERP, size_t
size)>
View
@@ -59,7 +59,8 @@ static void gc_ms_alloc_objects(PARROT_INTERP,
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
-static Parrot_Buffer * gc_ms_allocate_bufferlike_header(PARROT_INTERP, size_t size)
+static Parrot_Buffer * gc_ms_allocate_bufferlike_header(PARROT_INTERP,
+ size_t size)
__attribute__nonnull__(1);
PARROT_MALLOC
@@ -669,11 +670,11 @@ size)>
=item C<void gc_ms_reallocate_string_storage(PARROT_INTERP, STRING *str, size_t
size)>
-=item C<void gc_ms_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str, size_t
-size)>
+=item C<void gc_ms_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
+size_t size)>
-=item C<void gc_ms_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str, size_t
-size)>
+=item C<void gc_ms_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
+size_t size)>
Functions for allocating strings/buffers storage.
@@ -978,8 +979,8 @@ gc_ms_mark_str_header(SHIM_INTERP, ARGMOD_NULLOK(STRING *obj))
/*
-=item C<static Parrot_Buffer * gc_ms_allocate_bufferlike_header(PARROT_INTERP, size_t
-size)>
+=item C<static Parrot_Buffer * gc_ms_allocate_bufferlike_header(PARROT_INTERP,
+size_t size)>
Returns a new buffer-like header from the appropriate sized pool.
A "bufferlike object" is an object that is considered to be isomorphic to the
@@ -1005,8 +1006,8 @@ gc_ms_allocate_bufferlike_header(PARROT_INTERP, size_t size)
/*
-=item C<static void gc_ms_free_bufferlike_header(PARROT_INTERP, Parrot_Buffer *obj,
-size_t size)>
+=item C<static void gc_ms_free_bufferlike_header(PARROT_INTERP, Parrot_Buffer
+*obj, size_t size)>
Free a bufferlike header that is not being used, so that Parrot can recycle
it and use it again.
View
@@ -79,7 +79,8 @@ static void failed_allocation(unsigned int line, unsigned long size);
PARROT_MALLOC
PARROT_CAN_RETURN_NULL
-static Parrot_Buffer* gc_ms2_allocate_buffer_header(PARROT_INTERP, size_t size)
+static Parrot_Buffer* gc_ms2_allocate_buffer_header(PARROT_INTERP,
+ size_t size)
__attribute__nonnull__(1);
static void gc_ms2_allocate_buffer_storage(PARROT_INTERP,
@@ -433,11 +434,11 @@ size_t size)>
=item C<static void gc_ms2_reallocate_string_storage(PARROT_INTERP, STRING *str,
size_t size)>
-=item C<static void gc_ms2_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
-size_t size)>
+=item C<static void gc_ms2_allocate_buffer_storage(PARROT_INTERP, Parrot_Buffer
+*str, size_t size)>
-=item C<static void gc_ms2_reallocate_buffer_storage(PARROT_INTERP, Parrot_Buffer *str,
-size_t size)>
+=item C<static void gc_ms2_reallocate_buffer_storage(PARROT_INTERP,
+Parrot_Buffer *str, size_t size)>
=item C<static void* gc_ms2_allocate_fixed_size_storage(PARROT_INTERP, size_t
size)>
@@ -789,11 +790,11 @@ gc_ms2_is_pmc_ptr(PARROT_INTERP, ARGIN_NULLOK(void *ptr))
=item C<gc_ms2_free_string_header()>
-=item C<static Parrot_Buffer* gc_ms2_allocate_buffer_header(PARROT_INTERP, size_t
-size)>
+=item C<static Parrot_Buffer* gc_ms2_allocate_buffer_header(PARROT_INTERP,
+size_t size)>
-=item C<static void gc_ms2_free_buffer_header(PARROT_INTERP, Parrot_Buffer *s, size_t
-size)>
+=item C<static void gc_ms2_free_buffer_header(PARROT_INTERP, Parrot_Buffer *s,
+size_t size)>
Allocate/free string/buffer headers.
View
@@ -38,7 +38,9 @@ typedef void (*compact_f) (Interp *, GC_Statistics *stats, Variable_Size_Pool *)
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
-static char * aligned_mem(ARGIN(const Parrot_Buffer *buffer), ARGIN(char *mem))
+static char * aligned_mem(
+ ARGIN(const Parrot_Buffer *buffer),
+ ARGIN(char *mem))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
@@ -55,7 +57,8 @@ static void alloc_new_block(
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
-static const char * buffer_location(PARROT_INTERP, ARGIN(const Parrot_Buffer *b))
+static const char * buffer_location(PARROT_INTERP,
+ ARGIN(const Parrot_Buffer *b))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
@@ -678,7 +681,8 @@ aligned_mem(ARGIN(SHIM(const Parrot_Buffer *buffer)), ARGIN(char *mem))
/*
-=item C<static const char * buffer_location(PARROT_INTERP, const Parrot_Buffer *b)>
+=item C<static const char * buffer_location(PARROT_INTERP, const Parrot_Buffer
+*b)>
Returns a constant string representing the location of the given
Parrot_Buffer C<b> in one of the PMC registers. If the PMC is not located
@@ -797,7 +801,8 @@ compact_pool(PARROT_INTERP,
}
/*
-=item C<static void move_buffer_callback(PARROT_INTERP, Parrot_Buffer *b, void *data)>
+=item C<static void move_buffer_callback(PARROT_INTERP, Parrot_Buffer *b, void
+*data)>
Callback for live STRING/Buffer for compating.
@@ -890,8 +895,8 @@ pad_pool_size(ARGIN(const Variable_Size_Pool *pool))
/*
-=item C<static void move_one_buffer(PARROT_INTERP, Memory_Block *pool, Parrot_Buffer
-*old_buf)>
+=item C<static void move_one_buffer(PARROT_INTERP, Memory_Block *pool,
+Parrot_Buffer *old_buf)>
The compact_pool operation collects disjointed blocks of memory allocated on a
given pool's free list into one large block of memory. Once the new larger
View
@@ -558,8 +558,8 @@ Parrot_str_new(PARROT_INTERP, ARGIN_NULLOK(const char *buffer), const UINTVAL le
/*
-=item C<STRING * Parrot_str_new_from_buffer(PARROT_INTERP, Buffer *buffer, const
-UINTVAL len)>
+=item C<STRING * Parrot_str_new_from_buffer(PARROT_INTERP, Parrot_Buffer
+*buffer, const UINTVAL len)>
Makes a Parrot string from a Buffer.

0 comments on commit 5f8ff5d

Please sign in to comment.