Changes between Version 2 and Version 3 of BoilerplateOnlyDocs

Show
Ignore:
Timestamp:
06/30/10 01:13:12 (4 years ago)
Author:
mikehh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BoilerplateOnlyDocs

    v2 v3  
    55The following gives the C source file in single quotes, have the appropriate header (=item C<...>), but some lack documentation under the header. 
    66 
    7 Bear in mind we are dealing with POD and that it expects a maximum line length of 78. 
     7Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 
    88 
    9 as of r44163 the following C functions are have the headers but are lacking documentation: 
    10 {{{ 
    11 'compilers/imcc/instructions.c' 
    12 'compilers/imcc/optimizer.c' 
    13 'compilers/imcc/parser_util.c' 
    14 'compilers/imcc/pbc.c' 
    15 'compilers/imcc/pcc.c' 
    16 'compilers/imcc/reg_alloc.c' 
    17 'compilers/imcc/symreg.c' 
    18 'compilers/pirc/src/pircapi.c' 
    19 'config/gen/platform/ansi/dl.c' 
    20 'config/gen/platform/ansi/exec.c' 
    21 'config/gen/platform/ansi/time.c' 
    22 'config/gen/platform/darwin/memalign.c' 
    23 'config/gen/platform/generic/dl.c' 
    24 'config/gen/platform/generic/exec.c' 
    25 'config/gen/platform/generic/math.c' 
    26 'config/gen/platform/generic/memalign.c' 
    27 'config/gen/platform/generic/stat.c' 
    28 'config/gen/platform/generic/time.c' 
    29 'config/gen/platform/netbsd/math.c' 
    30 'config/gen/platform/openbsd/math.c' 
    31 'config/gen/platform/solaris/math.c' 
    32 'config/gen/platform/solaris/time.c' 
    33 'examples/compilers/japhc.c' 
    34 'src/string/charset/ascii.c' 
    35 'src/string/charset/binary.c' 
    36 'src/string/charset/iso-8859-1.c' 
    37 'src/string/charset/unicode.c' 
    38 'src/tsq.c' 
    39  
    40 }}} 
    41  
    42  
     9For this part of the test to pass some relevant documentation must be added after the header see [wiki:MissingCFunctionDocs] for the format.