[ff-cvs] fenfire/docs CodingConventions.rst

[Matti Katila]

CVSROOT:        /cvsroot/fenfire
Module name:    fenfire
Branch:         
Changes by:     Matti Katila <address@hidden>   03/10/01 01:30:11

Modified files:
        docs           : CodingConventions.rst 

Log message:
        fixed syntax problem and added class to dbg message

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/docs/CodingConventions.rst.diff?tr1=1.4&tr2=1.5&r1=text&r2=text

Patches:
Index: fenfire/docs/CodingConventions.rst
diff -u fenfire/docs/CodingConventions.rst:1.4 
fenfire/docs/CodingConventions.rst:1.5
--- fenfire/docs/CodingConventions.rst:1.4      Wed Sep 10 09:28:23 2003
+++ fenfire/docs/CodingConventions.rst  Wed Oct  1 01:30:11 2003
@@ -2,9 +2,7 @@
 Coding rules for Fenfire and related projects
 =============================================
 
-Tuomas Lukka
-Antti-Juhani Kaijanaho
-
+:Author: Tuomas Lukka and Antti-Juhani Kaijanaho
 
 This document attempts to give a brief guide on how to write
 Java and Jython code for Fenfire and related projects.
@@ -33,18 +31,18 @@
   system.
 
 
-- For debugging log messages, use code like
+- For debugging log messages, use code like ::
 
-    public static boolean dbg = false;
-    protected static void p(String s) { System.out.println(s); }
-    ...
-    if(dbg) p("Debug message");
+     public static boolean dbg = false;
+     protected static void p(String s) { System.out.println("Class:: "+s); }
+     ...
+     if(dbg) p("Debug message");
 
   to print out messages. The System.out.println() is too verbose to insert
   into code. This code can be added to the beginning of any class.
   Debugging can then be turned on like ::
 
-    make run_fenpdfdemo DBG="-d org.fenfire.foobar.Foo
+     make run_fenpdfdemo DBG="-d org.fenfire.foobar.Foo"
 
 - Avoid both under- and overdocumenting.
 
@@ -52,7 +50,7 @@
 
 - Try to keep the external APIs small
 
-- Indenting: tabstop==8, shiftwidth == 4, cuddled braces, i.e.
+- Indenting: tabstop==8, shiftwidth == 4, cuddled braces, i.e. ::
        
        public void method() {
            if(...) {
@@ -125,15 +123,21 @@
   to the text in a xanadu-like manner.
 
 - We use pretty long identifiers - make sure your editor's dynamic
-  abbreviations are turned on. For example, I type
+  abbreviations are turned on. For example, I type ::
+
        Mod^P
-    and start getting the options
+
+  and start getting the options ::
+
        ModularSpace, ...
-    for the word. NEVER type the identifiers in whole.
+
+  for the word. NEVER type the identifiers in whole.
 
 - Use exuberant ctags. First, "make tags", then in vim, I
-  just do 
+  just do ::
+
        :ta Aff<TAB>
+
   which gives me the options AffineVobCoorder and AffineXYCoords.
   Then, pressing enter takes me to the definition.
   NEVER type the directory names for the classes.