| 1 | '''Missing C Function Documentation''' |
| 2 | |
| 3 | The following is extracted from the test t/codingstd/c_function_docs.t. |
| 4 | |
| 5 | The following gives the C source file in single quotes, followed by the output for the test - prefixed by # |
| 6 | |
| 7 | 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:). |
| 8 | |
| 9 | Bear in mind we are dealing with POD and that it expects a maximum line length of 78. |
| 10 | |
| 11 | as of r43470 the following C functions are missing documentation: |
| 12 | {{{ |
| 13 | |
| 14 | 'examples/c/pbc_info.c' |
| 15 | |
| 16 | # 1 function(s) lacking documentation: |
| 17 | # examples/c/pbc_info.c (missing) |
| 18 | # static INTVAL |
| 19 | # iter(PARROT_INTERP, PackFile_Segment *seg, void *user_data) |
| 20 | # Want: |
| 21 | # =item C<static INTVAL iter(PARROT_INTERP, PackFile_Segment *seg, void |
| 22 | # *user_data)> |
| 23 | |
| 24 | 'src/atomic/gcc_x86.c' |
| 25 | |
| 26 | # 2 function(s) lacking documentation: |
| 27 | # src/atomic/gcc_x86.c (missing) |
| 28 | # PARROT_EXPORT |
| 29 | # PARROT_CANNOT_RETURN_NULL |
| 30 | # void * |
| 31 | # parrot_i386_cmpxchg(ARGMOD(void *volatile *ptr), ARGIN_NULLOK(void *expect), |
| 32 | # ARGIN_NULLOK(void *update)) |
| 33 | # Want: |
| 34 | # =item C<void * parrot_i386_cmpxchg(void *volatile *ptr, void *expect, void |
| 35 | # *update)> |
| 36 | # |
| 37 | # src/atomic/gcc_x86.c (missing) |
| 38 | # PARROT_EXPORT |
| 39 | # long |
| 40 | # parrot_i386_xadd(ARGIN(volatile long *l), long amount) |
| 41 | # Want: |
| 42 | # =item C<long parrot_i386_xadd(volatile long *l, long amount)> |
| 43 | 'compilers/pirc/src/pircompiler.c' |
| 44 | |
| 45 | # 6 function(s) lacking documentation: |
| 46 | # compilers/pirc/src/pircompiler.c (missing) |
| 47 | # PARROT_MALLOC |
| 48 | # PARROT_CANNOT_RETURN_NULL |
| 49 | # PARROT_WARN_UNUSED_RESULT |
| 50 | # static allocated_mem_ptrs * |
| 51 | # new_mem_ptrs_block(void) |
| 52 | # Want: |
| 53 | # =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)> |
| 54 | # |
| 55 | # compilers/pirc/src/pircompiler.c (missing) |
| 56 | # void |
| 57 | # init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table), |
| 58 | # unsigned size) |
| 59 | # Want: |
| 60 | # =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table, |
| 61 | # unsigned size)> |
| 62 | # |
| 63 | # compilers/pirc/src/pircompiler.c (missing) |
| 64 | # PARROT_CANNOT_RETURN_NULL |
| 65 | # PARROT_WARN_UNUSED_RESULT |
| 66 | # bucket * |
| 67 | # new_bucket(NOTNULL(lexer_state * const lexer)) |
| 68 | # Want: |
| 69 | # =item C<bucket * new_bucket(lexer_state * const lexer)> |
| 70 | # |
| 71 | # compilers/pirc/src/pircompiler.c (missing) |
| 72 | # PARROT_WARN_UNUSED_RESULT |
| 73 | # PARROT_CANNOT_RETURN_NULL |
| 74 | # char const * |
| 75 | # dupstr(NOTNULL(lexer_state * const lexer), NOTNULL(char * const source)) |
| 76 | # Want: |
| 77 | # =item C<char const * dupstr(lexer_state * const lexer, char * const source)> |
| 78 | # |
| 79 | # compilers/pirc/src/pircompiler.c (missing) |
| 80 | # void |
| 81 | # release_resources(NOTNULL(lexer_state *lexer)) |
| 82 | # Want: |
| 83 | # =item C<void release_resources(lexer_state *lexer)> |
| 84 | # |
| 85 | # compilers/pirc/src/pircompiler.c (missing) |
| 86 | # void |
| 87 | # pirwarning(lexer_state * const lexer, int lineno, char const * const message, ...) |
| 88 | # Want: |
| 89 | # =item C<void pirwarning(lexer_state * const lexer, int lineno, char const * |
| 90 | # const message, ...)> |
| 91 | |
| 92 | 'compilers/pirc/src/piremit.c' |
| 93 | |
| 94 | # 20 function(s) lacking documentation: |
| 95 | # compilers/pirc/src/piremit.c (missing) |
| 96 | # void |
| 97 | # print_key(lexer_state * const lexer, key * const k) |
| 98 | # Want: |
| 99 | # =item C<void print_key(lexer_state * const lexer, key * const k)> |
| 100 | # |
| 101 | # compilers/pirc/src/piremit.c (missing) |
| 102 | # void |
| 103 | # print_target(lexer_state * const lexer, target * const t) |
| 104 | # Want: |
| 105 | # =item C<void print_target(lexer_state * const lexer, target * const t)> |
| 106 | # |
| 107 | # compilers/pirc/src/piremit.c (missing) |
| 108 | # void |
| 109 | # print_constant(lexer_state * const lexer, constant * const c) |
| 110 | # Want: |
| 111 | # =item C<void print_constant(lexer_state * const lexer, constant * const c)> |
| 112 | # |
| 113 | # compilers/pirc/src/piremit.c (missing) |
| 114 | # void |
| 115 | # print_expr(lexer_state * const lexer, expression * const expr) |
| 116 | # Want: |
| 117 | # =item C<void print_expr(lexer_state * const lexer, expression * const expr)> |
| 118 | # |
| 119 | # compilers/pirc/src/piremit.c (missing) |
| 120 | # void |
| 121 | # print_expressions(lexer_state * const lexer, expression * const expr) |
| 122 | # Want: |
| 123 | # =item C<void print_expressions(lexer_state * const lexer, expression * const |
| 124 | # expr)> |
| 125 | # |
| 126 | # compilers/pirc/src/piremit.c (missing) |
| 127 | # void |
| 128 | # print_statement(lexer_state * const lexer, subroutine * const sub) |
| 129 | # Want: |
| 130 | # =item C<void print_statement(lexer_state * const lexer, subroutine * const sub)> |
| 131 | # |
| 132 | # compilers/pirc/src/piremit.c (missing) |
| 133 | # static void |
| 134 | # print_sub_flags(lexer_state * const lexer, subroutine * const subiter) |
| 135 | # Want: |
| 136 | # =item C<static void print_sub_flags(lexer_state * const lexer, subroutine * |
| 137 | # const subiter)> |
| 138 | # |
| 139 | # compilers/pirc/src/piremit.c (missing) |
| 140 | # void |
| 141 | # print_subs(struct lexer_state * const lexer) |
| 142 | # Want: |
| 143 | # =item C<void print_subs(struct lexer_state * const lexer)> |
| 144 | # |
| 145 | # compilers/pirc/src/piremit.c (missing) |
| 146 | # static void |
| 147 | # emit_pir_instruction(lexer_state * const lexer, instruction * const instr) |
| 148 | # Want: |
| 149 | # =item C<static void emit_pir_instruction(lexer_state * const lexer, instruction |
| 150 | # * const instr)> |
| 151 | # |
| 152 | # compilers/pirc/src/piremit.c (missing) |
| 153 | # static void |
| 154 | # emit_pir_statement(lexer_state * const lexer, subroutine * const sub) |
| 155 | # Want: |
| 156 | # =item C<static void emit_pir_statement(lexer_state * const lexer, subroutine * |
| 157 | # const sub)> |
| 158 | # |
| 159 | # compilers/pirc/src/piremit.c (missing) |
| 160 | # void |
| 161 | # emit_pir_subs(lexer_state * const lexer, char const * const outfile) |
| 162 | # Want: |
| 163 | # =item C<void emit_pir_subs(lexer_state * const lexer, char const * const |
| 164 | # outfile)> |
| 165 | # |
| 166 | # compilers/pirc/src/piremit.c (missing) |
| 167 | # static void |
| 168 | # emit_pbc_const_arg(lexer_state * const lexer, constant * const c) |
| 169 | # Want: |
| 170 | # =item C<static void emit_pbc_const_arg(lexer_state * const lexer, constant * |
| 171 | # const c)> |
| 172 | # |
| 173 | # compilers/pirc/src/piremit.c (missing) |
| 174 | # static void |
| 175 | # emit_pbc_label_arg(lexer_state * const lexer, label * const l) |
| 176 | # Want: |
| 177 | # =item C<static void emit_pbc_label_arg(lexer_state * const lexer, label * const |
| 178 | # l)> |
| 179 | # |
| 180 | # compilers/pirc/src/piremit.c (missing) |
| 181 | # static void |
| 182 | # emit_pbc_target_arg(lexer_state * const lexer, target * const t) |
| 183 | # Want: |
| 184 | # =item C<static void emit_pbc_target_arg(lexer_state * const lexer, target * |
| 185 | # const t)> |
| 186 | # |
| 187 | # compilers/pirc/src/piremit.c (missing) |
| 188 | # static void |
| 189 | # emit_pbc_expr(lexer_state * const lexer, expression * const operand) |
| 190 | # Want: |
| 191 | # =item C<static void emit_pbc_expr(lexer_state * const lexer, expression * const |
| 192 | # operand)> |
| 193 | # |
| 194 | # compilers/pirc/src/piremit.c (missing) |
| 195 | # static void |
| 196 | # optimize_instr(lexer_state * const lexer, instruction * const instr) |
| 197 | # Want: |
| 198 | # =item C<static void optimize_instr(lexer_state * const lexer, instruction * |
| 199 | # const instr)> |
| 200 | # |
| 201 | # compilers/pirc/src/piremit.c (missing) |
| 202 | # static void |
| 203 | # emit_pbc_instr(lexer_state * const lexer, instruction * const instr) |
| 204 | # Want: |
| 205 | # =item C<static void emit_pbc_instr(lexer_state * const lexer, instruction * |
| 206 | # const instr)> |
| 207 | # |
| 208 | # compilers/pirc/src/piremit.c (missing) |
| 209 | # static void |
| 210 | # emit_pbc_sub(lexer_state * const lexer, subroutine * const sub) |
| 211 | # Want: |
| 212 | # =item C<static void emit_pbc_sub(lexer_state * const lexer, subroutine * const |
| 213 | # sub)> |
| 214 | # |
| 215 | # compilers/pirc/src/piremit.c (missing) |
| 216 | # static void |
| 217 | # emit_pbc_annotations(lexer_state * const lexer) |
| 218 | # Want: |
| 219 | # =item C<static void emit_pbc_annotations(lexer_state * const lexer)> |
| 220 | # |
| 221 | # compilers/pirc/src/piremit.c (missing) |
| 222 | # void |
| 223 | # emit_pbc(lexer_state * const lexer, const char *outfile) |
| 224 | # Want: |
| 225 | # =item C<void emit_pbc(lexer_state * const lexer, const char *outfile)> |
| 226 | |
| 227 | 'compilers/pirc/src/pirmacro.c' |
| 228 | |
| 229 | # 4 function(s) lacking documentation: |
| 230 | # compilers/pirc/src/pirmacro.c (missing) |
| 231 | # PARROT_MALLOC |
| 232 | # PARROT_IGNORABLE_RESULT |
| 233 | # macro_def * |
| 234 | # new_macro(macro_table * const table, char const * const name, int lineno, int takes_args, |
| 235 | # unsigned initsize) |
| 236 | # Want: |
| 237 | # =item C<macro_def * new_macro(macro_table * const table, char const * const |
| 238 | # name, int lineno, int takes_args, unsigned initsize)> |
| 239 | # |
| 240 | # compilers/pirc/src/pirmacro.c (missing) |
| 241 | # void |
| 242 | # new_macro_const(macro_table * const table, char const * const name, char const * const value, |
| 243 | # int lineno) |
| 244 | # Want: |
| 245 | # =item C<void new_macro_const(macro_table * const table, char const * const name, |
| 246 | # char const * const value, int lineno)> |
| 247 | # |
| 248 | # compilers/pirc/src/pirmacro.c (missing) |
| 249 | # void |
| 250 | # store_macro_string(macro_def * const macro, char const * const str, ...) |
| 251 | # Want: |
| 252 | # =item C<void store_macro_string(macro_def * const macro, char const * const str, |
| 253 | # ...)> |
| 254 | # |
| 255 | # compilers/pirc/src/pirmacro.c (missing) |
| 256 | # void |
| 257 | # delete_macro_table(macro_table * table) |
| 258 | # Want: |
| 259 | # =item C<void delete_macro_table(macro_table * table)> |
| 260 | |
| 261 | 'compilers/pirc/src/pirpcc.c' |
| 262 | |
| 263 | # 17 function(s) lacking documentation: |
| 264 | # compilers/pirc/src/pirpcc.c (missing) |
| 265 | # static target * |
| 266 | # generate_unique_pir_reg(lexer_state * const lexer, pir_type type) |
| 267 | # Want: |
| 268 | # =item C<static target * generate_unique_pir_reg(lexer_state * const lexer, |
| 269 | # pir_type type)> |
| 270 | # |
| 271 | # compilers/pirc/src/pirpcc.c (missing) |
| 272 | # static int |
| 273 | # generate_signature_pmc(lexer_state * const lexer, unsigned size) |
| 274 | # Want: |
| 275 | # =item C<static int generate_signature_pmc(lexer_state * const lexer, unsigned |
| 276 | # size)> |
| 277 | # |
| 278 | # compilers/pirc/src/pirpcc.c (missing) |
| 279 | # void |
| 280 | # emit_sub_epilogue(lexer_state * const lexer) |
| 281 | # Want: |
| 282 | # =item C<void emit_sub_epilogue(lexer_state * const lexer)> |
| 283 | # |
| 284 | # compilers/pirc/src/pirpcc.c (missing) |
| 285 | # static void |
| 286 | # add_alias_operand(lexer_state * const lexer, PMC *array, int index, char const * const alias) |
| 287 | # Want: |
| 288 | # =item C<static void add_alias_operand(lexer_state * const lexer, PMC *array, int |
| 289 | # index, char const * const alias)> |
| 290 | # |
| 291 | # compilers/pirc/src/pirpcc.c (missing) |
| 292 | # static void |
| 293 | # targets_to_operands(lexer_state * const lexer, target * const targets, unsigned num_targets) |
| 294 | # Want: |
| 295 | # =item C<static void targets_to_operands(lexer_state * const lexer, target * |
| 296 | # const targets, unsigned num_targets)> |
| 297 | # |
| 298 | # compilers/pirc/src/pirpcc.c (missing) |
| 299 | # static void |
| 300 | # arguments_to_operands(lexer_state * const lexer, argument * const args, unsigned num_arguments) |
| 301 | # Want: |
| 302 | # =item C<static void arguments_to_operands(lexer_state * const lexer, argument * |
| 303 | # const args, unsigned num_arguments)> |
| 304 | # |
| 305 | # compilers/pirc/src/pirpcc.c (missing) |
| 306 | # void |
| 307 | # generate_parameters_instr(lexer_state * const lexer, unsigned num_parameters) |
| 308 | # Want: |
| 309 | # =item C<void generate_parameters_instr(lexer_state * const lexer, unsigned |
| 310 | # num_parameters)> |
| 311 | # |
| 312 | # compilers/pirc/src/pirpcc.c (missing) |
| 313 | # void |
| 314 | # generate_getresults_instr(lexer_state * const lexer, target * const targetlist) |
| 315 | # Want: |
| 316 | # =item C<void generate_getresults_instr(lexer_state * const lexer, target * const |
| 317 | # targetlist)> |
| 318 | # |
| 319 | # compilers/pirc/src/pirpcc.c (missing) |
| 320 | # static void |
| 321 | # save_global_reference(lexer_state * const lexer, instruction * const instr, |
| 322 | # char const * const label) |
| 323 | # Want: |
| 324 | # =item C<static void save_global_reference(lexer_state * const lexer, instruction |
| 325 | # * const instr, char const * const label)> |
| 326 | # |
| 327 | # compilers/pirc/src/pirpcc.c (missing) |
| 328 | # static void |
| 329 | # convert_pcc_call(lexer_state * const lexer, invocation * const inv) |
| 330 | # Want: |
| 331 | # =item C<static void convert_pcc_call(lexer_state * const lexer, invocation * |
| 332 | # const inv)> |
| 333 | # |
| 334 | # compilers/pirc/src/pirpcc.c (missing) |
| 335 | # static void |
| 336 | # convert_pcc_tailcall(lexer_state * const lexer, invocation * const inv) |
| 337 | # Want: |
| 338 | # =item C<static void convert_pcc_tailcall(lexer_state * const lexer, invocation * |
| 339 | # const inv)> |
| 340 | # |
| 341 | # compilers/pirc/src/pirpcc.c (missing) |
| 342 | # static void |
| 343 | # convert_pcc_return(lexer_state * const lexer, inok 41 - compilers/pirc/src/pirop.c |
| 344 | vocation * const inv) |
| 345 | # Want: |
| 346 | # =item C<static void convert_pcc_return(lexer_state * const lexer, invocation * |
| 347 | # const inv)> |
| 348 | # |
| 349 | # compilers/pirc/src/pirpcc.c (missing) |
| 350 | # static void |
| 351 | # convert_nci_call(lexer_state * const lexer, invocation * const inv) |
| 352 | # Want: |
| 353 | # =item C<static void convert_nci_call(lexer_state * const lexer, invocation * |
| 354 | # const inv)> |
| 355 | # |
| 356 | # compilers/pirc/src/pirpcc.c (missing) |
| 357 | # static void |
| 358 | # convert_pcc_yield(lexer_state * const lexer, invocation * const inv) |
| 359 | # Want: |
| 360 | # =item C<static void convert_pcc_yield(lexer_state * const lexer, invocation * |
| 361 | # const inv)> |
| 362 | # |
| 363 | # compilers/pirc/src/pirpcc.c (missing) |
| 364 | # static void |
| 365 | # convert_pcc_methodcall(lexer_state * const lexer, invocation * const inv) |
| 366 | # Want: |
| 367 | # =item C<static void convert_pcc_methodcall(lexer_state * const lexer, invocation |
| 368 | # * const inv)> |
| 369 | # |
| 370 | # compilers/pirc/src/pirpcc.c (missing) |
| 371 | # static void |
| 372 | # convert_pcc_methodtailcall(lexer_state * const lexer, invocation * const inv) |
| 373 | # Want: |
| 374 | # =item C<static void convert_pcc_methodtailcall(lexer_state * const lexer, |
| 375 | # invocation * const inv)> |
| 376 | # |
| 377 | # compilers/pirc/src/pirpcc.c (missing) |
| 378 | # void |
| 379 | # convert_inv_to_instr(lexer_state * const lexer, invocation * const inv) |
| 380 | # Want: |
| 381 | # =item C<void convert_inv_to_instr(lexer_state * const lexer, invocation * const |
| 382 | # inv)> |
| 383 | |
| 384 | 'compilers/pirc/src/pirregalloc.c' |
| 385 | |
| 386 | # 4 function(s) lacking documentation: |
| 387 | # compilers/pirc/src/pirregalloc.c (missing) |
| 388 | # void |
| 389 | # destroy_linear_scan_register_allocator(lsr_allocator *lsr) |
| 390 | # Want: |
| 391 | # =item C<void destroy_linear_scan_register_allocator(lsr_allocator *lsr)> |
| 392 | # |
| 393 | # compilers/pirc/src/pirregalloc.c (missing) |
| 394 | # PARROT_MALLOC |
| 395 | # PARROT_WARN_UNUSED_RESULT |
| 396 | # live_interval * |
| 397 | # new_live_interval(lsr_allocator * const lsr, unsigned firstuse_location, pir_type type) |
| 398 | # Want: |
| 399 | # =item C<live_interval * new_live_interval(lsr_allocator * const lsr, unsigned |
| 400 | # firstuse_location, pir_type type)> |
| 401 | # |
| 402 | # compilers/pirc/src/pirregalloc.c (missing) |
| 403 | # static void |
| 404 | # add_free_reg(lsr_allocator * const lsr, unsigned regno, pir_type type) |
| 405 | # Want: |
| 406 | # =item C<static void add_free_reg(lsr_allocator * const lsr, unsigned regno, |
| 407 | # pir_type type)> |
| 408 | # |
| 409 | # compilers/pirc/src/pirregalloc.c (missing) |
| 410 | # static void |
| 411 | # expire_old_intervals(lsr_allocator * const lsr, live_interval * const i, pir_type type) |
| 412 | # Want: |
| 413 | # =item C<static void expire_old_intervals(lsr_allocator * const lsr, |
| 414 | # live_interval * const i, pir_type type)> |
| 415 | |
| 416 | 'compilers/pirc/src/pirsymbol.c' |
| 417 | |
| 418 | # 7 function(s) lacking documentation: |
| 419 | # compilers/pirc/src/pirsymbol.c (missing) |
| 420 | # static int |
| 421 | # next_register(NOTNULL(lexer_state * const lexer), pir_type type) |
| 422 | # Want: |
| 423 | # =item C<static int next_register(lexer_state * const lexer, pir_type type)> |
| 424 | # |
| 425 | # compilers/pirc/src/pirsymbol.c (missing) |
| 426 | # PARROT_WARN_UNUSED_RESULT |
| 427 | # PARROT_CANNOT_RETURN_NULL |
| 428 | # bucket * |
| 429 | # get_bucket(NOTNULL(hashtable * const table), unsigned long hash) |
| 430 | # Want: |
| 431 | # =item C<bucket * get_bucket(hashtable * const table, unsigned long hash)> |
| 432 | # |
| 433 | # compilers/pirc/src/pirsymbol.c (missing) |
| 434 | # void |
| 435 | # declare_local(NOTNULL(lexer_state * const lexer), pir_type type, |
| 436 | # NOTNULL(symbol * const list)) |
| 437 | # Want: |
| 438 | # =item C<void declare_local(lexer_state * const lexer, pir_type type, symbol * |
| 439 | # const list)> |
| 440 | # |
| 441 | # compilers/pirc/src/pirsymbol.c (missing) |
| 442 | # void |
| 443 | # check_unused_symbols(NOTNULL(lexer_state * const lexer)) |
| 444 | # Want: |
| 445 | # =item C<void check_unused_symbols(lexer_state * const lexer)> |
| 446 | # |
| 447 | # compilers/pirc/src/pirsymbol.c (missing) |
| 448 | # static int |
| 449 | # use_register(NOTNULL(lexer_state * const lexer), pir_type type, int regno, int pasmregno) |
| 450 | # Want: |
| 451 | # =item C<static int use_register(lexer_state * const lexer, pir_type type, int |
| 452 | # regno, int pasmregno)> |
| 453 | # |
| 454 | # compilers/pirc/src/pirsymbol.c (missing) |
| 455 | # PARROT_WARN_UNUSED_RESULT |
| 456 | # PARROT_CANNOT_RETURN_NULL |
| 457 | # static local_label * |
| 458 | # new_local_label(NOTNULL(lexer_state * const lexer), NOTNULL(char const * const name), |
| 459 | # unsigned offset) |
| 460 | # Want: |
| 461 | # =item C<static local_label * new_local_label(lexer_state * const lexer, char |
| 462 | # const * const name, unsigned offset)> |
| 463 | # |
| 464 | # compilers/pirc/src/pirsymbol.c (missing) |
| 465 | # void |
| 466 | # store_local_label(NOTNULL(lexer_state * const lexer), NOTNULL(char const * const labelname), |
| 467 | # unsigned offset) |
| 468 | # Want: |
| 469 | # =item C<void store_local_label(lexer_state * const lexer, char const * const |
| 470 | # labelname, unsigned offset)> |
| 471 | |
| 472 | 'config/gen/platform/generic/env.c' |
| 473 | |
| 474 | # 3 function(s) lacking documentation: |
| 475 | # config/gen/platform/generic/env.c (missing) |
| 476 | # void |
| 477 | # Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value) |
| 478 | # Want: |
| 479 | # =item C<void Parrot_setenv(PARROT_INTERP, STRING *str_name, STRING *str_value)> |
| 480 | # |
| 481 | # config/gen/platform/generic/env.c (missing) |
| 482 | # void |
| 483 | # Parrot_unsetenv(PARROT_INTERP, STRING *str_name) |
| 484 | # Want: |
| 485 | # =item C<void Parrot_unsetenv(PARROT_INTERP, STRING *str_name)> |
| 486 | # |
| 487 | # config/gen/platform/generic/env.c (missing) |
| 488 | # char * |
| 489 | # Parrot_getenv(PARROT_INTERP, STRING *str_name) |
| 490 | # Want: |
| 491 | # =item C<char * Parrot_getenv(PARROT_INTERP, STRING *str_name)> |
| 492 | |
| 493 | |
| 494 | 'config/gen/platform/generic/memalign.c' |
| 495 | |
| 496 | # 3 function(s) lacking documentation: |
| 497 | # config/gen/platform/generic/memalign.c (boilerplate only) |
| 498 | # In: |
| 499 | # =item C<void * Parrot_memalign(size_t align, size_t size)> |
| 500 | # |
| 501 | # config/gen/platform/generic/memalign.c (boilerplate only) |
| 502 | # In: |
| 503 | # =item C<void * Parrot_memalign(size_t align, size_t size)> |
| 504 | # |
| 505 | # config/gen/platform/generic/memalign.c (boilerplate only) |
| 506 | # In: |
| 507 | # =item C<void Parrot_free_memalign(void *p)> |
| 508 | |
| 509 | 'config/gen/platform/generic/memexec.c' |
| 510 | |
| 511 | # 2 function(s) lacking documentation: |
| 512 | # config/gen/platform/generic/memexec.c (missing) |
| 513 | # void |
| 514 | # mem_free_executable(void *p, size_t size) |
| 515 | # Want: |
| 516 | # =item C<void mem_free_executable(void *p, size_t size)> |
| 517 | # |
| 518 | # config/gen/platform/generic/memexec.c (missing) |
| 519 | # void * |
| 520 | # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) |
| 521 | # Want: |
| 522 | # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t |
| 523 | # newsize)> |
| 524 | |
| 525 | 'config/gen/platform/openbsd/memexec.c' |
| 526 | |
| 527 | # 1 function(s) lacking documentation: |
| 528 | # config/gen/platform/openbsd/memexec.c (missing) |
| 529 | # void * |
| 530 | # mem_realloc_executable(void* oldp, size_t oldsize, size_t newsize) |
| 531 | # Want: |
| 532 | # =item C<void * mem_realloc_executable(void* oldp, size_t oldsize, size_t |
| 533 | # newsize)> |
| 534 | |
| 535 | 'src/nci_test.c' |
| 536 | |
| 537 | # 46 function(s) lacking documentation: |
| 538 | # src/nci_test.c (missing) |
| 539 | # PARROT_DYNEXT_EXPORT char |
| 540 | # nci_c(void) |
| 541 | # Want: |
| 542 | # =item C<PARROT_DYNEXT_EXPORT char nci_c(void)> |
| 543 | # |
| 544 | # src/nci_test.c (missing) |
| 545 | # PARROT_DYNEXT_EXPORT char |
| 546 | # nci_csc(short l1, char l2) |
| 547 | # Want: |
| 548 | # =item C<PARROT_DYNEXT_EXPORT char nci_csc(short l1, char l2)> |
| 549 | # |
| 550 | # src/nci_test.c (missing) |
| 551 | # PARROT_DYNEXT_EXPORT double |
| 552 | # nci_d(void) |
| 553 | # Want: |
| 554 | # =item C<PARROT_DYNEXT_EXPORT double nci_d(void)> |
| 555 | # |
| 556 | # src/nci_test.c (missing) |
| 557 | # PARROT_DYNEXT_EXPORT double |
| 558 | # nci_dd(double d) |
| 559 | # Want: |
| 560 | # =item C<PARROT_DYNEXT_EXPORT double nci_dd(double d)> |
| 561 | # |
| 562 | # src/nci_test.c (missing) |
| 563 | # PARROT_DYNEXT_EXPORT float |
| 564 | # nci_f(void) |
| 565 | # Want: |
| 566 | # =item C<PARROT_DYNEXT_EXPORT float nci_f(void)> |
| 567 | # |
| 568 | # src/nci_test.c (missing) |
| 569 | # PARROT_DYNEXT_EXPORT float |
| 570 | # nci_fff(float l1, float l2) |
| 571 | # Want: |
| 572 | # =item C<PARROT_DYNEXT_EXPORT float nci_fff(float l1, float l2)> |
| 573 | # |
| 574 | # src/nci_test.c (missing) |
| 575 | # PARROT_DYNEXT_EXPORT int |
| 576 | # nci_i(void) |
| 577 | # Want: |
| 578 | # =item C<PARROT_DYNEXT_EXPORT int nci_i(void)> |
| 579 | # |
| 580 | # src/nci_test.c (missing) |
| 581 | # PARROT_DYNEXT_EXPORT int |
| 582 | # nci_isc(short l1, char l2) |
| 583 | # Want: |
| 584 | # =item C<PARROT_DYNEXT_EXPORT int nci_isc(short l1, char l2)> |
| 585 | # |
| 586 | # src/nci_test.c (missing) |
| 587 | # PARROT_DYNEXT_EXPORT int |
| 588 | # nci_ip(void *p) |
| 589 | # Want: |
| 590 | # =item C<PARROT_DYNEXT_EXPORT int nci_ip(void *p)> |
| 591 | # |
| 592 | # src/nci_test.c (missing) |
| 593 | # PARROT_DYNEXT_EXPORT int |
| 594 | # nci_it(void *p) |
| 595 | # Want: |
| 596 | # =item C<PARROT_DYNEXT_EXPORT int nci_it(void *p)> |
| 597 | # |
| 598 | # src/nci_test.c (missing) |
| 599 | # PARROT_DYNEXT_EXPORT long |
| 600 | # nci_l(void) |
| 601 | # Want: |
| 602 | # =item C<PARROT_DYNEXT_EXPORT long nci_l(void)> |
| 603 | # |
| 604 | # src/nci_test.c (missing) |
| 605 | # PARROT_DYNEXT_EXPORT int * |
| 606 | # nci_p(void) |
| 607 | # Want: |
| 608 | # =item C<PARROT_DYNEXT_EXPORT int * nci_p(void)> |
| 609 | # |
| 610 | # src/nci_test.c (missing) |
| 611 | # PARROT_DYNEXT_EXPORT char * |
| 612 | # nci_t(void) |
| 613 | # Want: |
| 614 | # =item C<PARROT_DYNEXT_EXPORT char * nci_t(void)> |
| 615 | # |
| 616 | # src/nci_test.c (missing) |
| 617 | # PARROT_DYNEXT_EXPORT char * |
| 618 | # nci_tb(void *p) |
| 619 | # Want: |
| 620 | # =item C<PARROT_DYNEXT_EXPORT char * nci_tb(void *p)> |
| 621 | # |
| 622 | # src/nci_test.c (missing) |
| 623 | # PARROT_DYNEXT_EXPORT char * |
| 624 | # nci_tt(void *p) |
| 625 | # Want: |
| 626 | # =item C<PARROT_DYNEXT_EXPORT char * nci_tt(void *p)> |
| 627 | # |
| 628 | # src/nci_test.c (missing) |
| 629 | # PARROT_DYNEXT_EXPORT char * |
| 630 | # nci_tB(void **p) |
| 631 | # Want: |
| 632 | # =item C<PARROT_DYNEXT_EXPORT char * nci_tB(void **p)> |
| 633 | # |
| 634 | # src/nci_test.c (missing) |
| 635 | # PARROT_DYNEXT_EXPORT void * |
| 636 | # nci_pp(void *p) |
| 637 | # Want: |
| 638 | # =item C<PARROT_DYNEXT_EXPORT void * nci_pp(void *p)> |
| 639 | # |
| 640 | # src/nci_test.c (missing) |
| 641 | # PARROT_DYNEXT_EXPORT int |
| 642 | # nci_iiii(int i1, int i2, int i3) |
| 643 | # Want: |
| 644 | # =item C<PARROT_DYNEXT_EXPORT int nci_iiii(int i1, int i2, int i3)> |
| 645 | # |
| 646 | # src/nci_test.c (missing) |
| 647 | # PARROT_DYNEXT_EXPORT int |
| 648 | # nci_i4i(long * l, int i) |
| 649 | # Want: |
| 650 | # =item C<PARROT_DYNEXT_EXPORT int nci_i4i(long * l, int i)> |
| 651 | # |
| 652 | # src/nci_test.c (missing) |
| 653 | # PARROT_DYNEXT_EXPORT int |
| 654 | # nci_ii3(int a, int *bp) |
| 655 | # Want: |
| 656 | # =item C<PARROT_DYNEXT_EXPORT int nci_ii3(int a, int *bp)> |
| 657 | # |
| 658 | # src/nci_test.c (missing) |
| 659 | # PARROT_DYNEXT_EXPORT int |
| 660 | # call_back(const char *str) |
| 661 | # Want: |
| 662 | # =item C<PARROT_DYNEXT_EXPORT int call_back(const char *str)> |
| 663 | # |
| 664 | # src/nci_test.c (missing) |
| 665 | # PARROT_DYNEXT_EXPORT void * |
| 666 | # nci_pi(int test) |
| 667 | # Want: |
| 668 | # =item C<PARROT_DYNEXT_EXPORT void * nci_pi(int test)> |
| 669 | # |
| 670 | # src/nci_test.c (missing) |
| 671 | # PARROT_DYNEXT_EXPORT short |
| 672 | # nci_s(void) |
| 673 | # Want: |
| 674 | # =item C<PARROT_DYNEXT_EXPORT short nci_s(void)> |
| 675 | # |
| 676 | # src/nci_test.c (missing) |
| 677 | # PARROT_DYNEXT_EXPORT short |
| 678 | # nci_ssc(short l1, char l2) |
| 679 | # Want: |
| 680 | # =item C<PARROT_DYNEXT_EXPORT short nci_ssc(short l1, char l2)> |
| 681 | # |
| 682 | # src/nci_test.c (missing) |
| 683 | # PARROT_DYNEXT_EXPORT void |
| 684 | # nci_vP(void *pmc) |
| 685 | # Want: |
| 686 | # =item C<PARROT_DYNEXT_EXPORT void nci_vP(void *pmc)> |
| 687 | # |
| 688 | # src/nci_test.c (missing) |
| 689 | # PARROT_DYNEXT_EXPORT void |
| 690 | # nci_cb_C1(cb_C1_func cb, void* user_data) |
| 691 | # Want: |
| 692 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_C1(cb_C1_func cb, void* user_data)> |
| 693 | # |
| 694 | # src/nci_test.c (missing) |
| 695 | # PARROT_DYNEXT_EXPORT void |
| 696 | # nci_cb_C2(cb_C2_func cb, void* user_data) |
| 697 | # Want: |
| 698 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_C2(cb_C2_func cb, void* user_data)> |
| 699 | # |
| 700 | # src/nci_test.c (missing) |
| 701 | # PARROT_DYNEXT_EXPORT void |
| 702 | # nci_cb_C3(cb_C3_func cb, void* user_data) |
| 703 | # Want: |
| 704 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_C3(cb_C3_func cb, void* user_data)> |
| 705 | # |
| 706 | # src/nci_test.c (missing) |
| 707 | # PARROT_DYNEXT_EXPORT void |
| 708 | # nci_cb_D1(cb_D1_func cb, void* user_data) |
| 709 | # Want: |
| 710 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_D1(cb_D1_func cb, void* user_data)> |
| 711 | # |
| 712 | # src/nci_test.c (missing) |
| 713 | # PARROT_DYNEXT_EXPORT void |
| 714 | # nci_cb_D2(cb_D2_func cb, void* user_data) |
| 715 | # Want: |
| 716 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_D2(cb_D2_func cb, void* user_data)> |
| 717 | # |
| 718 | # src/nci_test.c (missing)mpilers/pirc/src/pircompiler.c' |
| 719 | mpilers/pirc/src/pircompiler.c' |
| 720 | |
| 721 | # 6 function(s) lacking documentation: |
| 722 | # compilers/pirc/src/pircompiler.c (missing) |
| 723 | # PARROT_MALLOC |
| 724 | # PARROT_CANNOT_RETURN_NULL |
| 725 | # PARROT_WARN_UNUSED_RESULT |
| 726 | # static allocated_mem_ptrs * |
| 727 | # new_mem_ptrs_block(void) |
| 728 | # Want: |
| 729 | # =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)> |
| 730 | # |
| 731 | # compilers/pirc/src/pircompiler.c (missing) |
| 732 | # void |
| 733 | # init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table), |
| 734 | # unsigned size) |
| 735 | # Want: |
| 736 | # =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table, |
| 737 | # unsigned size)> |
| 738 | # |
| 739 | |
| 740 | } |
| 741 | |
| 742 | # 6 function(s) lacking documentation: |
| 743 | # compilers/pirc/src/pircompiler.c (missing) |
| 744 | # PARROT_MALLOC |
| 745 | # PARROT_CANNOT_RETURN_NULL |
| 746 | # PARROT_WARN_UNUSED_RESULT |
| 747 | # static allocated_mem_ptrs * |
| 748 | # new_mem_ptrs_block(void) |
| 749 | # Want: |
| 750 | # =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)> |
| 751 | # |
| 752 | # compilers/pirc/src/pircompiler.c (missing) |
| 753 | # void |
| 754 | # init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table), |
| 755 | # unsigned size) |
| 756 | # Want: |
| 757 | # =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table, |
| 758 | # unsigned size)> |
| 759 | # |
| 760 | |
| 761 | } |
| 762 | |
| 763 | # PARROT_DYNEXT_EXPORT void |
| 764 | # nci_cb_D3(cb_D3_func cb, void* user_data) |
| 765 | # Want: |
| 766 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_D3(cb_D3_func cb, void* user_data)> |
| 767 | # |
| 768 | # src/nci_test.c (missing) |
| 769 | # PARROT_DYNEXT_EXPORT void |
| 770 | # nci_cb_D4(cb_D4_func times_ten, void* user_data) |
| 771 | # Want: |
| 772 | # =item C<PARROT_DYNEXT_EXPORT void nci_cb_D4(cb_D4_func times_ten, void* |
| 773 | # user_data)> |
| 774 | # |
| 775 | # src/nci_test.c (missing) |
| 776 | # PARROT_DYNEXT_EXPORT void |
| 777 | # nci_pip(int count, Rect_Like *rects) |
| 778 | # Want: |
| 779 | # =item C<PARROT_DYNEXT_EXPORT void nci_pip(int count, Rect_Like *rects)> |
| 780 | # |
| 781 | # src/nci_test.c (missing) |
| 782 | # PARROT_DYNEXT_EXPORT int |
| 783 | # nci_i33(int *double_me, int *triple_me) |
| 784 | # Want: |
| 785 | # =item C<PARROT_DYNEXT_EXPORT int nci_i33(int *double_me, int *triple_me)> |
| 786 | # |
| 787 | # src/nci_test.c (missing) |
| 788 | # PARROT_DYNEXT_EXPORT void |
| 789 | # nci_vpii(Outer *my_data, int my_x, int my_y) |
| 790 | # Want: |
| 791 | # =item C<PARROT_DYNEXT_EXPORT void nci_vpii(Outer *my_data, int my_x, int my_y)> |
| 792 | # |
| 793 | # src/nci_test.c (missing) |
| 794 | # PARROT_DYNEXT_EXPORT void * |
| 795 | # nci_piiii(int alpha, int beta, int gamma, int delta) |
| 796 | # Want: |
| 797 | # =item C<PARROT_DYNEXT_EXPORT void * nci_piiii(int alpha, int beta, int gamma, |
| 798 | # int delta)> |
| 799 | # |
| 800 | # src/nci_test.c (missing) |
| 801 | # PARROT_DYNEXT_EXPORT void * |
| 802 | # nci_pii(int fac1, int fac2) |
| 803 | # Want: |
| 804 | # =item C<PARROT_DYNEXT_EXPORT void * nci_pii(int fac1, int fac2)> |
| 805 | # |
| 806 | # src/nci_test.c (missing) |
| 807 | # PARROT_DYNEXT_EXPORT void |
| 808 | # nci_v(void) |
| 809 | # Want: |
| 810 | # =item C<PARROT_DYNEXT_EXPORT void nci_v(void)> |
| 811 | # |
| 812 | # src/nci_test.c (missing) |
| 813 | # PARROT_DYNEXT_EXPORT void |
| 814 | # nci_vv(void) |
| 815 | # Want: |
| 816 | # =item C<PARROT_DYNEXT_EXPORT void nci_vv(void)>mpilers/pirc/src/pircompiler.c' |
| 817 | |
| 818 | # 6 function(s) lacking documentation: |
| 819 | # compilers/pirc/src/pircompiler.c (missing) |
| 820 | # PARROT_MALLOC |
| 821 | # PARROT_CANNOT_RETURN_NULL |
| 822 | # PARROT_WARN_UNUSED_RESULT |
| 823 | # static allocated_mem_ptrs * |
| 824 | # new_mem_ptrs_block(void) |
| 825 | # Want: |
| 826 | # =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)> |
| 827 | # |
| 828 | # compilers/pirc/src/pircompiler.c (missing) |
| 829 | # void |
| 830 | # init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table), |
| 831 | # unsigned size) |
| 832 | # Want: |
| 833 | # =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table, |
| 834 | # unsigned size)> |
| 835 | # |
| 836 | |
| 837 | } |
| 838 | |
| 839 | # |
| 840 | # src/nci_test.c (missing) |
| 841 | # PARROT_DYNEXT_EXPORT void |
| 842 | # nci_vVi(Opaque **outOpaque, int x)mpilers/pirc/src/pircompiler.c' |
| 843 | |
| 844 | # 6 function(s) lacking documentation: |
| 845 | # compilers/pirc/src/pircompiler.c (missing) |
| 846 | # PARROT_MALLOC |
| 847 | # PARROT_CANNOT_RETURN_NULL |
| 848 | # PARROT_WARN_UNUSED_RESULT |
| 849 | # static allocated_mem_ptrs * |
| 850 | # new_mem_ptrs_block(void) |
| 851 | # Want: |
| 852 | # =item C<static allocated_mem_ptrs * new_mem_ptrs_block(void)> |
| 853 | # |
| 854 | # compilers/pirc/src/pircompiler.c (missing) |
| 855 | # void |
| 856 | # init_hashtable(NOTNULL(lexer_state * const lexer), NOTNULL(hashtable * const table), |
| 857 | # unsigned size) |
| 858 | # Want: |
| 859 | # =item C<void init_hashtable(lexer_state * const lexer, hashtable * const table, |
| 860 | # unsigned size)> |
| 861 | # |
| 862 | |
| 863 | } |
| 864 | |
| 865 | # Want: |
| 866 | # =item C<PARROT_DYNEXT_EXPORT void nci_vVi(Opaque **outOpaque, int x)> |
| 867 | # |
| 868 | # src/nci_test.c (missing) |
| 869 | # PARROT_DYNEXT_EXPORT void |
| 870 | # nci_vp(Opaque *inOpaque) |
| 871 | # Want: |
| 872 | # =item C<PARROT_DYNEXT_EXPORT void nci_vp(Opaque *inOpaque)> |
| 873 | # |
| 874 | # src/nci_test.c (missing) |
| 875 | # PARROT_DYNEXT_EXPORT char * |
| 876 | # nci_ttt(char *s1, char *s2) |
| 877 | # Want: |
| 878 | # =item C<PARROT_DYNEXT_EXPORT char * nci_ttt(char *s1, char *s2)> |
| 879 | # |
| 880 | # src/nci_test.c (missing) |
| 881 | # PARROT_DYNEXT_EXPORT void |
| 882 | # nci_vfff(float l1, float l2, float l3) |
| 883 | # Want: |
| 884 | # =item C<PARROT_DYNEXT_EXPORT void nci_vfff(float l1, float l2, float l3)> |
| 885 | # |
| 886 | # src/nci_test.c (missing) |
| 887 | # PARROT_DYNEXT_EXPORT void |
| 888 | # nci_vV(const char **ptr) |
| 889 | # Want: |
| 890 | # =item C<PARROT_DYNEXT_EXPORT void nci_vV(const char **ptr)> |
| 891 | # |
| 892 | # src/nci_test.c (missing) |
| 893 | # PARROT_DYNEXT_EXPORT void |
| 894 | # nci_vVVV(const char **ptr1, const char **ptr2, const char **ptr3) |
| 895 | # Want: |
| 896 | # =item C<PARROT_DYNEXT_EXPORT void nci_vVVV(const char **ptr1, const char **ptr2, |
| 897 | # const char **ptr3)> |
| 898 | # |
| 899 | # src/nci_test.c (missing) |
| 900 | # int |
| 901 | # main(void) |
| 902 | # Want: |
| 903 | # =item C<int main(void)> |
| 904 | |
| 905 | 'src/pbc_dump.c' |
| 906 | |
| 907 | # 4 function(s) lacking documentation: |
| 908 | # src/pbc_dump.c (missing) |
| 909 | # static void |
| 910 | # const_dump(PARROT_INTERP, const PackFile_Segment *segp) |
| 911 | # Want: |
| 912 | # =item C<static void const_dump(PARROT_INTERP, const PackFile_Segment *segp)> |
| 913 | # |
| 914 | # src/pbc_dump.c (missing) |
| 915 | # static void |
| 916 | # fixup_dump(PARROT_INTERP, const PackFile_Segment *segp) |
| 917 | # Want: |
| 918 | # =item C<static void fixup_dump(PARROT_INTERP, const PackFile_Segment *segp)> |
| 919 | # |
| 920 | # src/pbc_dump.c (missing) |
| 921 | # static void |
| 922 | # disas_dump(PARROT_INTERP, const PackFile_Segment *self) |
| 923 | # Want: |
| 924 | # =item C<static void disas_dump(PARROT_INTERP, const PackFile_Segment *self)> |
| 925 | # |
| 926 | # src/pbc_dump.c (missing) |
| 927 | # static void |
| 928 | # PackFile_header_dump(PARROT_INTERP, PackFile *pf) |
| 929 | # Want: |
| 930 | # =item C<static void PackFile_header_dump(PARROT_INTERP, PackFile *pf)> |
| 931 | |
| 932 | 'include/parrot/atomic/gcc_pcc.h' |
| 933 | |
| 934 | # 2 function(s) lacking documentation: |
| 935 | # include/parrot/atomic/gcc_pcc.h (missing) |
| 936 | # inline static void *parrot_ppc_cmpset(void * volatile *ptr, |
| 937 | # void *expect, void *update) |
| 938 | # Want: |
| 939 | # =item C<inline static void *parrot_ppc_cmpset(void * volatile *ptr, void |
| 940 | # *expect, void *update)> |
| 941 | # |
| 942 | # include/parrot/atomic/gcc_pcc.h (missing) |
| 943 | # inline static long parrot_ppc_add(volatile long *val, long what) |
| 944 | # Want: |
| 945 | # =item C<inline static long parrot_ppc_add(volatile long *val, long what)> |
| 946 | |
| 947 | |
| 948 | }}} |