Commit cb3766b6 authored by Jan Möbius's avatar Jan Möbius
Browse files

Documentation

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5049 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 596321ca
...@@ -303,7 +303,7 @@ enum IteratorRestriction { ...@@ -303,7 +303,7 @@ enum IteratorRestriction {
/** \brief Core Data Iterator /** \brief Core Data Iterator
* *
* This is the core iterator for the whole framework. You should use this iterator to access your data.\n * This is the core iterator for the whole framework. You should use this iterator to access your data.\n
* You can Choose if the iterator returns only Target, Source or all objects.\n * You can choose if the iterator returns only Target, Source or all objects.\n
* Additionally you can set the type of objects returned by the iterator. * Additionally you can set the type of objects returned by the iterator.
* The ObjectIterator will only return real Objects. Groups are not considered to be objects * The ObjectIterator will only return real Objects. Groups are not considered to be objects
*/ */
...@@ -381,10 +381,10 @@ class DLLEXPORT ObjectIterator { ...@@ -381,10 +381,10 @@ class DLLEXPORT ObjectIterator {
/** \brief Core Data Iterator used to iterate over all objects (Including groups) /** \brief Core Data Iterator used to iterate over all objects (Including groups)
* *
* This is the core iterator for the whole framework. You should use this iterator to access your data.\n * This iterator is a more low level one not only returning really visible objects but also
* You can Choose if the iterator returns only Target, Source or all objects.\n * Data containers ( e.g. groups... )
* You can choose if the iterator returns only Target, Source or all objects.\n
* Additionally you can set the type of objects returned by the iterator. * Additionally you can set the type of objects returned by the iterator.
* The ObjectIterator will only return real Objects. Groups are not considered to be objects
*/ */
class DLLEXPORT BaseObjectIterator { class DLLEXPORT BaseObjectIterator {
...@@ -451,7 +451,7 @@ class DLLEXPORT BaseObjectIterator { ...@@ -451,7 +451,7 @@ class DLLEXPORT BaseObjectIterator {
/// Restriction of the iterator /// Restriction of the iterator
IteratorRestriction restriction_; IteratorRestriction restriction_;
/** Takes an object and goes through the object tree to the next BaseObjectData /** Takes an object and goes through the object tree to the next BaseObject
* It stops at the root node. * It stops at the root node.
*/ */
inline void proceedToNextBaseObject(BaseObject*& _object); inline void proceedToNextBaseObject(BaseObject*& _object);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment