Changes between Version 4 and Version 5 of MissingCFunctionDocs

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

--

Legend:

Unmodified
Added
Removed
Modified
  • MissingCFunctionDocs

    v4 v5  
    33The following is extracted from the test t/codingstd/c_function_docs.t. 
    44 
    5 The following gives the C source file in single quotes, followed by the output for the test - prefixed by # 
     5If the test fails it will give the C source file in single quotes, followed by the output for the test - prefixed by # 
    66 
    77It 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:). 
    88 
    9 Bear in mind we are dealing with POD and that it expects a maximum line length of 78. 
     9The want: part gives what the documentation header is expects. 
    1010 
    11 as of r44170 the following C functions are missing documentation: 
     11of the form: 
    1212{{{ 
    13 All current functions have at least (boilerplate only) or valid documentation 
     13# =item C<function_name(parameters) 
     14# it may be wrapped onto a second line if it exceeds 80 characters 
    1415}}} 
     16 
     17Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 
     18 
     19The documentation requires the following format in a C function: 
     20 
     21{{{ 
     22/* 
     23 
     24=over 4 
     25 
     26=item C<function name and parameters wrapped at line 80> 
     27 
     28some documentation (again wrapped at line 80) 
     29 
     30=back 
     31 
     32=cut 
     33 
     34*/ 
     35 
     36function header here 
     37 
     38}}} 
     39 
     40The =over 4 is not required if a previous =over 4 exists without a =back which needs to be in the last entry.