Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Dec 9, 2007, 11:21:14 PM (16 years ago)
Author:
landauf
Message:
  • added comments and doxygen-tags to the ConfigValueContainer
  • changed some comments in the other files
File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/objecthierarchy/src/orxonox/core/Iterator.h

    r365 r447  
    44
    55    The Iterator of a given class allows to iterate through an ObjectList, containing all objects of that type.
    6     This is the only way to access the objects in an ObjectList.
     6    This is the only way to access the objects stored in an ObjectList.
    77
    88    Usage:
    … …  
    1313    }
    1414
    15     Warning: Don't delete an object directly through the iterator.
     15    Warning: Don't delete objects directly through the iterator.
    1616*/
    1717
    … …  
    2727        public:
    2828            /**
    29                 @brief Constructor: Sets the element whereon the iterator points to zero.
     29                @brief Constructor: Sets the element, whereon the iterator points, to zero.
    3030            */
    3131            Iterator()
    … …  
    3535
    3636            /**
    37                 @brief Constructor: Sets the element whereon the iterator points to a given element.
     37                @brief Constructor: Sets the element, whereon the iterator points, to a given element.
    3838                @param element The element to start with
    3939            */
    … …  
    4444
    4545            /**
    46                 @brief Overloading of the ++it operator: Iterator iterates to the next object in the list.
     46                @brief Overloading of the ++it operator: Iterator points to the next object in the list.
    4747                @return The Iterator itself
    4848            */
    … …  
    5454
    5555            /**
    56                 @brief Overloading of the --it operator: Iterator iterates to the previous object in the list.
     56                @brief Overloading of the --it operator: Iterator points to the previous object in the list.
    5757                @return The Iterator itself
    5858            */
    … …  
    9898            bool operator!=(int compare)
    9999            {
    100                 // Comparing with something except zero makes no sense
     100                // Comparing with anything except zero makes no sense
    101101                if (compare != 0)
    102102                    std::cout << "Warning: Comparing the " << ClassIdentifier<T>::getIdentifier()->getName() << "-List-Iterator with " << compare << " has no effect. Only comparison with 0 works.\n";
    … …  
    106106
    107107        private:
    108             ObjectListElement<T>* element_;     //!< The element the Iterator points to
     108            ObjectListElement<T>* element_;     //!< The element the Iterator points at
    109109    };
    110110}
Note: See TracChangeset for help on using the changeset viewer.