Skip to content

Commit f703ed6

Browse files
committed
Fix documentation parser
Reset comment right after adding to the index.
1 parent bd6a427 commit f703ed6

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

doc/apibuild.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -1117,7 +1117,6 @@ def parseBlock(self, token):
11171117
token = self.token()
11181118
token = self.parseBlock(token)
11191119
elif token[0] == "sep" and token[1] == "}":
1120-
self.comment = None
11211120
token = self.token()
11221121
return token
11231122
else:
@@ -1561,17 +1560,20 @@ def parseGlobal(self, token):
15611560
((type, None), self.signature), 1)
15621561
self.index_add(self.name, self.filename, static,
15631562
"function", d)
1563+
self.comment = None
15641564
token = self.token()
15651565
elif token[0] == "sep" and token[1] == "{":
15661566
d = self.mergeFunctionComment(self.name,
15671567
((type, None), self.signature), static)
15681568
self.index_add(self.name, self.filename, static,
15691569
"function", d)
1570+
self.comment = None
15701571
token = self.token()
15711572
token = self.parseBlock(token);
15721573
elif token[1] == ',':
15731574
self.index_add(self.name, self.filename, static,
15741575
"variable", type)
1576+
self.comment = None
15751577
type = type_orig
15761578
token = self.token()
15771579
while token != None and token[0] == "sep":
@@ -1580,7 +1582,6 @@ def parseGlobal(self, token):
15801582
if token != None and token[0] == "name":
15811583
self.name = token[1]
15821584
token = self.token()
1583-
self.comment = None
15841585
else:
15851586
break
15861587

doc/devhelp/libxml2-globals.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h2>Details</h2>
142142
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>node</tt></i>:</span></td><td>the current node</td></tr></tbody></table></div></div>
143143
<hr/>
144144
<div class="refsect2" lang="en"><h3><a name="htmlDefaultSAXHandler">Variable </a>htmlDefaultSAXHandler</h3><pre class="programlisting"><a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> htmlDefaultSAXHandler;
145-
</pre><p/>
145+
</pre><p>DEPRECATED: This handler is unused and will be removed from future versions. Default old SAX v1 handler for HTML, builds the DOM tree</p>
146146
</div>
147147
<hr/>
148148
<div class="refsect2" lang="en"><h3><a name="oldXMLWDcompatibility">Variable </a>oldXMLWDcompatibility</h3><pre class="programlisting">int oldXMLWDcompatibility;
@@ -158,11 +158,11 @@ <h2>Details</h2>
158158
</div>
159159
<hr/>
160160
<div class="refsect2" lang="en"><h3><a name="xmlDefaultSAXHandler">Variable </a>xmlDefaultSAXHandler</h3><pre class="programlisting"><a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> xmlDefaultSAXHandler;
161-
</pre><p/>
161+
</pre><p>DEPRECATED: This handler is unused and will be removed from future versions. Default SAX version1 handler for XML, builds the DOM tree</p>
162162
</div>
163163
<hr/>
164164
<div class="refsect2" lang="en"><h3><a name="xmlDefaultSAXLocator">Variable </a>xmlDefaultSAXLocator</h3><pre class="programlisting"><a href="libxml2-tree.html#xmlSAXLocator">xmlSAXLocator</a> xmlDefaultSAXLocator;
165-
</pre><p/>
165+
</pre><p>DEPRECATED: Don't use The default SAX Locator { getPublicId, getSystemId, getLineNumber, getColumnNumber}</p>
166166
</div>
167167
<hr/>
168168
<div class="refsect2" lang="en"><h3><a name="xmlDeregisterNodeDefaultValue">Variable </a>xmlDeregisterNodeDefaultValue</h3><pre class="programlisting"><a href="libxml2-globals.html#xmlDeregisterNodeFunc">xmlDeregisterNodeFunc</a> xmlDeregisterNodeDefaultValue;

doc/libxml2-api.xml

+9-3
Original file line numberDiff line numberDiff line change
@@ -6951,7 +6951,9 @@ Could we use @subtypes for this?'/>
69516951
<typedef name='xmlXPathVariablePtr' file='xpath' type='xmlXPathVariable *'/>
69526952
<variable name='emptyExp' file='xmlregexp' type='xmlExpNodePtr'/>
69536953
<variable name='forbiddenExp' file='xmlregexp' type='xmlExpNodePtr'/>
6954-
<variable name='htmlDefaultSAXHandler' file='globals' type='xmlSAXHandlerV1'/>
6954+
<variable name='htmlDefaultSAXHandler' file='globals' type='xmlSAXHandlerV1'>
6955+
<info>DEPRECATED: This handler is unused and will be removed from future versions. Default old SAX v1 handler for HTML, builds the DOM tree</info>
6956+
</variable>
69556957
<variable name='oldXMLWDcompatibility' file='globals' type='int'>
69566958
<info>Global setting, DEPRECATED.</info>
69576959
</variable>
@@ -6961,8 +6963,12 @@ Could we use @subtypes for this?'/>
69616963
<variable name='xmlDefaultBufferSize' file='globals' type='int'>
69626964
<info>DEPRECATED: Don&apos;t use. Global setting, default buffer size. Default value is BASE_BUFFER_SIZE</info>
69636965
</variable>
6964-
<variable name='xmlDefaultSAXHandler' file='globals' type='xmlSAXHandlerV1'/>
6965-
<variable name='xmlDefaultSAXLocator' file='globals' type='xmlSAXLocator'/>
6966+
<variable name='xmlDefaultSAXHandler' file='globals' type='xmlSAXHandlerV1'>
6967+
<info>DEPRECATED: This handler is unused and will be removed from future versions. Default SAX version1 handler for XML, builds the DOM tree</info>
6968+
</variable>
6969+
<variable name='xmlDefaultSAXLocator' file='globals' type='xmlSAXLocator'>
6970+
<info>DEPRECATED: Don&apos;t use The default SAX Locator { getPublicId, getSystemId, getLineNumber, getColumnNumber}</info>
6971+
</variable>
69666972
<variable name='xmlDeregisterNodeDefaultValue' file='globals' type='xmlDeregisterNodeFunc'/>
69676973
<variable name='xmlDoValidityCheckingDefaultValue' file='globals' type='int'>
69686974
<info>Global setting, indicate that the parser should work in validating mode. Disabled by default.</info>

0 commit comments

Comments
 (0)