Changeset 3449 in orxonox.OLD for orxonox/trunk/src/orxonox.cc

Timestamp:

Mar 2, 2005, 2:23:47 PM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: documented orxonox.cc/h world.cc/h vector.cc/h

File:

• orxonox/trunk/src/orxonox.cc (modified) (3 diffs)

orxonox/trunk/src/orxonox.cc

@@ -56 +56 @@
 
 
-/* this is a singleton class to prevent duplicates */
+/** \brief this is a singleton class to prevent duplicates */
 Orxonox* Orxonox::singletonRef = 0;
 
+/**
+   \returns reference or new Object of Orxonox if not existent.
+*/
 Orxonox* Orxonox::getInstance (void)
 {
@@ -322 +325 @@
 }
 
-
+/**
+   \return The reference of the SDL-screen of orxonox
+*/
 SDL_Surface* Orxonox::getScreen ()
 {
@@ -328 +333 @@
 }
 
-
+/**
+   \brief main function
+
+   here the journey begins
+*/
 int main(int argc, char** argv) 
 {