autodoc.git
/
traditional.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional.xml:1:
<?xml version='1.0' encoding='utf-8'?>
-
<manual time-stamp='2022-
07
-
29
' version='Pike v8.1.18'>
+
<manual time-stamp='2022-
08
-
02
' version='Pike v8.1.18'>
<dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:6368:
simulation of the type specified by <ref resolved='lfun::_is_type.basic_type'>basic_type</ref>.</p> </text></group><group><note/><text><p>The argument is currently a string with the name of the type, but might in the future be a value of the type type.</p> </text></group><group><note/><text><p>It's assumed that this function is side-effect free.</p> </text></group></doc> <method name='_is_type'> <arguments><argument name='basic_type'><type><string/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup>
-
<docgroup homogen-name='_iterator_index' homogen-type='method'><doc><text><p>Called in <ref>Iterator</ref> objects by foreach.</p>
+
<docgroup homogen-name='_iterator_index' homogen-type='method'><doc><text><p>Called in <ref>Iterator</ref> objects by foreach
(optional)
.</p>
<p> Returns the current index for an iterator, or <ref>UNDEFINED</ref>
-
if the iterator doesn't point to any item.</p>
+
if the iterator doesn't point to any item.
If this
+
function is not present, the return value from
+
<
ref resolved='lfun::_iterator_next'>lfun::_iterator_next()<
/
ref> will be used.</
p>
<p> If there's no obvious index set then the index is the current position in the data set, counting from <expr>0</expr> (zero).</p>
-
</text></doc>
+
</text><
group><seealso
/
><text><p><ref resolved='lfun::_iterator_next'>lfun::_iterator_next()</ref>, <ref resolved='lfun::_iterator_value'>lfun::_iterator_value()</ref></p>
+
</text></group></
doc>
<method name='_iterator_index'> <arguments/> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='_iterator_next' homogen-type='method'><doc><text><p>Called in <ref>Iterator</ref> objects by foreach.</p> <p> Advances the iterator one step.</p>
-
</
text
><
group
><
note
/><
text
><p>
This
is
the
preferred
way
to
advance
an
iterator,
since
it
-
reduces
the
overhead
.</p>
-
</text><
/
group><
group><
returns/><text><p>Returns <
tt
>
1
</
tt
> if
it
succeeded
in
advancing
, and
-
<
tt
>
0
</
tt
>
(zero)
if
it
has
reached
the
end
of
the
iterator
.
</p>
+
<
p> Iterators start at the position before the first element,
+
and <tt>foreach<
/
tt
>
calls this function repeatedly until it
+
returns
<
ref
>
UNDEFINED
</
ref
>
.
<
/p
>
+
<p>
Calling
it
again after it has returned <ref>UNDEFINED</ref> will
+
typically cause it
to
restart
the
iteration
with
the
+
first
element (ie
the
start and end sentinel values are
+
the same)
.</p>
+
</text><group><returns/><text><p>Returns <
ref
>
UNDEFINED
</
ref
> if
there
are
no more elements
in
the
+
iterator. Otherwise it may return any other value
,
which
+
for convenience will be used as index
and
/or value in case
+
there is no
<
ref resolved='lfun::_iterator_index'
>
lfun::_iterator_index()
</
ref
>
and/or
no
+
<ref
resolved='lfun::_iterator_value'>lfun::_iterator_value()</ref>.</p>
+
</text></group><group><seealso/><text><p><ref
resolved='lfun::_iterator_index'>lfun::_iterator_index()</ref>,
<ref
resolved='lfun::_
iterator
_value'>lfun::_iterator_value()
</
ref></
p>
</text></group></doc> <method name='_iterator_next'> <arguments/>
-
<returntype><
int
/></returntype>
+
<returntype><
mixed
/></returntype>
</method> </docgroup>
-
<docgroup homogen-name='_iterator_value' homogen-type='method'><doc><text><p>Called in <ref>Iterator</ref> objects by foreach.</p>
+
<docgroup homogen-name='_iterator_value' homogen-type='method'><doc><text><p>Called in <ref>Iterator</ref> objects by foreach
(optional)
.</p>
<p> Returns the current value for an iterator, or <ref>UNDEFINED</ref> if the iterator doesn't point to any item.</p> </text></doc> <method name='_iterator_value'> <arguments/> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='_m_add' homogen-type='method'><doc><text><p>Called by <ref>m_add()</ref>.</p> </text><group><seealso/><text><p><ref resolved='lfun::_m_delete'>lfun::_m_delete()</ref>, <ref resolved='lfun::_m_clear'>lfun::_m_clear()</ref></p>