Skip to content

Commit ea6a659

Browse files
committed
Add class directives for xml.dom
1 parent 98b4cd6 commit ea6a659

File tree

1 file changed

+55
-35
lines changed

1 file changed

+55
-35
lines changed

Doc/library/xml.dom.rst

Lines changed: 55 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,9 @@ DOM Level 2 added the ability to create new :class:`Document` and
236236
Node Objects
237237
^^^^^^^^^^^^
238238

239-
All of the components of an XML document are subclasses of :class:`Node`.
239+
.. class:: Node
240+
241+
All of the components of an XML document are subclasses of :class:`Node`.
240242

241243

242244
.. attribute:: Node.nodeType
@@ -403,14 +405,16 @@ All of the components of an XML document are subclasses of :class:`Node`.
403405
NodeList Objects
404406
^^^^^^^^^^^^^^^^
405407

406-
A :class:`NodeList` represents a sequence of nodes. These objects are used in
407-
two ways in the DOM Core recommendation: an :class:`Element` object provides
408-
one as its list of child nodes, and the :meth:`getElementsByTagName` and
409-
:meth:`getElementsByTagNameNS` methods of :class:`Node` return objects with this
410-
interface to represent query results.
408+
.. class:: NodeList
409+
410+
A :class:`NodeList` represents a sequence of nodes. These objects are used in
411+
two ways in the DOM Core recommendation: an :class:`Element` object provides
412+
one as its list of child nodes, and the :meth:`getElementsByTagName` and
413+
:meth:`getElementsByTagNameNS` methods of :class:`Node` return objects with this
414+
interface to represent query results.
411415

412-
The DOM Level 2 recommendation defines one method and one attribute for these
413-
objects:
416+
The DOM Level 2 recommendation defines one method and one attribute for these
417+
objects:
414418

415419

416420
.. method:: NodeList.item(i)
@@ -442,16 +446,18 @@ If a DOM implementation supports modification of the document, the
442446
DocumentType Objects
443447
^^^^^^^^^^^^^^^^^^^^
444448

445-
Information about the notations and entities declared by a document (including
446-
the external subset if the parser uses it and can provide the information) is
447-
available from a :class:`DocumentType` object. The :class:`DocumentType` for a
448-
document is available from the :class:`Document` object's :attr:`doctype`
449-
attribute; if there is no ``DOCTYPE`` declaration for the document, the
450-
document's :attr:`doctype` attribute will be set to ``None`` instead of an
451-
instance of this interface.
449+
.. class:: DocumentType
450+
451+
Information about the notations and entities declared by a document (including
452+
the external subset if the parser uses it and can provide the information) is
453+
available from a :class:`DocumentType` object. The :class:`DocumentType` for a
454+
document is available from the :class:`Document` object's :attr:`doctype`
455+
attribute; if there is no ``DOCTYPE`` declaration for the document, the
456+
document's :attr:`doctype` attribute will be set to ``None`` instead of an
457+
instance of this interface.
452458

453-
:class:`DocumentType` is a specialization of :class:`Node`, and adds the
454-
following attributes:
459+
:class:`DocumentType` is a specialization of :class:`Node`, and adds the
460+
following attributes:
455461

456462

457463
.. attribute:: DocumentType.publicId
@@ -502,9 +508,11 @@ following attributes:
502508
Document Objects
503509
^^^^^^^^^^^^^^^^
504510

505-
A :class:`Document` represents an entire XML document, including its constituent
506-
elements, attributes, processing instructions, comments etc. Remember that it
507-
inherits properties from :class:`Node`.
511+
.. class:: Document
512+
513+
A :class:`Document` represents an entire XML document, including its constituent
514+
elements, attributes, processing instructions, comments etc. Remember that it
515+
inherits properties from :class:`Node`.
508516

509517

510518
.. attribute:: Document.documentElement
@@ -582,8 +590,10 @@ inherits properties from :class:`Node`.
582590
Element Objects
583591
^^^^^^^^^^^^^^^
584592

585-
:class:`Element` is a subclass of :class:`Node`, so inherits all the attributes
586-
of that class.
593+
.. class:: Element
594+
595+
:class:`Element` is a subclass of :class:`Node`, so inherits all the attributes
596+
of that class.
587597

588598

589599
.. attribute:: Element.tagName
@@ -686,7 +696,9 @@ of that class.
686696
Attr Objects
687697
^^^^^^^^^^^^
688698

689-
:class:`Attr` inherits from :class:`Node`, so inherits all its attributes.
699+
.. class:: Attr
700+
701+
:class:`Attr` inherits from :class:`Node`, so inherits all its attributes.
690702

691703

692704
.. attribute:: Attr.name
@@ -719,7 +731,9 @@ Attr Objects
719731
NamedNodeMap Objects
720732
^^^^^^^^^^^^^^^^^^^^
721733

722-
:class:`NamedNodeMap` does *not* inherit from :class:`Node`.
734+
.. class:: NamedNodeMap
735+
736+
:class:`NamedNodeMap` does *not* inherit from :class:`Node`.
723737

724738

725739
.. attribute:: NamedNodeMap.length
@@ -743,8 +757,10 @@ of methods on the :class:`Element` objects.
743757
Comment Objects
744758
^^^^^^^^^^^^^^^
745759

746-
:class:`Comment` represents a comment in the XML document. It is a subclass of
747-
:class:`Node`, but cannot have child nodes.
760+
.. class:: Comment
761+
762+
:class:`Comment` represents a comment in the XML document. It is a subclass of
763+
:class:`Node`, but cannot have child nodes.
748764

749765

750766
.. attribute:: Comment.data
@@ -759,14 +775,16 @@ Comment Objects
759775
Text and CDATASection Objects
760776
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
761777

762-
The :class:`Text` interface represents text in the XML document. If the parser
763-
and DOM implementation support the DOM's XML extension, portions of the text
764-
enclosed in CDATA marked sections are stored in :class:`CDATASection` objects.
765-
These two interfaces are identical, but provide different values for the
766-
:attr:`nodeType` attribute.
778+
.. class:: Text
767779

768-
These interfaces extend the :class:`Node` interface. They cannot have child
769-
nodes.
780+
The :class:`Text` interface represents text in the XML document. If the parser
781+
and DOM implementation support the DOM's XML extension, portions of the text
782+
enclosed in CDATA marked sections are stored in :class:`CDATASection` objects.
783+
These two interfaces are identical, but provide different values for the
784+
:attr:`nodeType` attribute.
785+
786+
These interfaces extend the :class:`Node` interface. They cannot have child
787+
nodes.
770788

771789

772790
.. attribute:: Text.data
@@ -787,8 +805,10 @@ nodes.
787805
ProcessingInstruction Objects
788806
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
789807

790-
Represents a processing instruction in the XML document; this inherits from the
791-
:class:`Node` interface and cannot have child nodes.
808+
.. class:: ProcessingInstruction
809+
810+
Represents a processing instruction in the XML document; this inherits from the
811+
:class:`Node` interface and cannot have child nodes.
792812

793813

794814
.. attribute:: ProcessingInstruction.target

0 commit comments

Comments
 (0)