1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-interfaces-ivisitor.enter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CommonMark\Interfaces\IVisitor::enter</refname>
<refpurpose>Visitation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::enter</methodname>
<methodparam><type>IVisitable</type><parameter>visitable</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>visitable</parameter></term>
<listitem>
<para>
The current <classname>CommonMark\Interfaces\IVisitable</classname> being entered
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returning <varname>CommonMark\Interfaces\IVisitor::Done</varname> will cause the backing iterator to exit.
</para>
<para>
Returning <varname>CommonMark\Interfaces\IVisitor::Enter</varname> will reset the backing iterator at entering the current <classname>IVisitable</classname>
</para>
<para>
Returning <varname>CommonMark\Interfaces\IVisitor::Leave</varname> will reset the backing iterator at exiting the current <classname>IVisitable</classname>
</para>
<para>
Returning an <classname>IVisitable</classname> will reset the backing iterator at entering the given <classname>IVisitable</classname>
</para>
<para>
Returning nothing will allow the backing iterator to continue
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="commonmark-interfaces-ivisitable.accept" /></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
