Author: bernhard Date: Wed Mar 5 10:59:21 2008 New Revision: 26231 Modified: trunk/docs/pdds/pdd07_codingstd.pod
Log: [doc] Spelling and markup fixes. Modified: trunk/docs/pdds/pdd07_codingstd.pod ============================================================================== --- trunk/docs/pdds/pdd07_codingstd.pod (original) +++ trunk/docs/pdds/pdd07_codingstd.pod Wed Mar 5 10:59:21 2008 @@ -129,7 +129,7 @@ =item * -C macro parameters must be parethesized in macro bodies, to allow expressions +C macro parameters must be parenthesized in macro bodies, to allow expressions passed as arguments; e.g.: #define PMC_pmc_val(pmc) (pmc)->obj.u._ptrs._pmc_val @@ -253,12 +253,12 @@ =item * Functions must have prototypes in scope at the point of use. Prototypes for -extern functions must appear only in header files. If static functions are +extern functions must appear only in header files. If static functions are defined before use, their definitions serve as prototypes. =item * -Parameters in function prototypes must be named. These names should match the +Parameters in function prototypes must be named. These names should match the parameters in the function definition. =item * @@ -270,7 +270,7 @@ Header files must be wrapped with guard macros to prevent header redefinition. The guard macro must begin with C<PARROT_>, followed by unique and descriptive -text identifying the header file (usually the directory path and filename,) +text identifying the header file (usually the directory path and filename), and end with a C<_GUARD> suffix. The matching C<#endif> must have the guard macro name in a comment, to prevent confusion. For example, a file named F<parrot/foo.h> might look like: @@ -620,7 +620,7 @@ =item C<foo_bar.[ch]> etc. -All other source files associated with the subsystem will have the prefix foo_ +All other source files associated with the subsystem will have the prefix C<foo_>. =back @@ -786,7 +786,7 @@ The importance of good code documentation cannot be stressed enough. To make your code understandable by others (and indeed by yourself when you come to -make changes a year later :-), the following conventions apply to all source +make changes a year later), the following conventions apply to all source files. =over 4 @@ -969,7 +969,7 @@ automatically generated by other tools, or are external files included in the Parrot repository for convenience. Such files include the C header and source files automatically generated by (f)lex and yacc/bison, and some of -the Perl modules under the C<lib/> directory. +the Perl modules under the F<lib/> directory. To exempt a file (or directory of files) from checking by the coding standards tests, one must edit the appropriate exemption list within @@ -979,7 +979,7 @@ =head1 REFERENCES -The section on coding style is based on Perl 5's F<Porting/patching.pod> by +The section on coding style is based on Perl 5's L<Porting/patching.pod> by Daniel Grisinger. The section on naming conventions grew from some suggestions by Paolo Molaro <[EMAIL PROTECTED]>. Other snippets came from various P5Pers.
