Changes between Version 3 and Version 4 of BoilerplateOnlyDocs
- 06/30/10 15:30:34 (3 years ago)
v3 v4 5 5 The following gives the C source file in single quotes, have the appropriate header (=item C<...>), but some lack documentation under the header. 6 6 7 Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 7 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. 8 9 The added documentation should be (preferably, but not necessarily) wrapped at line 80. 10 8 11 9 12 For this part of the test to pass some relevant documentation must be added after the header see [wiki:MissingCFunctionDocs] for the format.