/[fenfire]/fenfire/docs/newbie-dev-faq.rst
ViewVC logotype

Diff of /fenfire/docs/newbie-dev-faq.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by tjl, Fri Jun 6 20:04:32 2003 UTC revision 1.4 by mudyc, Fri Aug 29 08:02:58 2003 UTC
# Line 30  Screen is empty? Line 30  Screen is empty?
30  **Q**: I don't see anything. Just plain black with GL.  **Q**: I don't see anything. Just plain black with GL.
31    
32  **A**: Probably you have some problems with your X drivers etc.  **A**: Probably you have some problems with your X drivers etc.
33  Update your /usr/X11R6/include/GL/*.  Update your /usr/X11R6/include/GL/\*.
34    
35  **A2**: unset LANG  **A2**: unset LANG
36    
# Line 105  Well, instead of previous example, write Line 105  Well, instead of previous example, write
105      }      }
106    
107    
108    Creating well documentated source
109    ---------------------------------
110    
111    1. Documenting is part of good source
112    
113        - In Fenfire we use java-doc and docxx
114    
115    2. See the documentation already exists.
116    
117        - The most important part of documentation is the first line.
118    
119    3. Write the documentation
120    
121        - Remember the importance of first line in class and method documentation.
122        - Write the truth, don't lie.
123        - If method implements an interface it's javadocced by the interface.
124          So, don't make any worse documentation in implementation, leave it
125          alone or mark it with comment // javadoc in interface etc.
126    
127    4. Test
128    
129        - Ask your friend to look the compiled document and
130          ask what the class do. If the answer is mess,
131          your documentation is even worse mess.
132    
133  Slang  Slang
134  =====  =====

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26