Version 3 (modified by mikehh, 12 years ago) |
---|
Missing C Function Documentation
The following is extracted from the test t/codingstd/c_function_docs.t.
The following gives the C source file in single quotes, followed by the output for the test - prefixed by #
It gives the number of functions missing documentation in the source file, then the function(s) missing documentation, and what the test expects to be there (Want:).
Bear in mind we are dealing with POD and that it expects a maximum line length of 78.
as of r44163 the following C functions are missing documentation:
'config/gen/platform/generic/env.c' # 3 function(s) lacking documentation: # config/gen/platform/generic/env.c (missing) # void # Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value) # Want: # =item C<void Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value)> # # config/gen/platform/generic/env.c (missing) # void_c_function_doc # Parrot_unsetenv(PARROT_INTERP, STRING *str_name) # Want: # =item C<void Parrot_unsetenv(PARROT_INTERP, STRING *str_name)> # # config/gen/platform/generic/env.c (missing) # char * # Parrot_getenv(PARROT_INTERP, STRING *str_name) # Want: # =item C<char * Parrot_getenv(PARROT_INTERP, STRING *str_name)> # # 'config/gen/platform/generic/memexec.c' # 2 function(s) lacking documentation: # config/gen/platform/generic/memexec.c (missing) # void # mem_free_executable(void *p, size_t size) # Want: # =item C<void mem_free_executable(void *p, size_t size)> # # config/gen/platform/generic/memexec.c (missing) # void * # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) # Want: # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t # newsize)> # # 'config/gen/platform/openbsd/memexec.c' # 1 function(s) lacking documentation: # config/gen/platform/openbsd/memexec.c (missing) # void * # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) # Want: # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t # newsize)> # # 'examples/c/pbc_info.c' # 1 function(s) lacking documentation: # examples/c/pbc_info.c (missing) # static INTVAL # iter(PARROT_INTERP, PackFile_Segment *seg, void *user_data) # Want: # =item C<static INTVAL iter(PARROT_INTERP, PackFile_Segment *seg, void # *user_data)> # 'src/atomic/gcc_x86.c' # 2 function(s) lacking documentation: # src/atomic/gcc_x86.c (missing) # PARROT_EXPORT # PARROT_CANNOT_RETURN_NULL # void * # parrot_i386_cmpxchg(ARGMOD(void *volatile *ptr), ARGIN_NULLOK(void *expect), # ARGIN_NULLOK(void *update)) # Want: # =item C<void * parrot_i386_cmpxchg(void *volatile *ptr, void *expect, void # *update)> # # src/atomic/gcc_x86.c (missing) # PARROT_EXPORT # long # parrot_i386_xadd(ARGIN(volatile long *l), long amount) # Want: # =item C<long parrot_i386_xadd(volatile long *l, long amount)> # # 'include/parrot/atomic/gcc_pcc.h' # 2 function(s) lacking documentation: # include/parrot/atomic/gcc_pcc.h (missing) # inline static void *parrot_ppc_cmpset(void * volatile *ptr, # void *expect, void *update) # Want: # =item C<inline static void *parrot_ppc_cmpset(void * volatile *ptr, void # *expect, void *update)> # # include/parrot/atomic/gcc_pcc.h (missing) # inline static long parrot_ppc_add(volatile long *val, long what) # Want: # =item C<inline static long parrot_ppc_add(volatile long *val, long what)> # #