Changes between Version 6 and Version 7 of CFunctionDocs
- Timestamp:
- 06/30/10 00:47:43 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CFunctionDocs
v6 v7 9 9 Secondly, it checks that there is content in the documentation, if it does not find content, i.e. only the header (=item C<...>) exists. It reports - (boilerplate only). 10 10 11 As of r43470 (now at r44170) I have compiled a report on the current functions missing [wiki:MissingCFunctionDocs] documentation and of those lacking (boilerplate only) [wiki:BoilerplateOnlyDocs] documentation.12 11 13 Bear in mind we are dealing with POD and that it expects a maximum line length of 78. 12 As at r47918 there are now no remaining functions in the repository that do not have the required documentation. 13 14 Previously I had compiled a report on the current functions missing [wiki:MissingCFunctionDocs] documentation and of those lacking (boilerplate only) [wiki:BoilerplateOnlyDocs] documentation. 15 16 For the moment these links will remain as they will document how to correct the documentation if the test fails at any stage in the future. 17 18 19 Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 20 14 21 15 22 If the documentation is corrected (patched) the test t/codingstd/c_function_docs.t has a TODO list for the failures (in the DATA section at the end) and if corrected the corresponding entry needs to be removed from the test. … … 17 24 18 25 __DATA__ 19 compilers/imcc/instructions.c20 compilers/imcc/optimizer.c21 compilers/imcc/parser_util.c22 compilers/imcc/pbc.c23 compilers/imcc/pcc.c24 compilers/imcc/reg_alloc.c25 compilers/imcc/symreg.c26 compilers/pirc/src/pircapi.c27 config/gen/platform/ansi/dl.c28 config/gen/platform/ansi/exec.c29 config/gen/platform/ansi/time.c30 config/gen/platform/darwin/dl.c31 config/gen/platform/darwin/memalign.c32 config/gen/platform/generic/dl.c33 config/gen/platform/generic/exec.c34 config/gen/platform/generic/math.c35 config/gen/platform/generic/memalign.c36 config/gen/platform/generic/stat.c37 config/gen/platform/generic/time.c38 config/gen/platform/netbsd/math.c39 config/gen/platform/openbsd/math.c40 config/gen/platform/solaris/math.c41 config/gen/platform/solaris/time.c42 examples/compilers/japhc.c43 src/gc/generational_ms.c44 src/io/io_string.c45 src/string/charset/ascii.c46 src/string/charset/binary.c47 src/string/charset/iso-8859-1.c48 src/string/charset/unicode.c49 src/tsq.c50 26 51 27 }}} 52 28 53 as at r44170 29 this list is now empty as at r47918 and hopefully will remain so.