pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jahew...@apache.org
Subject svn commit: r1678433 - /pdfbox/cmssite/trunk/content/codingconventions.mdtext
Date Fri, 08 May 2015 19:14:05 GMT
Author: jahewson
Date: Fri May  8 19:14:04 2015
New Revision: 1678433

URL: http://svn.apache.org/r1678433
Log:
Formatting fix

Modified:
    pdfbox/cmssite/trunk/content/codingconventions.mdtext

Modified: pdfbox/cmssite/trunk/content/codingconventions.mdtext
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/codingconventions.mdtext?rev=1678433&r1=1678432&r2=1678433&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/codingconventions.mdtext (original)
+++ pdfbox/cmssite/trunk/content/codingconventions.mdtext Fri May  8 19:14:04 2015
@@ -59,19 +59,19 @@ Over the years the PDFBox project has co
 
 - Prefer comments on their own line, rather than trailing, unless the latter is more readable.
 
-## Variables
+### Variables
 
 - Prefer initializing variables when they are declared, rather than C-style declaration before
use.
 
 - Always use final fields when possible.
 
-## Control Flow
+### Control Flow
 
 - Prefer multiple return statements over additional control flow logic.
 
 - Prefer switch statements over multi-clause if-then statements.
 
-## API Design
+### API Design
 
 - Give variables and methods meaningful names. Keep these short but don't use abbreviations.
Prefer using the same terminology as the PDF spec.
 
@@ -85,7 +85,7 @@ Over the years the PDFBox project has co
 
 - Avoid unnecesary abstraction. While you're encouraged to avoid brittle designs, it's unlikey
that an API designed for "future use" will have the correct API without any code which actually
uses it.
  
-## Example
+### Example
 
 Here's an example of PDFBox's formatting style:
 



Mime
View raw message