Doc: Clean up changes to Qt XML docs

* Remove heading that causes QDoc's autolinker to link incorrectly.
* Clean up language a bit while at it.
* Drop a double space.

Fixes: QTBUG-89283
Pick-to: 6.0
Change-Id: Ice778d66deab384b66eb50b790670c9e3c8b0e84
Reviewed-by: Andreas Buhr <andreas.buhr@qt.io>
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
This commit is contained in:
Paul Wicking 2020-12-10 11:00:54 +01:00
parent 30811f6428
commit 98292b369e

View File

@ -42,10 +42,7 @@
guidance to handle them. guidance to handle them.
\section1 Simple API for XML (SAX) parser \section1 Simple API for XML (SAX) parser
All \b SAX classes have been removed from Qt XML. Use
\section2 QXmlStreamReader
In Qt6, all \c SAX classes have been removed from Qt XML, please use
QXmlStreamReader for reading XML files. Here are some simple steps to QXmlStreamReader for reading XML files. Here are some simple steps to
port your current code to QXmlStreamReader: port your current code to QXmlStreamReader:
@ -77,27 +74,27 @@
} }
\endcode \endcode
\section2 QDom and QDomDocument \section2 QDom and QDomDocument
In Qt6, \c SAX classes have been removed and therefore QDomDocument As \b SAX classes have been removed from Qt XML, QDomDocument
cannot use them anymore. That's why it has been re-implemented using has been re-implemented using QXmlStreamReader.
the QXmlStreamReader. This brings a few behavioral changes: This causes a few behavioral changes:
\list \list
\li Attribute values will be normalized. For example \li Attribute values will be normalized. For example,
\c{<tag attr=" a \n b " />} will be equivalent to \c{<tag attr="a b"/>}. \c{<tag attr=" a \n b " />} is equivalent to \c{<tag attr="a b"/>}.
\li Identical qualified attribute names won't be allowed anymore, i.e. \li Identical qualified attribute names are no longer allowed. This
attributes of an element must have unique names. means attributes of an element must have unique names.
\li Undeclared namespace prefixes won't be allowed anymore. \li Undeclared namespace prefixes are no longer allowed.
\endlist \endlist
If you are using QDomDocument and relying on any of these, please update If you use QDomDocument and rely on any of these, you must update
your code and XML documents accordingly. your code and XML documents accordingly.
\section2 Qt Core5 compatibility library \section2 Qt Core5 compatibility library
If your application or library cannot be ported right now, the \l If your application or library cannot be ported right now, the \l
QXmlSimpleReader and related classes do still exist in Qt5Compat to keep QXmlSimpleReader and related classes still exist in Qt5Compat to keep
old code-bases working. If you want to use those SAX classes further, you old code-bases working. If you want to use those SAX classes further, you
need to link against the new Qt5Compat module and add this line to your \l need to link against the new Qt5Compat module and add this line to your \l
qmake \c .pro file: qmake \c .pro file: