Changes between Version 5 and Version 6 of MissingCFunctionDocs
- Timestamp:
- 06/30/10 15:20:34 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
MissingCFunctionDocs
v5 v6 15 15 }}} 16 16 17 Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 17 It 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]). 18 18 19 The documentation requiresthe following format in a C function:19 The documentation is expected to have something similar to the following format in a C function: 20 20 21 21 {{{ … … 26 26 =item C<function name and parameters wrapped at line 80> 27 27 28 some documentation ( againwrapped at line 80)28 some documentation (preferably, but not necessarily, wrapped at line 80) 29 29 30 30 =back … … 39 39 40 40 The =over 4 is not required if a previous =over 4 exists without a =back which needs to be in the last entry. 41 42 A 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 54 Documentation for function 1 and function 2 ... 55 ... 56 57 =back 58 59 =cut 60 61 */ 62 63 function 1 here 64 ... 65 }}} 66