Changes between Version 1 and Version 2 of MissingCFunctionDocs

Timestamp:

01/16/10 22:25:32 (12 years ago)

Author:

mikehh

Comment:

correct some pasting errors and remove fixed src/nci_test.c (at r43473)

MissingCFunctionDocs

@@ -9 +9 @@
 Bear in mind we are dealing with POD and that it expects a maximum line length of 78.
 
-as of r43470 the following C functions are missing documentation:
+as of r43473 the following C functions are missing documentation:
 {{{
 
@@ -41 +41 @@
 # Want:
 # =item C<long parrot_i386_xadd(volatile long *l, long amount)>
+
 'compilers/pirc/src/pircompiler.c'
 
@@ -491 +492 @@
 # =item C<char * Parrot_getenv(PARROT_INTERP, STRING *str_name)>
 
-
 'config/gen/platform/generic/memalign.c'
 
@@ -533 +533 @@
 # newsize)>
 
-'src/nci_test.c'
-
-# 46 function(s) lacking documentation:
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char
-# nci_c(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char nci_c(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char
-# nci_csc(short l1, char l2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char nci_csc(short l1, char l2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT double
-# nci_d(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT double nci_d(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT double
-# nci_dd(double d)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT double nci_dd(double d)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT float
-# nci_f(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT float nci_f(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT float
-# nci_fff(float l1, float l2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT float nci_fff(float l1, float l2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_i(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_i(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_isc(short l1, char l2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_isc(short l1, char l2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_ip(void *p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_ip(void *p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_it(void *p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_it(void *p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT long
-# nci_l(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT long nci_l(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int *
-# nci_p(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int * nci_p(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char *
-# nci_t(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char * nci_t(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char *
-# nci_tb(void *p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char * nci_tb(void *p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char *
-# nci_tt(void *p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char * nci_tt(void *p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char *
-# nci_tB(void **p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char * nci_tB(void **p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void *
-# nci_pp(void *p)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void * nci_pp(void *p)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_iiii(int i1, int i2, int i3)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_iiii(int i1, int i2, int i3)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_i4i(long * l, int i)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_i4i(long * l, int i)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_ii3(int a, int *bp)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_ii3(int a, int *bp)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# call_back(const char *str)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int call_back(const char *str)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void *
-# nci_pi(int test)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void * nci_pi(int test)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT short
-# nci_s(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT short nci_s(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT short
-# nci_ssc(short l1, char l2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT short nci_ssc(short l1, char l2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vP(void *pmc)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vP(void *pmc)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_C1(cb_C1_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_C1(cb_C1_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_C2(cb_C2_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_C2(cb_C2_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_C3(cb_C3_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_C3(cb_C3_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_D1(cb_D1_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_D1(cb_D1_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_D2(cb_D2_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_D2(cb_D2_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)mpilers/pirc/src/pircompiler.c'
-mpilers/pirc/src/pircompiler.c'
-
-# 6 function(s) lacking documentation:
-# compilers/pirc/src/pircompiler.c (missing)
-# PARROT_MALLOC
-# PARROT_CANNOT_RETURN_NULL
-# PARROT_WARN_UNUSED_RESULT
-# static allocated_mem_ptrs *
-# new_mem_ptrs_block(void)
-# Want:
-# =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)>
-#
-# compilers/pirc/src/pircompiler.c (missing)
-# void
-# init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table),
-#                unsigned size)
-# Want:
-# =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table,
-# unsigned size)>
-#
-
-}
-
-# 6 function(s) lacking documentation:
-# compilers/pirc/src/pircompiler.c (missing)
-# PARROT_MALLOC
-# PARROT_CANNOT_RETURN_NULL
-# PARROT_WARN_UNUSED_RESULT
-# static allocated_mem_ptrs *
-# new_mem_ptrs_block(void)
-# Want:
-# =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)>
-#
-# compilers/pirc/src/pircompiler.c (missing)
-# void
-# init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table),
-#                unsigned size)
-# Want:
-# =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table,
-# unsigned size)>
-#
-
-}
-
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_D3(cb_D3_func cb, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_D3(cb_D3_func cb, void* user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_cb_D4(cb_D4_func times_ten, void* user_data)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_cb_D4(cb_D4_func times_ten, void*
-# user_data)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_pip(int count, Rect_Like *rects)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_pip(int count, Rect_Like *rects)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT int
-# nci_i33(int *double_me, int *triple_me)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT int nci_i33(int *double_me, int *triple_me)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vpii(Outer *my_data, int my_x, int my_y)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vpii(Outer *my_data, int my_x, int my_y)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void *
-# nci_piiii(int alpha, int beta, int gamma, int delta)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void * nci_piiii(int alpha, int beta, int gamma,
-# int delta)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void *
-# nci_pii(int fac1, int fac2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void * nci_pii(int fac1, int fac2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_v(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_v(void)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vv(void)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vv(void)>mpilers/pirc/src/pircompiler.c'
-
-# 6 function(s) lacking documentation:
-# compilers/pirc/src/pircompiler.c (missing)
-# PARROT_MALLOC
-# PARROT_CANNOT_RETURN_NULL
-# PARROT_WARN_UNUSED_RESULT
-# static allocated_mem_ptrs *
-# new_mem_ptrs_block(void)
-# Want:
-# =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)>
-#
-# compilers/pirc/src/pircompiler.c (missing)
-# void
-# init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table),
-#                unsigned size)
-# Want:
-# =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table,
-# unsigned size)>
-#
-
-}
-
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vVi(Opaque **outOpaque, int x)mpilers/pirc/src/pircompiler.c'
-
-# 6 function(s) lacking documentation:
-# compilers/pirc/src/pircompiler.c (missing)
-# PARROT_MALLOC
-# PARROT_CANNOT_RETURN_NULL
-# PARROT_WARN_UNUSED_RESULT
-# static allocated_mem_ptrs *
-# new_mem_ptrs_block(void)
-# Want:
-# =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)>
-#
-# compilers/pirc/src/pircompiler.c (missing)
-# void
-# init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table),
-#                unsigned size)
-# Want:
-# =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table,
-# unsigned size)>
-#
-
-}
-
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vVi(Opaque **outOpaque, int x)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vp(Opaque *inOpaque)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vp(Opaque *inOpaque)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT char *
-# nci_ttt(char *s1, char *s2)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT char * nci_ttt(char *s1, char *s2)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vfff(float l1, float l2, float l3)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vfff(float l1, float l2, float l3)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vV(const char **ptr)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vV(const char **ptr)>
-#
-# src/nci_test.c (missing)
-# PARROT_DYNEXT_EXPORT void
-# nci_vVVV(const char **ptr1, const char **ptr2, const char **ptr3)
-# Want:
-# =item C<PARROT_DYNEXT_EXPORT void nci_vVVV(const char **ptr1, const char **ptr2,
-# const char **ptr3)>
-#
-# src/nci_test.c (missing)
-# int
-# main(void)
-# Want:
-# =item C<int main(void)>
-
 'src/pbc_dump.c'
 
@@ -945 +575 @@
 # =item C<inline static long parrot_ppc_add(volatile long *val, long what)>
 
-
 }}}