From: William Victor Mote Date: Tue, 1 Jul 2003 17:24:35 +0000 (+0000) Subject: Move "conventions" section of index.xml to a new conventions.xml document, and add... X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1367 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=1f41080f14e4667cddc388c073f990b8fde412af;p=xmlgraphics-fop.git Move "conventions" section of index.xml to a new conventions.xml document, and add it to the menu. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196555 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/dev/book.xml b/src/documentation/content/xdocs/dev/book.xml index 10322781a..fc6f8eb2a 100644 --- a/src/documentation/content/xdocs/dev/book.xml +++ b/src/documentation/content/xdocs/dev/book.xml @@ -21,6 +21,7 @@ + diff --git a/src/documentation/content/xdocs/dev/conventions.xml b/src/documentation/content/xdocs/dev/conventions.xml new file mode 100644 index 000000000..c6a376e2b --- /dev/null +++ b/src/documentation/content/xdocs/dev/conventions.xml @@ -0,0 +1,37 @@ + + + +
+ FOP Development: Coding Conventions +
+ +
+ Java +
+ Java Style +

In order to facilitate the human reading of FOP source code, the FOP developers have agreed on a set of coding conventions. +The basis of these coding conventions is documented in the Apache XML Project Guidelines, which requires that all Java Language source code in the repository must be written in conformance to Sun's Code Conventions for the Java Programming Language. +In addition, other conventions have been applied to the FOP project, which are summarized in the following table:

+ + + + + + + + + + + + + + + + +
ConventionRationaleEnforced By
No tabs in contentProgrammers should not have to adjust the tab settings in their editor to be able to read the source code.checkstyle
Indentation of 4 spaces per levelMaximize readability.Not enforced
+

For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like astyle (Artistic Style) before committing.

+
+
+ + diff --git a/src/documentation/content/xdocs/dev/index.xml b/src/documentation/content/xdocs/dev/index.xml index 51d03d989..0b066955c 100644 --- a/src/documentation/content/xdocs/dev/index.xml +++ b/src/documentation/content/xdocs/dev/index.xml @@ -126,17 +126,6 @@ To unsubscribe: Send email to - Coding Conventions -

As mentioned in Apache XML Project Guidelines, - all Java Language source code in the repository must be written in conformance to the - Code Conventions - for the Java Programming Language as published by Sun. Additionally we agreed on 4 - spaces (no tabs) for indenting.

-

If you don't like those conventions, just use your own standards while developing and reformat the source before - committing with a tool like astyle (Artistic Style). -

-