pike.git/
src/
program.c
Branch:
Tag:
Non-build tags
All tags
No tags
2021-01-11
2021-01-11 15:26:15 by Henrik Grubbström (Grubba) <grubba@grubba.org>
74346ff176ec125f4f85d1c52fb0fb2da2fc2c99 (
39
lines) (+
35
/-
4
)
[
Show
|
Annotate
]
Branch:
master
Documentation
[LFUNs]
: Added some doc for the _iterator_*() lfuns.
1657:
*! Called by @[reverse()]. */
-
/*
FIXME:
lfun::_iterator_next() *
/
-
/
*
FIXME:
lfun::_
iterator
_index()
*
/
-
/
*
FIXME:
lfun::_
iterator
_prev
() */
+
/*
!
@decl
int
lfun::_iterator_next()
+
*
!
+
*
!
Called in @[Iterator] objects by foreach.
+
*!
+
*! Advances the
iterator
one step.
+
*
!
+
*
!
@note
+
*! This is the preferred way to advance an
iterator
, since it
+
*! reduces the overhead.
+
*!
+
*! @returns
+
*! Returns @tt{1@} if it succeeded in advancing, and
+
*! @tt{0@}
(
zero
)
if it has reached the end of the iterator.
+
*/
-
/*! @decl mixed _
atomic
_
get_set(mixed
index
, mixed value
)
+
/*! @decl mixed
lfun::
_
iterator
_
index
()
*!
-
+
*! Called in @[Iterator] objects by foreach.
+
*!
+
*! Returns the current index for an iterator, or @[UNDEFINED]
+
*! if the iterator doesn't point to any item.
+
*!
+
*! If there's no obvious index set then the index is the current
+
*! position in the data set, counting from @expr{0@} (zero).
+
*/
+
+
/*! @decl mixed lfun::_iterator_value()
+
*!
+
*! Called in @[Iterator] objects by foreach.
+
*!
+
*! Returns the current value for an iterator, or @[UNDEFINED]
+
*! if the iterator doesn't point to any item.
+
*/
+
+
/*! @decl mixed lfun::_atomic_get_set(mixed index, mixed value)
+
*!
*! Get and set the value for an index atomically. *! *! @param index