Skip to content

Commit 57198a6

Browse files
Update src/app/AttributePathExpandIterator.h
Co-authored-by: Tennessee Carmel-Veilleux <tennessee.carmelveilleux@gmail.com>
1 parent aeecc5c commit 57198a6

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

src/app/AttributePathExpandIterator.h

+7-8
Original file line numberDiff line numberDiff line change
@@ -31,31 +31,30 @@ namespace app {
3131
///
3232
/// - Start iterating by creating an iteration state
3333
///
34-
/// mPosition = AttributePathExpandIterator::Position::StartIterating(path);
34+
/// AttributePathExpandIterator::Position position = AttributePathExpandIterator::Position::StartIterating(path);
3535
///
3636
/// - Use the iteration state in a for loop:
3737
///
3838
/// ConcreteAttributePath path;
39-
/// for (AttributePathExpandIterator iterator(mPosition); iterator->Next(path);) {
39+
/// for (AttributePathExpandIterator iterator(position); iterator->Next(path);) {
4040
/// // use `path` here`
4141
/// }
4242
///
4343
/// OR:
4444
///
4545
/// ConcreteAttributePath path;
46-
/// AttributePathExpandIterator iterator(mPosition);
46+
/// AttributePathExpandIterator iterator(position);
4747
///
4848
/// while (iterator.Next(path)) {
4949
/// // use `path` here`
5050
/// }
5151
///
52-
/// USAGE requirements and assumptions:
52+
/// Usage requirements and assumptions:
5353
///
54-
/// - There should be only one single AttributePathExpandIterator for a state at a time.
55-
///
56-
/// - `Position` is automatically updated by the AttributePathExpandIterator, so
57-
/// calling `Next` on the iterator will update the state variable.
54+
/// - An ` AttributePathExpandIterator::Position` can only be used by a single AttributePathExpandIterator at a time.
5855
///
56+
/// - `position` is automatically updated by the AttributePathExpandIterator, so
57+
/// calling `Next` on the iterator will update the position cursor variable.
5958
///
6059
class AttributePathExpandIterator
6160
{

0 commit comments

Comments
 (0)