[ff-cvs] fenfire/docs newbie-dev-faq.rst

[Matti Katila]

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

Modified files:
        docs           : newbie-dev-faq.rst 

Log message:
        more documentation doc

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

Patches:
Index: fenfire/docs/newbie-dev-faq.rst
diff -u fenfire/docs/newbie-dev-faq.rst:1.4 fenfire/docs/newbie-dev-faq.rst:1.5
--- fenfire/docs/newbie-dev-faq.rst:1.4 Fri Aug 29 04:02:58 2003
+++ fenfire/docs/newbie-dev-faq.rst     Mon Nov  3 01:15:03 2003
@@ -3,8 +3,8 @@
 
====================================================================================
 
 :Date:         2002-11-24
-:Revision:     $Revision: 1.4 $
-:Last-Modified:        $Date: 2003/08/29 08:02:58 $
+:Revision:     $Revision: 1.5 $
+:Last-Modified:        $Date: 2003/11/03 06:15:03 $
    
 
 This file is for newbie developers.
@@ -123,6 +123,17 @@
     - If method implements an interface it's javadocced by the interface.
       So, don't make any worse documentation in implementation, leave it
       alone or mark it with comment // javadoc in interface etc.
+    - Some helpful questions which you can answer in the doc: 
+
+        - How does other classes use this?
+
+            - Who calls it?
+            - What for?
+            - When?
+        - How many instances are there of this class?
+        - What is it used to represent?
+        - What different implementations can there be?
+        - Would a good example hurt?
 
 4. Test