Changeset 1855 in orxonox.OLD for orxonox/trunk/doc

Timestamp:

May 5, 2004, 9:34:21 AM (21 years ago)

Author:

patrick

Message:

/orxonox/trunk/core/ modifications on world and docs

Location:

orxonox/trunk/doc

Files:

• CODING-STANDARDS (modified) (1 diff)
• README (modified) (3 diffs)

orxonox/trunk/doc/CODING-STANDARDS

@@ +1 @@
+
+
+
+1.Coding Conventions
+2.How to format your Code
+
+1.Coding Conventions
+--------------------
+==> If you are beginning a new code-file: copy the proto_class.{cc,h}
+==> and work with these files.
+
+a) in every code file, there has to be a GNU copyright header
+b) under the (c) header write your name as main-programmer, if
+   you are just bugfixing or extending write it under co-programmer
+c) Every function has a header with informations about it:
+/**
+   \brief <a brief description>
+   \param <parameters the function needs>
+   \param <more parameters>
+
+   <more description>
+*/
+   This makes live easier, if we want to add a documentation.
+
+
+2.How to format your Code
+-------------------------
 We use the GNU conding convention (which is also used in xemacs etc.):
 

orxonox/trunk/doc/README

@@ -14 +14 @@
 in c++ and OpenGL.
 If we manage to be sober enough, this game shall definitly 
-become _the_ open-source vertical scrolle ever.
+become _the_ open-source vertical scroller ever.
 
 2.Manifesto:
@@ -32 +32 @@
 4.Howto C++ Programming
 5.Howto SVN
+6.Coding conventions
 
 
@@ -128 +129 @@
 topic, it will be revised by us and merged with the trunk
 
-
+7.Coding Conventions
+--------------------
+Read the File CODING-STANDARDS