Changes between Version 5 and Version 6 of MissingCFunctionDocs

Show
Ignore:
Timestamp:
06/30/10 15:20:34 (4 years ago)
Author:
mikehh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MissingCFunctionDocs

    v5 v6  
    1515}}} 
    1616 
    17 Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 
     17It should be noted that lib/Parrot/Headerizer.pm which is used by the t/codingstd/c_function_docs.t to extract and test C function Docs imposes a line length of 80 characters on the =item header in the documentation. If the documentation does not conform to this it will fail the test. The =item header must be less than 80 characters or wrap at 80 characters.  (Cases where the =item header wraps before 80 characters [i.e. if a word in the header which would be allowed up to 80 characters is on the next line - the test will fail at present]).  
    1818 
    19 The documentation requires the following format in a C function: 
     19The documentation is expected to have something similar to the following format in a C function: 
    2020 
    2121{{{ 
     
    2626=item C<function name and parameters wrapped at line 80> 
    2727 
    28 some documentation (again wrapped at line 80) 
     28some documentation (preferably, but not necessarily, wrapped at line 80) 
    2929 
    3030=back 
     
    3939 
    4040The =over 4 is not required if a previous =over 4 exists without a =back which needs to be in the last entry. 
     41 
     42A series of related functions may be grouped together.  For example: 
     43{{{ 
     44/* 
     45 
     46=over 4 
     47 
     48=item C<function 1 header> 
     49 
     50=item C<function 2 header> 
     51 
     52... 
     53 
     54Documentation for function 1 and function 2 ... 
     55... 
     56 
     57=back 
     58 
     59=cut 
     60 
     61*/ 
     62 
     63function 1 here 
     64... 
     65}}} 
     66