Changes between Version 3 and Version 4 of MissingCFunctionDocs

Show
Ignore:
Timestamp:
02/19/10 12:30:51 (12 years ago)
Author:
mikehh
Comment:

bring up to date at r44170

Legend:

Unmodified
Added
Removed
Modified

  • MissingCFunctionDocs

    v3 v4  
    99Bear in mind we are dealing with POD and that it expects a maximum line length of 78. 
    1010 
    11 as of r44163 the following C functions are missing documentation: 
     11as of r44170 the following C functions are missing documentation: 
    1212{{{ 
    13 'config/gen/platform/generic/env.c' 
    14  
    15 # 3 function(s) lacking documentation: 
    16 # config/gen/platform/generic/env.c (missing) 
    17 # void 
    18 # Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value) 
    19 # Want: 
    20 # =item C<void Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value)> 
    21 # 
    22 # config/gen/platform/generic/env.c (missing) 
    23 # void_c_function_doc 
    24 # Parrot_unsetenv(PARROT_INTERP, STRING *str_name) 
    25 # Want: 
    26 # =item C<void Parrot_unsetenv(PARROT_INTERP, STRING *str_name)> 
    27 # 
    28 # config/gen/platform/generic/env.c (missing) 
    29 # char * 
    30 # Parrot_getenv(PARROT_INTERP, STRING *str_name) 
    31 # Want: 
    32 # =item C<char * Parrot_getenv(PARROT_INTERP, STRING *str_name)> 
    33 # 
    34 # 
    35  
    36 'config/gen/platform/generic/memexec.c' 
    37  
    38 # 2 function(s) lacking documentation: 
    39 # config/gen/platform/generic/memexec.c (missing) 
    40 # void 
    41 # mem_free_executable(void *p, size_t size) 
    42 # Want: 
    43 # =item C<void mem_free_executable(void *p, size_t size)> 
    44 # 
    45 # config/gen/platform/generic/memexec.c (missing) 
    46 # void * 
    47 # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) 
    48 # Want: 
    49 # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t 
    50 # newsize)> 
    51 # 
    52 # 
    53  
    54 'config/gen/platform/openbsd/memexec.c' 
    55  
    56 # 1 function(s) lacking documentation: 
    57 # config/gen/platform/openbsd/memexec.c (missing) 
    58 # void * 
    59 # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) 
    60 # Want: 
    61 # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t 
    62 # newsize)> 
    63 # 
    64 # 
    65  
    66 'examples/c/pbc_info.c' 
    67  
    68 # 1 function(s) lacking documentation: 
    69 # examples/c/pbc_info.c (missing) 
    70 # static INTVAL 
    71 # iter(PARROT_INTERP, PackFile_Segment *seg, void *user_data) 
    72 # Want: 
    73 # =item C<static INTVAL iter(PARROT_INTERP, PackFile_Segment *seg, void 
    74 # *user_data)> 
    75 # 
    76  
    77 'src/atomic/gcc_x86.c' 
    78  
    79 # 2 function(s) lacking documentation: 
    80 # src/atomic/gcc_x86.c (missing) 
    81 # PARROT_EXPORT 
    82 # PARROT_CANNOT_RETURN_NULL 
    83 # void * 
    84 # parrot_i386_cmpxchg(ARGMOD(void *volatile *ptr), ARGIN_NULLOK(void *expect), 
    85 #                                         ARGIN_NULLOK(void *update)) 
    86 # Want: 
    87 # =item C<void * parrot_i386_cmpxchg(void *volatile *ptr, void *expect, void 
    88 # *update)> 
    89 # 
    90 # src/atomic/gcc_x86.c (missing) 
    91 # PARROT_EXPORT 
    92 # long 
    93 # parrot_i386_xadd(ARGIN(volatile long *l), long amount) 
    94 # Want: 
    95 # =item C<long parrot_i386_xadd(volatile long *l, long amount)> 
    96 # 
    97 # 
    98  
    99 'include/parrot/atomic/gcc_pcc.h' 
    100  
    101 # 2 function(s) lacking documentation: 
    102 # include/parrot/atomic/gcc_pcc.h (missing) 
    103 # inline static void *parrot_ppc_cmpset(void * volatile *ptr, 
    104 #                                       void *expect, void *update) 
    105 # Want: 
    106 # =item C<inline static void *parrot_ppc_cmpset(void * volatile *ptr, void 
    107 # *expect, void *update)> 
    108 # 
    109 # include/parrot/atomic/gcc_pcc.h (missing) 
    110 # inline static long parrot_ppc_add(volatile long *val, long what) 
    111 # Want: 
    112 # =item C<inline static long parrot_ppc_add(volatile long *val, long what)> 
    113 # 
    114 # 
    115  
     13All current functions have at least (boilerplate only) or valid documentation 
    11614}}}