Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 2842 in orxonox.OLD for orxonox/trunk/importer/array.cc


Ignore:
Timestamp:
Nov 12, 2004, 6:51:15 PM (20 years ago)
Author:
bensch
Message:

orxonox/trunk/importer: doxygen tags added

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orxonox/trunk/importer/array.cc

    r2823 r2842  
    1616#include "array.h"
    1717
     18/**
     19   \brief creates a new Array
     20*/
    1821Array::Array ()
    1922{
    20   createArray ();
     23  initializeArray ();
    2124}
    2225
    23 void Array::createArray ()
     26/**
     27   \brief initializes an Array
     28   the Function does this by setting up a fistEntry, and setting the entryCount.
     29*/
     30void Array::initializeArray ()
    2431{
    2532  if (verbose >= 2)
     
    3340}
    3441
     42/**
     43   \brief finalizes an array.
     44   This Function creates the array, and makes it ready to be sent to the application.
     45*/
    3546void Array::finalizeArray (void)
    3647{
     
    4960}
    5061
    51 
     62/**
     63   \brief adds a new Entry to the Array
     64   \param entry Entry to add.
     65*/
    5266void Array::addEntry (GLfloat entry)
    5367{
     
    6882}
    6983
     84/**
     85   \brief Adds 3 entries at once (convenience)
     86*/
    7087void Array::addEntry (GLfloat entry0, GLfloat entry1, GLfloat entry2)
    7188{
     
    7592}
    7693 
    77 
     94/**
     95   \brief Gives back the array !! MUST be executed AFTER finalize.
     96   \returns The created array.
     97*/
    7898GLfloat* Array::getArray ()
    7999{
     
    81101}
    82102
     103/**
     104   \returns The Count of entries in the Array
     105*/
    83106int Array::getCount()
    84107{
     
    86109}
    87110
    88 
    89 
     111/**
     112   \brief Simple debug info about the Array
     113*/
    90114void Array::debug ()
    91115{
Note: See TracChangeset for help on using the changeset viewer.