From 666a94d7758e466e044bafa943b2c252ef4b5228 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 3 Jan 2011 15:11:09 +0100
Subject: qdoc: Added format="html" to every <xref> for http.
---
tools/qdoc3/ditaxmlgenerator.cpp | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 7b40886..1deafda 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -331,6 +331,7 @@ void DitaXmlGenerator::addLink(const QString& href,
{
if (!href.isEmpty()) {
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href", href);
writeCharacters(text.toString());
xmlWriter().writeEndElement(); // </xref>
@@ -1026,6 +1027,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
xmlWriter().writeStartElement("p");
xmlWriter().writeCharacters("Class ");
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",linkForNode(pmap.key(), 0));
QStringList pieces = fullName(pmap.key(), 0, marker).split("::");
writeCharacters(protectEnc(pieces.last()));
@@ -2001,6 +2003,7 @@ void DitaXmlGenerator::writeXrefListItem(const QString& link, const QString& tex
{
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",link);
writeCharacters(text);
xmlWriter().writeEndElement(); // </xref>
@@ -2777,6 +2780,7 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
QChar ch('a' + i);
if (usedParagraphNames.contains(char('a' + i))) {
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
@@ -2836,6 +2840,7 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
require some special formatting.
*/
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",linkForNode(it.value(), relative));
QStringList pieces;
@@ -2870,6 +2875,7 @@ void DitaXmlGenerator::generateFunctionIndex(const Node* relative,
for (int i = 0; i < 26; i++) {
QChar ch('a' + i);
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
@@ -3050,6 +3056,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
xmlWriter().writeStartElement("p");
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",linkForNode(groupNode, relative));
writeCharacters(protectEnc(groupNode->fullTitle()));
xmlWriter().writeEndElement(); // </xref>
@@ -3064,6 +3071,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
title.remove(0, 4);
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
xmlWriter().writeEndElement(); // </xref>
@@ -3085,6 +3093,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
title.remove(0, 4);
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
xmlWriter().writeEndElement(); // </xref>
@@ -3143,6 +3152,7 @@ void DitaXmlGenerator::generateSectionInheritedList(const Section& section,
text += " inherited from ";
writeCharacters(text);
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
// zzz
text = fileName((*p).first) + "#";
text += DitaXmlGenerator::cleanRef(section.name.toLower());
@@ -3718,6 +3728,7 @@ void DitaXmlGenerator::generateFullName(const Node* apparentNode,
if (actualNode == 0)
actualNode = apparentNode;
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
QString href = linkForNode(actualNode, relative);
xmlWriter().writeAttribute("href",href);
writeCharacters(protectEnc(fullName(apparentNode, relative, marker)));
@@ -4146,6 +4157,7 @@ void DitaXmlGenerator::beginLink(const QString& link)
if (link.isEmpty())
return;
xmlWriter().writeStartElement("xref");
+ xmlWriter().writeAttribute("format", "html");
xmlWriter().writeAttribute("href",link);
inLink = true;
}
--
cgit v0.12
From 527ad2dde3379e42d8831783c37c470e0f23a2f1 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 4 Jan 2011 11:19:38 +0100
Subject: qdoc: Changed <bodydiv> to <sectiondiv>.
Removed format="html" from the <xref> because
it didn't work. Investigating further.
---
tools/qdoc3/ditaxmlgenerator.cpp | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 1deafda..1595f72 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -331,7 +331,7 @@ void DitaXmlGenerator::addLink(const QString& href,
{
if (!href.isEmpty()) {
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href", href);
writeCharacters(text.toString());
xmlWriter().writeEndElement(); // </xref>
@@ -753,12 +753,12 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
xmlWriter().writeEndElement(); // </codeblock>
break;
case Atom::Div:
- xmlWriter().writeStartElement("bodydiv");
+ xmlWriter().writeStartElement("sectiondiv");
if (!atom->string().isEmpty())
xmlWriter().writeAttribute("outputclass", atom->string());
break;
case Atom::EndDiv:
- xmlWriter().writeEndElement(); // </bodydiv>
+ xmlWriter().writeEndElement(); // </sectiondiv>
break;
case Atom::FootnoteLeft:
// ### For now
@@ -1027,7 +1027,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
xmlWriter().writeStartElement("p");
xmlWriter().writeCharacters("Class ");
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",linkForNode(pmap.key(), 0));
QStringList pieces = fullName(pmap.key(), 0, marker).split("::");
writeCharacters(protectEnc(pieces.last()));
@@ -2003,7 +2003,7 @@ void DitaXmlGenerator::writeXrefListItem(const QString& link, const QString& tex
{
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",link);
writeCharacters(text);
xmlWriter().writeEndElement(); // </xref>
@@ -2780,7 +2780,7 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
QChar ch('a' + i);
if (usedParagraphNames.contains(char('a' + i))) {
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
@@ -2840,7 +2840,7 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
require some special formatting.
*/
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",linkForNode(it.value(), relative));
QStringList pieces;
@@ -2875,7 +2875,7 @@ void DitaXmlGenerator::generateFunctionIndex(const Node* relative,
for (int i = 0; i < 26; i++) {
QChar ch('a' + i);
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
@@ -3056,7 +3056,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
xmlWriter().writeStartElement("p");
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",linkForNode(groupNode, relative));
writeCharacters(protectEnc(groupNode->fullTitle()));
xmlWriter().writeEndElement(); // </xref>
@@ -3071,7 +3071,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
title.remove(0, 4);
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
xmlWriter().writeEndElement(); // </xref>
@@ -3093,7 +3093,7 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
title.remove(0, 4);
xmlWriter().writeStartElement("li");
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
xmlWriter().writeEndElement(); // </xref>
@@ -3152,7 +3152,7 @@ void DitaXmlGenerator::generateSectionInheritedList(const Section& section,
text += " inherited from ";
writeCharacters(text);
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
// zzz
text = fileName((*p).first) + "#";
text += DitaXmlGenerator::cleanRef(section.name.toLower());
@@ -3728,7 +3728,7 @@ void DitaXmlGenerator::generateFullName(const Node* apparentNode,
if (actualNode == 0)
actualNode = apparentNode;
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
QString href = linkForNode(actualNode, relative);
xmlWriter().writeAttribute("href",href);
writeCharacters(protectEnc(fullName(apparentNode, relative, marker)));
@@ -4157,7 +4157,7 @@ void DitaXmlGenerator::beginLink(const QString& link)
if (link.isEmpty())
return;
xmlWriter().writeStartElement("xref");
- xmlWriter().writeAttribute("format", "html");
+ // formathtml
xmlWriter().writeAttribute("href",link);
inLink = true;
}
--
cgit v0.12
From 04a3fdb6a243e00b809d3e81264fce077121862b Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 4 Jan 2011 14:54:26 +0100
Subject: qdoc: Replaced many raw-html cases with \div {something}.
---
doc/src/development/designer-manual.qdoc | 96 ++++++++++----------------------
doc/src/template/style/style.css | 12 ++++
2 files changed, 42 insertions(+), 66 deletions(-)
diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc
index df82fba..e5f3b99 100644
--- a/doc/src/development/designer-manual.qdoc
+++ b/doc/src/development/designer-manual.qdoc
@@ -1385,17 +1385,13 @@
\target CreatingAMenu
- \raw HTML
- <div style="float: left; margin-right: 2em">
- \endraw
+ \div {float-left}
\inlineimage designer-creating-menu1.png
\inlineimage designer-creating-menu2.png
\br
\inlineimage designer-creating-menu3.png
\inlineimage designer-creating-menu4.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 Creating a Menu
@@ -1410,9 +1406,8 @@
\key Escape to reject it. You can undo the editing operation later if
required.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
Menus can also be rearranged in the menu bar simply by dragging and
dropping them in the preferred location. A vertical red line indicates the
@@ -1423,17 +1418,13 @@
navigating the menu structure in the usual way.
\target CreatingAMenuEntry
- \raw HTML
- <div style="float: right; margin-left: 2em">
- \endraw
+ \div {float-right}
\inlineimage designer-creating-menu-entry1.png
\inlineimage designer-creating-menu-entry2.png
\br
\inlineimage designer-creating-menu-entry3.png
\inlineimage designer-creating-menu-entry4.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 Creating a Menu Entry
@@ -1453,9 +1444,8 @@
be accessible via the \l{#TheActionEditor}{Action Editor}, and any
associated keyboard shortcut can be set there.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
Just like with menus, entries can be moved around simply by dragging and
dropping them in the preferred location. When an entry is dragged over a
@@ -1465,13 +1455,9 @@
\section1 Toolbars
- \raw HTML
- <div style="float: left; margin-right: 2em">
- \endraw
+ \div {float-left}
\inlineimage designer-creating-toolbar.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 Creating and Removing a Toolbar
@@ -1483,9 +1469,8 @@
Toolbars are removed from the form via an entry in the toolbar's context
menu.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
\section2 Adding and Removing Toolbar Buttons
@@ -1494,14 +1479,10 @@
Since actions can be represented by menu entries and toolbar buttons,
they can be moved between menus and toolbars.
- \raw HTML
- <div style="float: right; margin-left: 2em">
- \endraw
+ \div {float-right}
\inlineimage designer-adding-toolbar-action.png
\inlineimage designer-removing-toolbar-action.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
To share an action between a menu and a toolbar, drag its icon from the
action editor to the toolbar rather than from the menu where its entry is
@@ -1510,9 +1491,8 @@
Toolbar buttons are removed via the toolbar's context menu.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
\section1 Actions
@@ -1521,13 +1501,9 @@
action editor window, simplifying the creation and management of actions.
\target TheActionEditor
- \raw HTML
- <div style="float: left; margin-right: 2em">
- \endraw
+ \div {float-left}
\inlineimage designer-action-editor.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 The Action Editor
@@ -1543,9 +1519,8 @@
\gui{Detailed View}. You can also copy and paste actions between menus,
toolbars and forms.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
\section2 Creating an Action
@@ -1560,19 +1535,14 @@
Once the action is created, it can be used wherever actions are applicable.
- \raw HTML
- <div style="clear: left" />
- \endraw
+ \div {clear-left}
+ \enddiv
\target AddingAnAction
- \raw HTML
- <div style="float: right; margin-left: 2em">
- \endraw
+ \div {float-right}
\inlineimage designer-adding-menu-action.png
\inlineimage designer-adding-toolbar-action.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 Adding an Action
@@ -1584,9 +1554,8 @@
will be added. Release the mouse button to add the action when you have
found the right spot.
- \raw HTML
- <div style="clear: right" />
- \endraw
+ \div {clear-right}
+ \enddiv
\section1 Dock Widgets
@@ -1598,13 +1567,9 @@
\target AddingADockWidget
- \raw HTML
- <div style="float: left; margin-right: 2em">
- \endraw
+ \div {float-left}
\inlineimage designer-adding-dockwidget.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
\section2 Adding a Dock Widget
@@ -1623,9 +1588,8 @@
\l{QDockWidget::}{windowTitle} property. This also helps to identify them on the
form.
- \raw HTML
- <div style="clear: both" />
- \endraw
+ \div {clear-both}
+ \enddiv
*/
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index d623bd4..4005a8a 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -185,6 +185,18 @@
{
float: right; margin-left: 2em
}
+ div.clear-both
+ {
+ clear: both
+ }
+ div.clear-left
+ {
+ clear: left
+ }
+ div.clear-right
+ {
+ clear: right
+ }
span.comment
{
--
cgit v0.12
From e3a3ae24e54a4461498ae8185b89bdf429e68574 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 5 Jan 2011 12:07:20 +0100
Subject: qdoc: Replaced many raw-html cases with \div {something}.
---
doc/src/tutorials/widgets-tutorial.qdoc | 82 ++++++++++++---------------------
1 file changed, 29 insertions(+), 53 deletions(-)
diff --git a/doc/src/tutorials/widgets-tutorial.qdoc b/doc/src/tutorials/widgets-tutorial.qdoc
index df911a5..42c8852 100644
--- a/doc/src/tutorials/widgets-tutorial.qdoc
+++ b/doc/src/tutorials/widgets-tutorial.qdoc
@@ -133,19 +133,13 @@
In the following example, we use QWidget to create and show a window with
a default size:
- \raw HTML
- <table align="left" width="100%">
- <tr class="qt-code"><td>
- \endraw
- \snippet tutorials/widgets/toplevel/main.cpp main program
- \raw HTML
- </td><td align="right">
- \endraw
- \inlineimage widgets-tutorial-toplevel.png
- \raw HTML
- </td></tr>
- </table>
- \endraw
+ \div {qt-code}
+ \table
+ \row
+ \o \snippet tutorials/widgets/toplevel/main.cpp main program
+ \o \inlineimage widgets-tutorial-toplevel.png
+ \endtable
+ \enddiv
To create a real GUI, we need to place widgets inside the window. To do
this, we pass a QWidget instance to a widget's constructor, as we will
@@ -161,19 +155,13 @@
passing \c window as the parent to its constructor. In this case, we add a
button to the window and place it in a specific location:
- \raw HTML
- <table align="left" width="100%">
- <tr class="qt-code"><td>
- \endraw
- \snippet tutorials/widgets/childwidget/main.cpp main program
- \raw HTML
- </td><td align="right">
- \endraw
- \inlineimage widgets-tutorial-childwidget.png
- \raw HTML
- </td></tr>
- </table>
- \endraw
+ \div {qt-code}
+ \table
+ \row
+ \o \snippet tutorials/widgets/childwidget/main.cpp main program
+ \o \inlineimage widgets-tutorial-childwidget.png
+ \endtable
+ \enddiv
The button is now a child of the window and will be deleted when the
window is destroyed. Note that hiding or closing the window does not
@@ -189,19 +177,13 @@
construct a label and line edit widget that we would like to arrange
side-by-side.
- \raw HTML
- <table align="left" width="100%">
- <tr class="qt-code"><td>
- \endraw
- \snippet tutorials/widgets/windowlayout/main.cpp main program
- \raw HTML
- </td><td align="right">
- \endraw
- \inlineimage widgets-tutorial-windowlayout.png
- \raw HTML
- </td></tr>
- </table>
- \endraw
+ \div {qt-code}
+ \table
+ \row
+ \o \snippet tutorials/widgets/windowlayout/main.cpp main program
+ \o \inlineimage widgets-tutorial-windowlayout.png
+ \endtable
+ \enddiv
The \c layout object we construct manages the positions and sizes of
widgets supplied to it with the \l{QHBoxLayout::}{addWidget()} function.
@@ -233,20 +215,14 @@
\c{mainLayout} is a QVBoxLayout that contains \c{queryLayout} and a
QTableView arranged vertically.
- \raw HTML
- <table align="left" width="100%">
- <tr class="qt-code"><td>
- \endraw
- \snippet tutorials/widgets/nestedlayouts/main.cpp first part
- \snippet tutorials/widgets/nestedlayouts/main.cpp last part
- \raw HTML
- </td><td align="right">
- \endraw
- \inlineimage widgets-tutorial-nestedlayouts.png
- \raw HTML
- </td></tr>
- </table>
- \endraw
+ \div {qt-code}
+ \table
+ \row
+ \o \snippet tutorials/widgets/nestedlayouts/main.cpp first part
+ \snippet tutorials/widgets/nestedlayouts/main.cpp last part
+ \o \inlineimage widgets-tutorial-nestedlayouts.png
+ \endtable
+ \enddiv
Note that we call the \c{mainLayout}'s \l{QBoxLayout::}{addLayout()}
function to insert the \c{queryLayout} above the \c{resultView} table.
--
cgit v0.12
From f9400e81d6e817eb16651e01bb3710cf8562c926 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 7 Jan 2011 08:32:24 +0100
Subject: qdoc: Replaced many raw-html cases with \div {something}.
---
doc/src/template/style/style.css | 92 ++++++++++++++++++++++++++++++++++++--
src/corelib/global/qnamespace.qdoc | 90 +++++++------------------------------
tools/qdoc3/atom.cpp | 7 +--
tools/qdoc3/atom.h | 40 ++++++++---------
tools/qdoc3/ditaxmlgenerator.cpp | 4 +-
tools/qdoc3/doc.cpp | 50 +++++++++++++++------
tools/qdoc3/htmlgenerator.cpp | 16 ++++---
7 files changed, 178 insertions(+), 121 deletions(-)
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index 4005a8a..5f60199 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -198,6 +198,92 @@
clear: right
}
+ #color-white
+ {
+ background: #ffffff;
+ color: #000000;
+ }
+ #color-black
+ {
+ background: #000000;
+ color: #ffffff;
+ }
+ #color-red
+ {
+ background: #ff0000;
+ color: #000000;
+ }
+ #color-darkRed
+ {
+ background: #800000;
+ color: #ffffff;
+ }
+ #color-green
+ {
+ background: #00ff00;
+ color: #000000;
+ }
+ #color-darkGreen
+ {
+ background: #008000;
+ color: #ffffff;
+ }
+ #color-blue
+ {
+ background: #0000ff;
+ color: #ffffff;
+ }
+ #color-darkBlue
+ {
+ background: #000080;
+ color: #ffffff;
+ }
+ #color-cyan
+ {
+ background: #00ffff;
+ color: #000000;
+ }
+ #color-darkCyan
+ {
+ background: #008080;
+ color: #ffffff;
+ }
+ #color-magenta
+ {
+ background: #ff00ff;
+ color: #000000;
+ }
+ #color-darkMagenta
+ {
+ background: #800080;
+ color: #ffffff;
+ }
+ #color-yellow
+ {
+ background: #ffff00;
+ color: #000000;
+ }
+ #color-darkYellow
+ {
+ background: #808000;
+ color: #ffffff;
+ }
+ #color-gray
+ {
+ background: #a0a0a4;
+ color: #000000;
+ }
+ #color-darkGray
+ {
+ background: #808080;
+ color: #ffffff;
+ }
+ #color-lightGray
+ {
+ background: #c0c0c0;
+ color: #000000;
+ }
+
span.comment
{
color: #008B00;
@@ -526,7 +612,7 @@
background: url(../images/page.png) no-repeat 100% -60px;
overflow: hidden;
}
- .navTop{
+ .navTop{
float:right;
display:block;
padding-right:15px;
@@ -1590,11 +1676,11 @@
word-wrap:break-word;
}
- .creator .wrap .content ol li {
+ .creator .wrap .content ol li {
background:none;
font: inherit;
padding-left: 0px;
- }
+ }
.creator .wrap .content .descr ol li {
margin-left: 45px;
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 6b1aa17..060b979 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -231,81 +231,25 @@
/*!
\enum Qt::GlobalColor
- \raw HTML
- <style type="text/css" id="colorstyles">
- #white { background-color: #ffffff; color: #000000 }
- #black { background-color: #000000; color: #ffffff }
- #red { background-color: #ff0000; color: #000000 }
- #darkRed { background-color: #800000; color: #ffffff }
- #green { background-color: #00ff00; color: #000000 }
- #darkGreen { background-color: #008000; color: #ffffff }
- #blue { background-color: #0000ff; color: #ffffff }
- #darkBlue { background-color: #000080; color: #ffffff }
- #cyan { background-color: #00ffff; color: #000000 }
- #darkCyan { background-color: #008080; color: #ffffff }
- #magenta { background-color: #ff00ff; color: #000000 }
- #darkMagenta { background-color: #800080; color: #ffffff }
- #yellow { background-color: #ffff00; color: #000000 }
- #darkYellow { background-color: #808000; color: #ffffff }
- #gray { background-color: #a0a0a4; color: #000000 }
- #darkGray { background-color: #808080; color: #ffffff }
- #lightGray { background-color: #c0c0c0; color: #000000 }
- </style>
- \endraw
-
Qt's predefined QColor objects:
- \value white \raw HTML
- White <tt id="white">(#ffffff)</tt>
- \endraw
- \value black \raw HTML
- Black <tt id="black">(#000000)</tt>
- \endraw
- \value red \raw HTML
- Red <tt id="red">(#ff0000)</tt>
- \endraw
- \value darkRed \raw HTML
- Dark red <tt id="darkRed">(#800000)</tt>
- \endraw
- \value green \raw HTML
- Green <tt id="green">(#00ff00)</tt>
- \endraw
- \value darkGreen \raw HTML
- Dark green <tt id="darkGreen">(#008000)</tt>
- \endraw
- \value blue \raw HTML
- Blue <tt id="blue">(#0000ff)</tt>
- \endraw
- \value darkBlue \raw HTML
- Dark blue <tt id="darkBlue">(#000080)</tt>
- \endraw
- \value cyan \raw HTML
- Cyan <tt id="cyan">(#00ffff)</tt>
- \endraw
- \value darkCyan \raw HTML
- Dark cyan <tt id="darkCyan">(#008080)</tt>
- \endraw
- \value magenta \raw HTML
- Magenta <tt id="magenta">(#ff00ff)</tt>
- \endraw
- \value darkMagenta \raw HTML
- Dark magenta <tt id="darkMagenta">(#800080)</tt>
- \endraw
- \value yellow \raw HTML
- Yellow <tt id="yellow">(#ffff00)</tt>
- \endraw
- \value darkYellow \raw HTML
- Dark yellow <tt id="darkYellow">(#808000)</tt>
- \endraw
- \value gray \raw HTML
- Gray <tt id="gray">(#a0a0a4)</tt>
- \endraw
- \value darkGray \raw HTML
- Dark gray <tt id="darkGray">(#808080)</tt>
- \endraw
- \value lightGray \raw HTML
- Light gray <tt id="lightGray">(#c0c0c0)</tt>
- \endraw
+ \value white \div {id="color-white"} White (#ffffff) \enddiv
+ \value black \div {id="color-black"} Black (#000000) \enddiv
+ \value red \div {id="color-red"} Red (#ff0000) \enddiv
+ \value darkRed \div {id="color-darkRed"} Dark red (#800000) \enddiv
+ \value green \div {id="color-green"} Green (#00ff00) \enddiv
+ \value darkGreen \div {id="color-darkGreen"} Dark green (#008000) \enddiv
+ \value blue \div {id="color-blue"} Blue (#0000ff) \enddiv
+ \value darkBlue \div {id="color-darkBlue"} Dark blue (#000080) \enddiv
+ \value cyan \div {id="color-cyan"} Cyan (#00ffff) \enddiv
+ \value darkCyan \div {id="color-darkCyan"} Dark cyan (#008080) \enddiv
+ \value magenta \div {id="color-magenta"} Magenta (#ff00ff) \enddiv
+ \value darkMagenta \div {id="color-darkMagenta"} Dark magenta (#800080) \enddiv
+ \value yellow \div {id="color-yellow"} Yellow (#ffff00) \enddiv
+ \value darkYellow \div {id="color-darkYellow"} Dark yellow (#808000) \enddiv
+ \value gray \div {id="color-gray"} Gray (#a0a0a4) \enddiv
+ \value darkGray \div {id="color-darkGray"} Dark gray (#808080) \enddiv
+ \value lightGray \div {id="color-lightGray"} Light gray (#c0c0c0) \enddiv
\value transparent a transparent black value (i.e., QColor(0, 0, 0, 0))
\value color0 0 pixel value (for bitmaps)
\value color1 1 pixel value (for bitmaps)
diff --git a/tools/qdoc3/atom.cpp b/tools/qdoc3/atom.cpp
index 301244d..ef5b6c8 100644
--- a/tools/qdoc3/atom.cpp
+++ b/tools/qdoc3/atom.cpp
@@ -107,7 +107,8 @@ QString Atom::UPPERROMAN_ ("upperroman");
\value CodeOld
\value CodeQuoteArgument
\value CodeQuoteCommand
- \value Div
+ \value DivLeft
+ \value DivRight
\value EndQmlText
\value FormatElse
\value FormatEndif
@@ -180,8 +181,8 @@ static const struct {
{ "CodeOld", Atom::CodeOld },
{ "CodeQuoteArgument", Atom::CodeQuoteArgument },
{ "CodeQuoteCommand", Atom::CodeQuoteCommand },
- { "Div", Atom::Div },
- { "EndDiv", Atom::EndDiv },
+ { "DivLeft", Atom::DivLeft },
+ { "DivRight", Atom::DivRight },
#ifdef QDOC_QML
{ "EndQmlText", Atom::EndQmlText },
#endif
diff --git a/tools/qdoc3/atom.h b/tools/qdoc3/atom.h
index a20e057..739d8e3 100644
--- a/tools/qdoc3/atom.h
+++ b/tools/qdoc3/atom.h
@@ -72,15 +72,15 @@ class Atom
CodeOld,
CodeQuoteArgument,
CodeQuoteCommand,
- Div,
+ DivLeft, // 16
+ DivRight, // 17
#ifdef QDOC_QML
- EndDiv,
EndQmlText,
#endif
FootnoteLeft,
- FootnoteRight,
+ FootnoteRight, // 20
FormatElse,
- FormatEndif, // 20
+ FormatEndif,
FormatIf,
FormattingLeft,
FormattingRight,
@@ -88,30 +88,30 @@ class Atom
GuidLink,
Image,
ImageText,
- InlineImage,
+ InlineImage, // 30
LegaleseLeft,
- LegaleseRight, // 30
+ LegaleseRight,
LineBreak,
Link,
LinkNode,
ListLeft,
ListItemNumber,
- ListTagLeft, // 36
- ListTagRight, // 37
- ListItemLeft, // 38
- ListItemRight, // 39
- ListRight, // 40
+ ListTagLeft, // 38
+ ListTagRight, // 39
+ ListItemLeft, // 40
+ ListItemRight, // 41
+ ListRight, // 42
Nop,
- ParaLeft,
- ParaRight,
+ ParaLeft, // 44
+ ParaRight, // 45
#ifdef QDOC_QML
Qml,
QmlText,
#endif
QuotationLeft,
QuotationRight,
- RawString,
- SectionLeft, // 49
+ RawString, // 50
+ SectionLeft, // 51
SectionRight,
SectionHeadingLeft,
SectionHeadingRight,
@@ -120,9 +120,9 @@ class Atom
SinceList,
SnippetCommand,
SnippetIdentifier,
- SnippetLocation,
- String, // 59
- TableLeft, // 60
+ SnippetLocation, // 60
+ String, // 61
+ TableLeft, // 62
TableRight,
TableHeaderLeft,
TableHeaderRight,
@@ -130,8 +130,8 @@ class Atom
TableRowRight,
TableItemLeft,
TableItemRight,
- TableOfContents,
- Target, // 69
+ TableOfContents, // 70
+ Target, // 71
UnhandledFormat,
UnknownCommand,
Last = UnknownCommand
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 1595f72..f9c8cc5 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -752,12 +752,12 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
writeCharacters(trimmedTrailing(plainCode(atom->string())));
xmlWriter().writeEndElement(); // </codeblock>
break;
- case Atom::Div:
+ case Atom::DivLeft:
xmlWriter().writeStartElement("sectiondiv");
if (!atom->string().isEmpty())
xmlWriter().writeAttribute("outputclass", atom->string());
break;
- case Atom::EndDiv:
+ case Atom::DivRight:
xmlWriter().writeEndElement(); // </sectiondiv>
break;
case Atom::FootnoteLeft:
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index ce9e30d..4873d8b 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -55,6 +55,7 @@
#include <qregexp.h>
#include <ctype.h>
#include <limits.h>
+#include <qdebug.h>
QT_BEGIN_NAMESPACE
@@ -368,8 +369,8 @@ class DocParser
void appendToCode(const QString &code);
void startNewPara();
void enterPara(Atom::Type leftType = Atom::ParaLeft,
- Atom::Type rightType = Atom::ParaRight,
- const QString& string = "");
+ Atom::Type rightType = Atom::ParaRight,
+ const QString& string = "");
void leavePara();
void leaveValue();
void leaveValueList();
@@ -559,11 +560,26 @@ void DocParser::parse(const QString& source,
break;
#endif
case CMD_DIV:
- leavePara();
x = getArgument(true);
- append(Atom::Div, x);
- openedCommands.push(cmd);
- enterPara();
+ leavePara();
+ enterPara(Atom::DivLeft, Atom::DivRight,x);
+#if 0
+ if (x.contains('=')) {
+ leavePara();
+ enterPara(Atom::DivLeft, Atom::DivRight,x);
+ }
+ else {
+ leavePara();
+ append(Atom::DivLeft, x);
+ openedCommands.push(cmd);
+ enterPara();
+ }
+#endif
+ break;
+ case CMD_ENDDIV:
+ leavePara();
+ // append(Atom::DivRight);
+ // closeCommand(cmd);
break;
case CMD_CODELINE:
{
@@ -632,11 +648,6 @@ void DocParser::parse(const QString& source,
case CMD_ENDCODE:
closeCommand(cmd);
break;
- case CMD_ENDDIV:
- leavePara();
- append(Atom::EndDiv);
- closeCommand(cmd);
- break;
#ifdef QDOC_QML
case CMD_ENDQML:
closeCommand(cmd);
@@ -1806,8 +1817,18 @@ void DocParser::parseAlso()
}
}
+//static bool debug = false;
+
void DocParser::append(Atom::Type type, const QString &string)
{
+#if 0
+ if (type == Atom::DivLeft)
+ debug = true;
+ if (debug)
+ qDebug() << type << string;
+ if (type == Atom::DivRight)
+ debug = false;
+#endif
Atom::Type lastType = priv->text.lastAtom()->type();
#ifdef QDOC_QML
if (((lastType == Atom::Code) || (lastType == Atom::Code)) &&
@@ -1865,15 +1886,16 @@ void DocParser::enterPara(Atom::Type leftType,
const QString& string)
{
if (paraState == OutsidePara) {
- if (priv->text.lastAtom()->type() != Atom::ListItemLeft)
+ if ((priv->text.lastAtom()->type() != Atom::ListItemLeft) &&
+ (priv->text.lastAtom()->type() != Atom::DivLeft)) {
leaveValueList();
+ }
append(leftType, string);
indexStartedPara = false;
pendingParaLeftType = leftType;
pendingParaRightType = rightType;
pendingParaString = string;
- if (
- leftType == Atom::SectionHeadingLeft) {
+ if (leftType == Atom::SectionHeadingLeft) {
paraState = InsideSingleLinePara;
}
else {
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 948a7d6..1ddc0b9 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -511,13 +511,20 @@ int HtmlGenerator::generateAtom(const Atom *atom,
<< trimmedTrailing(protectEnc(plainCode(indent(codeIndent,atom->string()))))
<< "</pre>\n";
break;
- case Atom::Div:
+ case Atom::DivLeft:
out() << "<div";
- if (!atom->string().isEmpty())
- out() << " class=\"" << atom->string() << "\">";
+ if (!atom->string().isEmpty()) {
+ if (atom->string().contains('='))
+ out() << " " << atom->string() << ">";
+ else
+ out() << " class=\"" << atom->string() << "\">";
+ }
else
out() << ">";
break;
+ case Atom::DivRight:
+ out() << "</div>";
+ break;
case Atom::FootnoteLeft:
// ### For now
if (in_para) {
@@ -1136,9 +1143,6 @@ int HtmlGenerator::generateAtom(const Atom *atom,
out() << "<b class=\"redFont\"><code>\\" << protectEnc(atom->string())
<< "</code></b>";
break;
- case Atom::EndDiv:
- out() << "</div>";
- break;
#ifdef QDOC_QML
case Atom::QmlText:
case Atom::EndQmlText:
--
cgit v0.12
From de01273493d6380ec8eaa2cc801dbe8939788d00 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 12 Jan 2011 09:28:22 +0100
Subject: qdoc: Replaced many raw-html cases with \div {something}.
Only 27 raw-html uses remaining.
---
tools/qdoc3/ditaxmlgenerator.cpp | 1665 +++++++++++++++++++-------------------
tools/qdoc3/ditaxmlgenerator.h | 151 +++-
tools/qdoc3/generator.cpp | 1 +
3 files changed, 981 insertions(+), 836 deletions(-)
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index f9c8cc5..e99af42 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -66,226 +66,6 @@ bool DitaXmlGenerator::inSection = false;
bool DitaXmlGenerator::inDetailedDescription = false;
bool DitaXmlGenerator::inLegaleseText = false;
-#define cxxapi_d_xref Doc::alias("cxxapi-d-xref")
-#define cxxclass Doc::alias("cxxclass")
-#define cxxdefine Doc::alias("cxxdefine")
-#define cxxenumeration Doc::alias("cxxenumeration")
-#define cxxfile Doc::alias("cxxfile")
-#define cxxfunction Doc::alias("cxxfunction")
-#define cxxstruct Doc::alias("cxxstruct")
-#define cxxtypedef Doc::alias("cxxtypedef")
-#define cxxunion Doc::alias("cxxunion")
-#define cxxvariable Doc::alias("cxxvariable")
-
-#define CXXAPIMAP Doc::alias("cxxAPIMap")
-#define CXXCLASSREF Doc::alias("cxxClassRef")
-#define CXXDEFINEREF Doc::alias("cxxDefineRef")
-#define CXXENUMERATIONREF Doc::alias("cxxEnumerationRef")
-#define CXXFILEREF Doc::alias("cxxFileRef")
-#define CXXFUNCTIONREF Doc::alias("cxxFunctionRef")
-#define CXXSTRUCTREF Doc::alias("cxxStructRef")
-#define CXXTYPDEFREF Doc::alias("cxxTypedefRef")
-#define CXXUNIONREF Doc::alias("cxxUnionRef")
-#define CXXVARIABLEREF Doc::alias("cxxVariableRef")
-
-#define CXXCLASS Doc::alias("cxxClass")
-#define CXXCLASSABSTRACT Doc::alias("cxxClassAbstract")
-#define CXXCLASSACCESSSPECIFIER Doc::alias("cxxClassAccessSpecifier")
-#define CXXCLASSAPIITEMLOCATION Doc::alias("cxxClassAPIItemLocation")
-#define CXXCLASSBASECLASS Doc::alias("cxxClassBaseClass")
-#define CXXCLASSBASECLASSSTRUCT Doc::alias("cxxClassBaseStruct")
-#define CXXCLASSBASEUNION Doc::alias("cxxClassBaseUnion")
-#define CXXCLASSDECLARATIONFILE Doc::alias("cxxClassDeclarationFile")
-#define CXXCLASSDECLARATIONFILELINE Doc::alias("cxxClassDeclarationFileLine")
-#define CXXCLASSDEFINITION Doc::alias("cxxClassDefinition")
-#define CXXCLASSDEFINITIONFILE Doc::alias("cxxClassDefinitionFile")
-#define CXXCLASSDEFINITIONFILEEND Doc::alias("cxxClassDefinitionFileLineEnd")
-#define CXXCLASSDEFINITIONFILESTART Doc::alias("cxxClassDefinitionFileLineStart")
-#define CXXCLASSDERIVATION Doc::alias("cxxClassDerivation")
-#define CXXCLASSDERIVATIONACCESSSPECIFIER Doc::alias("cxxClassDerivationAccessSpecifier")
-#define CXXCLASSDERIVATIONS Doc::alias("cxxClassDerivations")
-#define CXXCLASSDERIVATIONVIRTUAL Doc::alias("cxxClassDerivationVirtual")
-#define CXXCLASSDETAIL Doc::alias("cxxClassDetail")
-#define CXXCLASSENUMERATIONINHERITED Doc::alias("cxxClassEnumerationInherited")
-#define CXXCLASSENUMERATORINHERITED Doc::alias("cxxClassEnumeratorInherited")
-#define CXXCLASSFUNCTIONINHERITED Doc::alias("cxxClassFunctionInherited")
-#define CXXCLASSINHERITS Doc::alias("cxxClassInherits")
-#define CXXCLASSINHERITSDETAIL Doc::alias("cxxClassInheritsDetail")
-#define CXXCLASSNESTED Doc::alias("cxxClassNested")
-#define CXXCLASSNESTEDCLASS Doc::alias("cxxClassNestedClass")
-#define CXXCLASSNESTEDDETAIL Doc::alias("cxxClassNestedDetail")
-#define CXXCLASSNESTEDSTRUCT Doc::alias("cxxClassNestedStruct")
-#define CXXCLASSNESTEDUNION Doc::alias("cxxClassNestedUnion")
-#define CXXCLASSTEMPLATEPARAMETER Doc::alias("cxxClassTemplateParameter")
-#define CXXCLASSTEMPLATEPARAMETERS Doc::alias("cxxClassTemplateParameters")
-#define CXXCLASSTEMPLATEPARAMETERTYPE Doc::alias("cxxClassTemplateParameterType")
-#define CXXCLASSVARIABLEINHERITED Doc::alias("cxxClassVariableInherited")
-
-#define CXXDEFINE Doc::alias("cxxDefine")
-#define CXXDEFINEACCESSSPECIFIER Doc::alias("cxxDefineAccessSpecifier")
-#define CXXDEFINEAPIITEMLOCATION Doc::alias("cxxDefineAPIItemLocation")
-#define CXXDEFINEDECLARATIONFILE Doc::alias("cxxDefineDeclarationFile")
-#define CXXDEFINEDECLARATIONFILELINE Doc::alias("cxxDefineDeclarationFileLine")
-#define CXXDEFINEDEFINITION Doc::alias("cxxDefineDefinition")
-#define CXXDEFINEDETAIL Doc::alias("cxxDefineDetail")
-#define CXXDEFINENAMELOOKUP Doc::alias("cxxDefineNameLookup")
-#define CXXDEFINEPARAMETER Doc::alias("cxxDefineParameter")
-#define CXXDEFINEPARAMETERDECLARATIONNAME Doc::alias("cxxDefineParameterDeclarationName")
-#define CXXDEFINEPARAMETERS Doc::alias("cxxDefineParameters")
-#define CXXDEFINEPROTOTYPE Doc::alias("cxxDefinePrototype")
-#define CXXDEFINEREIMPLEMENTED Doc::alias("cxxDefineReimplemented")
-
-#define CXXENUMERATION Doc::alias("cxxEnumeration")
-#define CXXENUMERATIONACCESSSPECIFIER Doc::alias("cxxEnumerationAccessSpecifier")
-#define CXXENUMERATIONAPIITEMLOCATION Doc::alias("cxxEnumerationAPIItemLocation")
-#define CXXENUMERATIONDECLARATIONFILE Doc::alias("cxxEnumerationDeclarationFile")
-#define CXXENUMERATIONDECLARATIONFILELINE Doc::alias("cxxEnumerationDeclarationFileLine")
-#define CXXENUMERATIONDEFINITION Doc::alias("cxxEnumerationDefinition")
-#define CXXENUMERATIONDEFINITIONFILE Doc::alias("cxxEnumerationDefinitionFile")
-#define CXXENUMERATIONDEFINITIONFILELINEEND Doc::alias("cxxEnumerationDefinitionFileLineEnd")
-#define CXXENUMERATIONDEFINITIONFILELINESTART Doc::alias("cxxEnumerationDefinitionFileLineStart")
-#define CXXENUMERATIONDETAIL Doc::alias("cxxEnumerationDetail")
-#define CXXENUMERATIONNAMELOOKUP Doc::alias("cxxEnumerationNameLookup")
-#define CXXENUMERATIONPROTOTYPE Doc::alias("cxxEnumerationPrototype")
-#define CXXENUMERATIONREIMPLEMENTED Doc::alias("cxxEnumerationReimplemented")
-#define CXXENUMERATIONSCOPEDNAME Doc::alias("cxxEnumerationScopedName")
-#define CXXENUMERATOR Doc::alias("cxxEnumerator")
-#define CXXENUMERATORAPIITEMLOCATION Doc::alias("cxxEnumeratorAPIItemLocation")
-#define CXXENUMERATORDECLARATIONFILE Doc::alias("cxxEnumeratorDeclarationFile")
-#define CXXENUMERATORDECLARATIONFILELINE Doc::alias("cxxEnumeratorDeclarationFileLine")
-#define CXXENUMERATORINITIALISER Doc::alias("cxxEnumeratorInitialiser")
-#define CXXENUMERATORNAMELOOKUP Doc::alias("cxxEnumeratorNameLookup")
-#define CXXENUMERATORPROTOTYPE Doc::alias("cxxEnumeratorPrototype")
-#define CXXENUMERATORS Doc::alias("cxxEnumerators")
-#define CXXENUMERATORSCOPEDNAME Doc::alias("cxxEnumeratorScopedName")
-
-#define CXXFILE_INFO_TYPES Doc::alias("cxxFile-info-types")
-#define CXXFILE_TYPES_DEFAULT Doc::alias("cxxFile-types-default")
-#define CXXFILE Doc::alias("cxxFile")
-#define CXXFILEAPIITMELOCATION Doc::alias("cxxFileAPIItemLocation")
-#define CXXFILEDECLARATIONFILE Doc::alias("cxxFileDeclarationFile")
-
-#define CXXFUNCTION Doc::alias("cxxFunction")
-#define CXXFUNCTIONACCESSSPECIFIER Doc::alias("cxxFunctionAccessSpecifier")
-#define CXXFUNCTIONAPIITEMLOCATION Doc::alias("cxxFunctionAPIItemLocation")
-#define CXXFUNCTIONCONST Doc::alias("cxxFunctionConst")
-#define CXXFUNCTIONCONSTRUCTOR Doc::alias("cxxFunctionConstructor")
-#define CXXFUNCTIONDECLARATIONFILE Doc::alias("cxxFunctionDeclarationFile")
-#define CXXFUNCTIONDECLARATIONFILELINE Doc::alias("cxxFunctionDeclarationFileLine")
-#define CXXFUNCTIONDECLAREDTYPE Doc::alias("cxxFunctionDeclaredType")
-#define CXXFUNCTIONDEFINITION Doc::alias("cxxFunctionDefinition")
-#define CXXFUNCTIONDEFINITIONFILE Doc::alias("cxxFunctionDefinitionFile")
-#define CXXFUNCTIONDEFINITIONFILELINEEND Doc::alias("cxxFunctionDefinitionFileLineEnd")
-#define CXXFUNCTIONDEFINITIONFILELINESTART Doc::alias("cxxFunctionDefinitionFileLineStart")
-#define CXXFUNCTIONDESTRUCTOR Doc::alias("cxxFunctionDestructor")
-#define CXXFUNCTIONDETAIL Doc::alias("cxxFunctionDetail")
-#define CXXFUNCTIONEXPLICIT Doc::alias("cxxFunctionExplicit")
-#define CXXFUNCTIONINLINE Doc::alias("cxxFunctionInline")
-#define CXXFUNCTIONNAMELOOKUP Doc::alias("cxxFunctionNameLookup")
-#define CXXFUNCTIONPARAMETER Doc::alias("cxxFunctionParameter")
-#define CXXFUNCTIONPARAMETERDECLARATIONNAME Doc::alias("cxxFunctionParameterDeclarationName")
-#define CXXFUNCTIONPARAMETERDECLAREDTYPE Doc::alias("cxxFunctionParameterDeclaredType")
-#define CXXFUNCTIONPARAMETERDEFAULTVALUE Doc::alias("cxxFunctionParameterDefaultValue")
-#define CXXFUNCTIONPARAMETERDEFINITIONNAME Doc::alias("cxxFunctionParameterDefinitionName")
-#define CXXFUNCTIONPARAMETERS Doc::alias("cxxFunctionParameters")
-#define CXXFUNCTIONPROTOTYPE Doc::alias("cxxFunctionPrototype")
-#define CXXFUNCTIONPUREVIRTUAL Doc::alias("cxxFunctionPureVirtual")
-#define CXXFUNCTIONREIMPLEMENTED Doc::alias("cxxFunctionReimplemented")
-#define CXXFUNCTIONRETURNTYPE Doc::alias("cxxFunctionReturnType")
-#define CXXFUNCTIONSCOPEDNAME Doc::alias("cxxFunctionScopedName")
-#define CXXFUNCTIONSTORAGECLASSSPECIFIEREXTERN Doc::alias("cxxFunctionStorageClassSpecifierExtern")
-#define CXXFUNCTIONSTORAGECLASSSPECIFIERMUTABLE Doc::alias("cxxFunctionStorageClassSpecifierMutable")
-#define CXXFUNCTIONSTORAGECLASSSPECIFIERSTATIC Doc::alias("cxxFunctionStorageClassSpecifierStatic")
-#define CXXFUNCTIONTEMPLATEPARAMETER Doc::alias("cxxFunctionTemplateParameter")
-#define CXXFUNCTIONTEMPLATEPARAMETERS Doc::alias("cxxFunctionTemplateParameters")
-#define CXXFUNCTIONTEMPLATEPARAMETERTYPE Doc::alias("cxxFunctionTemplateParameterType")
-#define CXXFUNCTIONVIRTUAL Doc::alias("cxxFunctionVirtual")
-#define CXXFUNCTIONVOLATILE Doc::alias("cxxFunctionVolatile")
-
-#define CXXSTRUCT Doc::alias("cxxStruct")
-#define CXXSTRUCTABSTRACT Doc::alias("cxxStructAbstract")
-#define CXXSTRUCTACCESSSPECIFIER Doc::alias("cxxStructAccessSpecifier")
-#define CXXSTRUCTAPIITEMLOCATION Doc::alias("cxxStructAPIItemLocation")
-#define CXXSTRUCTBASECLASS Doc::alias("cxxStructBaseClass")
-#define CXXSTRUCTBASESTRUCT Doc::alias("cxxStructBaseStruct")
-#define CXXSTRUCTBASEUNION Doc::alias("cxxStructBaseUnion")
-#define CXXSTRUCTDECLARATIONFILE Doc::alias("cxxStructDeclarationFile")
-#define CXXSTRUCTDECLARATIONFILELINE Doc::alias("cxxStructDeclarationFileLine")
-#define CXXSTRUCTDEFINITION Doc::alias("cxxStructDefinition")
-#define CXXSTRUCTDEFINITIONFILE Doc::alias("cxxStructDefinitionFile")
-#define CXXSTRUCTDEFINITIONFILELINEEND Doc::alias("cxxStructDefinitionFileLineEnd")
-#define CXXSTRUCTDEFINITIONFILELINESTART Doc::alias("cxxStructDefinitionFileLineStart")
-#define CXXSTRUCTDERIVATION Doc::alias("cxxStructDerivation")
-#define CXXSTRUCTDERIVATIONACCESSSPECIFIER Doc::alias("cxxStructDerivationAccessSpecifier")
-#define CXXSTRUCTDERIVATIONS Doc::alias("cxxStructDerivations")
-#define CXXSTRUCTDERIVATIONVIRTUAL Doc::alias("cxxStructDerivationVirtual")
-#define CXXSTRUCTDETAIL Doc::alias("cxxStructDetail")
-#define CXXSTRUCTENUMERATIONINHERITED Doc::alias("cxxStructEnumerationInherited")
-#define CXXSTRUCTENUMERATORINHERITED Doc::alias("cxxStructEnumeratorInherited")
-#define CXXSTRUCTFUNCTIONINHERITED Doc::alias("cxxStructFunctionInherited")
-#define CXXSTRUCTINHERITS Doc::alias("cxxStructInherits")
-#define CXXSTRUCTINHERITSDETAIL Doc::alias("cxxStructInheritsDetail")
-#define CXXSTRUCTNESTED Doc::alias("cxxStructNested")
-#define CXXSTRUCTNESTEDCLASS Doc::alias("cxxStructNestedClass")
-#define CXXSTRUCTNESTEDDETAIL Doc::alias("cxxStructNestedDetail")
-#define CXXSTRUCTNESTEDSTRUCT Doc::alias("cxxStructNestedStruct")
-#define CXXSTRUCTNESTEDUNION Doc::alias("cxxStructNestedUnion")
-#define CXXSTRUCTTEMPLATEPARAMETER Doc::alias("cxxStructTemplateParameter")
-#define CXXSTRUCTTEMPLATEPARAMETERS Doc::alias("cxxStructTemplateParameters")
-#define CXXSTRUCTTEMPLATEPARAMETERTYPE Doc::alias("cxxStructTemplateParameterType")
-#define CXXSTRUCTVARIABLEINHERITED Doc::alias("cxxStructVariableInherited")
-
-#define CXXTYPEDEF Doc::alias("cxxTypedef")
-#define CXXTYPEDEFACCESSSPECIFIER Doc::alias("cxxTypedefAccessSpecifier")
-#define CXXTYPEDEFAPIITEMLOCATION Doc::alias("cxxTypedefAPIItemLocation")
-#define CXXTYPEDEFDECLARATIONFILE Doc::alias("cxxTypedefDeclarationFile")
-#define CXXTYPEDEFDECLARATIONFILELINE Doc::alias("cxxTypedefDeclarationFileLine")
-#define CXXTYPEDEFDECLAREDTYPE Doc::alias("cxxTypedefDeclaredType")
-#define CXXTYPEDEFDEFINITION Doc::alias("cxxTypedefDefinition")
-#define CXXTYPEDEFDETAIL Doc::alias("cxxTypedefDetail")
-#define CXXTYPEDEFNAMELOOKUP Doc::alias("cxxTypedefNameLookup")
-#define CXXTYPEDEFPROTOTYPE Doc::alias("cxxTypedefPrototype")
-#define CXXTYPEDEFREIMPLEMENTED Doc::alias("cxxTypedefReimplemented")
-#define CXXTYPEDEFSCOPEDNAME Doc::alias("cxxTypedefScopedName")
-
-#define CXXUNION Doc::alias("cxxUnion")
-#define CXXUNIONABSTRACT Doc::alias("cxxUnionAbstract")
-#define CXXUNIONACCESSSPECIFIER Doc::alias("cxxUnionAccessSpecifier")
-#define CXXUNIONAPIITEMLOCATION Doc::alias("cxxUnionAPIItemLocation")
-#define CXXUNIONDECLARATIONFILE Doc::alias("cxxUnionDeclarationFile")
-#define CXXUNIONDECLARATIONFILELINE Doc::alias("cxxUnionDeclarationFileLine")
-#define CXXUNIONDEFINITION Doc::alias("cxxUnionDefinition")
-#define CXXUNIONDEFINITIONFILE Doc::alias("cxxUnionDefinitionFile")
-#define CXXUNIONDEFINITIONFILELINEEND Doc::alias("cxxUnionDefinitionFileLineEnd")
-#define CXXUNIONDEFINITIONFILELINESTART Doc::alias("cxxUnionDefinitionFileLineStart")
-#define CXXUNIONDETAIL Doc::alias("cxxUnionDetail")
-#define CXXUNIONNESTED Doc::alias("cxxUnionNested")
-#define CXXUNIONNESTEDCLASS Doc::alias("cxxUnionNestedClass")
-#define CXXUNIONNESTEDDETAIL Doc::alias("cxxUnionNestedDetail")
-#define CXXUNIONNESTEDSTRUCT Doc::alias("cxxUnionNestedStruct")
-#define CXXUNIONNESTEDUNION Doc::alias("cxxUnionNestedUnion")
-#define CXXUNIONTEMPLATEPARAMETER Doc::alias("cxxUnionTemplateParameter")
-#define CXXUNIONTEMPLATEPARAMETERS Doc::alias("cxxUnionTemplateParameters")
-#define CXXUNIONTEMPLATEPARAMETERTYPE Doc::alias("cxxUnionTemplateParameterType")
-
-#define CXXVARIABLE Doc::alias("cxxVariable")
-#define CXXVARIABLEACCESSSPECIFIER Doc::alias("cxxVariableAccessSpecifier")
-#define CXXVARIABLEAPIITEMLOCATION Doc::alias("cxxVariableAPIItemLocation")
-#define CXXVARIABLECONST Doc::alias("cxxVariableConst")
-#define CXXVARIABLEDECLARATIONFILE Doc::alias("cxxVariableDeclarationFile")
-#define CXXVARIABLEDECLARATIONFILELINE Doc::alias("cxxVariableDeclarationFileLine")
-#define CXXVARIABLEDECLAREDTYPE Doc::alias("cxxVariableDeclaredType")
-#define CXXVARIABLEDEFINITION Doc::alias("cxxVariableDefinition")
-#define CXXVARIABLEDETAIL Doc::alias("cxxVariableDetail")
-#define CXXVARIABLENAMELOOKUP Doc::alias("cxxVariableNameLookup")
-#define CXXVARIABLEPROTOTYPE Doc::alias("cxxVariablePrototype")
-#define CXXVARIABLEREIMPLEMENTED Doc::alias("cxxVariableReimplemented")
-#define CXXVARIABLESCOPEDNAME Doc::alias("cxxVariableScopedName")
-#define CXXVARIABLESTORAGECLASSSPECIFIEREXTERN Doc::alias("cxxVariableStorageClassSpecifierExtern")
-#define CXXVARIABLESTORAGECLASSSPECIFIERMUTABLE Doc::alias("cxxVariableStorageClassSpecifierMutable")
-#define CXXVARIABLESTORAGECLASSSPECIFIERSTATIC Doc::alias("cxxVariableStorageClassSpecifierStatic")
-#define CXXVARIABLEVOLATILE Doc::alias("cxxVariableVolatile")
-
QString DitaXmlGenerator::sinceTitles[] =
{
" New Namespaces",
@@ -305,6 +85,156 @@ QString DitaXmlGenerator::sinceTitles[] =
""
};
+/*
+ The strings in this array must appear in the same order as
+ the values in enum DitaXmlGenerator::DitaTag.
+ */
+QString DitaXmlGenerator::ditaTags[] =
+ {
+ "alt",
+ "apiDesc",
+ "APIMap",
+ "apiName",
+ "b",
+ "body",
+ "bodydiv",
+ "codeblock",
+ "comment",
+ "cxxAPIMap",
+ "cxxClass",
+ "cxxClassAbstract",
+ "cxxClassAccessSpecifier",
+ "cxxClassAPIItemLocation",
+ "cxxClassBaseClass",
+ "cxxClassDeclarationFile",
+ "cxxClassDeclarationFileLine",
+ "cxxClassDefinition",
+ "cxxClassDerivation",
+ "cxxClassDerivationAccessSpecifier",
+ "cxxClassDerivations",
+ "cxxClassDetail",
+ "cxxClassNested",
+ "cxxClassNestedClass",
+ "cxxClassNestedDetail",
+ "cxxDefine",
+ "cxxDefineAccessSpecifier",
+ "cxxDefineAPIItemLocation",
+ "cxxDefineDeclarationFile",
+ "cxxDefineDeclarationFileLine",
+ "cxxDefineDefinition",
+ "cxxDefineDetail",
+ "cxxDefineNameLookup",
+ "cxxDefineParameter",
+ "cxxDefineParameterDeclarationName",
+ "cxxDefineParameters",
+ "cxxDefinePrototype",
+ "cxxDefineReimplemented",
+ "cxxEnumeration",
+ "cxxEnumerationAccessSpecifier",
+ "cxxEnumerationAPIItemLocation",
+ "cxxEnumerationDeclarationFile",
+ "cxxEnumerationDeclarationFileLine",
+ "cxxEnumerationDefinition",
+ "cxxEnumerationDefinitionFile",
+ "cxxEnumerationDefinitionFileLineStart",
+ "cxxEnumerationDefinitionFileLineEnd",
+ "cxxEnumerationDetail",
+ "cxxEnumerationNameLookup",
+ "cxxEnumerationPrototype",
+ "cxxEnumerationScopedName",
+ "cxxEnumerator",
+ "cxxEnumeratorInitialiser",
+ "cxxEnumeratorNameLookup",
+ "cxxEnumeratorPrototype",
+ "cxxEnumerators",
+ "cxxEnumeratorScopedName",
+ "cxxFunction",
+ "cxxFunctionAccessSpecifier",
+ "cxxFunctionAPIItemLocation",
+ "cxxFunctionConst",
+ "cxxFunctionConstructor",
+ "cxxFunctionDeclarationFile",
+ "cxxFunctionDeclarationFileLine",
+ "cxxFunctionDeclaredType",
+ "cxxFunctionDefinition",
+ "cxxFunctionDestructor",
+ "cxxFunctionDetail",
+ "cxxFunctionNameLookup",
+ "cxxFunctionParameter",
+ "cxxFunctionParameterDeclarationName",
+ "cxxFunctionParameterDeclaredType",
+ "cxxFunctionParameterDefaultValue",
+ "cxxFunctionParameters",
+ "cxxFunctionPrototype",
+ "cxxFunctionPureVirtual",
+ "cxxFunctionReimplemented",
+ "cxxFunctionScopedName",
+ "cxxFunctionStorageClassSpecifierStatic",
+ "cxxFunctionVirtual",
+ "cxxTypedef",
+ "cxxTypedefAccessSpecifier",
+ "cxxTypedefAPIItemLocation",
+ "cxxTypedefDeclarationFile",
+ "cxxTypedefDeclarationFileLine",
+ "cxxTypedefDefinition",
+ "cxxTypedefDetail",
+ "cxxTypedefNameLookup",
+ "cxxTypedefScopedName",
+ "cxxVariable",
+ "cxxVariableAccessSpecifier",
+ "cxxVariableAPIItemLocation",
+ "cxxVariableDeclarationFile",
+ "cxxVariableDeclarationFileLine",
+ "cxxVariableDeclaredType",
+ "cxxVariableDefinition",
+ "cxxVariableDetail",
+ "cxxVariableNameLookup",
+ "cxxVariablePrototype",
+ "cxxVariableReimplemented",
+ "cxxVariableScopedName",
+ "cxxVariableStorageClassSpecifierStatic",
+ "dd",
+ "dl",
+ "dlentry",
+ "dt",
+ "entry",
+ "fig",
+ "i",
+ "image",
+ "li",
+ "link",
+ "linktext",
+ "lq",
+ "ol",
+ "p",
+ "parameter",
+ "pre",
+ "related-links",
+ "row",
+ "section",
+ "sectiondiv",
+ "shortdesc",
+ "simpletable",
+ "stentry",
+ "sthead",
+ "strow",
+ "sub",
+ "sup",
+ "table",
+ "tbody",
+ "tgroup",
+ "thead",
+ "title",
+ "topic",
+ "topicmeta",
+ "topicref",
+ "tt",
+ "ul",
+ "u",
+ "xref",
+ ""
+ };
+
static bool showBrokenLinks = false;
/*!
@@ -330,11 +260,11 @@ void DitaXmlGenerator::addLink(const QString& href,
const QStringRef& text)
{
if (!href.isEmpty()) {
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href", href);
writeCharacters(text.toString());
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
}
else {
writeCharacters(text.toString());
@@ -342,6 +272,35 @@ void DitaXmlGenerator::addLink(const QString& href,
}
/*!
+ Push \a t onto the dita tag stack and write the appropriate
+ start tag to the DITA XML file.
+ */
+void DitaXmlGenerator::writeStartTag(DitaTag t)
+{
+ xmlWriter().writeStartElement(ditaTags[t]);
+ tagStack.push(t);
+}
+
+/*!
+ Pop the current DITA tag off the stack, and write the
+ appropriate end tag to the DITA XML file.
+ */
+void DitaXmlGenerator::writeEndTag()
+{
+ tagStack.pop();
+ xmlWriter().writeEndElement();
+}
+
+/*!
+ Return the current DITA element tag, the one
+ on top of the stack.
+ */
+DitaXmlGenerator::DitaTag DitaXmlGenerator::currentTag()
+{
+ return tagStack.top();
+}
+
+/*!
The default constructor.
*/
DitaXmlGenerator::DitaXmlGenerator()
@@ -380,29 +339,9 @@ DitaXmlGenerator::~DitaXmlGenerator()
*/
void DitaXmlGenerator::initializeGenerator(const Config &config)
{
- static const struct {
- const char *key;
- const char *tag;
- } defaults[] = {
- { ATOM_FORMATTING_BOLD, "b" },
- { ATOM_FORMATTING_INDEX, "<!--" },
- { ATOM_FORMATTING_ITALIC, "i" },
- { ATOM_FORMATTING_PARAMETER, "i" },
- { ATOM_FORMATTING_SUBSCRIPT, "sub" },
- { ATOM_FORMATTING_SUPERSCRIPT, "sup" },
- { ATOM_FORMATTING_TELETYPE, "tt", },
- { ATOM_FORMATTING_UNDERLINE, "u", },
- { 0, 0 }
- };
-
Generator::initializeGenerator(config);
obsoleteLinks = config.getBool(QLatin1String(CONFIG_OBSOLETELINKS));
setImageFileExtensions(QStringList() << "png" << "jpg" << "jpeg" << "gif");
- int i = 0;
- while (defaults[i].key) {
- formattingLeftMap().insert(defaults[i].key, defaults[i].tag);
- i++;
- }
style = config.getString(DitaXmlGenerator::format() +
Config::dot +
@@ -675,12 +614,12 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
//break;
//}
if (inApiDesc || inSection) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","brief");
}
else {
noLinks = true;
- xmlWriter().writeStartElement("shortdesc");
+ writeStartTag(DT_shortdesc);
}
if (relative->type() == Node::Property ||
relative->type() == Node::Variable) {
@@ -708,62 +647,93 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::BriefRight:
// if (relative->type() != Node::Fake)
- xmlWriter().writeEndElement(); // </shortdesc> or </p>
+ writeEndTag(); // </shortdesc> or </p>
noLinks = false;
break;
case Atom::C:
- xmlWriter().writeStartElement(formattingLeftMap()[ATOM_FORMATTING_TELETYPE]);
+ writeStartTag(DT_tt);
if (inLink) {
writeCharacters(protectEnc(plainCode(atom->string())));
}
else {
writeText(atom->string(), marker, relative);
}
- xmlWriter().writeEndElement(); // sse writeStartElement() above
+ writeEndTag(); // see writeStartElement() above
break;
case Atom::Code:
{
- xmlWriter().writeStartElement("codeblock");
+ writeStartTag(DT_codeblock);
QString chars = trimmedTrailing(atom->string());
writeText(chars, marker, relative);
- xmlWriter().writeEndElement(); // </codeblock>
+ writeEndTag(); // </codeblock>
}
break;
case Atom::Qml:
- xmlWriter().writeStartElement("codeblock");
+ writeStartTag(DT_codeblock);
writeText(trimmedTrailing(atom->string()), marker, relative);
- xmlWriter().writeEndElement(); // </codeblock>
+ writeEndTag(); // </codeblock>
break;
case Atom::CodeNew:
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeCharacters("you can rewrite it as");
- xmlWriter().writeEndElement(); // </p>
- xmlWriter().writeStartElement("codeblock");
+ writeEndTag(); // </p>
+ writeStartTag(DT_codeblock);
writeText(trimmedTrailing(atom->string()), marker, relative);
- xmlWriter().writeEndElement(); // </codeblock>
+ writeEndTag(); // </codeblock>
break;
case Atom::CodeOld:
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeCharacters("For example, if you have code like");
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
// fallthrough
case Atom::CodeBad:
- xmlWriter().writeStartElement("codeblock");
+ writeStartTag(DT_codeblock);
writeCharacters(trimmedTrailing(plainCode(atom->string())));
- xmlWriter().writeEndElement(); // </codeblock>
+ writeEndTag(); // </codeblock>
break;
case Atom::DivLeft:
- xmlWriter().writeStartElement("sectiondiv");
- if (!atom->string().isEmpty())
- xmlWriter().writeAttribute("outputclass", atom->string());
+ {
+ QString attr = atom->string();
+ DitaTag t = currentTag();
+ if ((t == DT_section) || (t == DT_sectiondiv))
+ t = DT_sectiondiv;
+ else if ((t == DT_body) || (t == DT_bodydiv))
+ t = DT_bodydiv;
+ else
+ t = DT_p;
+ writeStartTag(t);
+ if (!attr.isEmpty()) {
+ if (attr.contains('=')) {
+ int index = 0;
+ int from = 0;
+ QString values;
+ while (index >= 0) {
+ index = attr.indexOf('"',from);
+ if (index >= 0) {
+ ++index;
+ from = index;
+ index = attr.indexOf('"',from);
+ if (index > from) {
+ if (!values.isEmpty())
+ values.append(' ');
+ values += attr.mid(from,index-from);
+ from = index+1;
+ }
+ }
+ }
+ attr = values;
+ }
+ }
+ xmlWriter().writeAttribute("outputclass", attr);
+ }
break;
case Atom::DivRight:
- xmlWriter().writeEndElement(); // </sectiondiv>
+ writeEndTag(); // </sectiondiv>
break;
case Atom::FootnoteLeft:
// ### For now
if (in_para) {
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
in_para = false;
}
xmlWriter().writeCharacters("<!-- ");
@@ -777,16 +747,37 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
case Atom::FormatIf:
break;
case Atom::FormattingLeft:
- xmlWriter().writeStartElement(formattingLeftMap()[atom->string()]);
- if (atom->string() == ATOM_FORMATTING_PARAMETER) {
- if (atom->next() != 0 && atom->next()->type() == Atom::String) {
- QRegExp subscriptRegExp("([a-z]+)_([0-9n])");
- if (subscriptRegExp.exactMatch(atom->next()->string())) {
- xmlWriter().writeCharacters(subscriptRegExp.cap(1));
- xmlWriter().writeStartElement("sub");
- xmlWriter().writeCharacters(subscriptRegExp.cap(2));
- xmlWriter().writeEndElement(); // </sub>
- skipAhead = 1;
+ {
+ DitaTag t = DT_LAST;
+ if (atom->string() == ATOM_FORMATTING_BOLD)
+ t = DT_b;
+ else if (atom->string() == ATOM_FORMATTING_PARAMETER)
+ t = DT_i;
+ else if (atom->string() == ATOM_FORMATTING_ITALIC)
+ t = DT_i;
+ else if (atom->string() == ATOM_FORMATTING_TELETYPE)
+ t = DT_tt;
+ else if (atom->string() == ATOM_FORMATTING_UNDERLINE)
+ t = DT_u;
+ else if (atom->string() == ATOM_FORMATTING_INDEX)
+ t = DT_comment;
+ else if (atom->string() == ATOM_FORMATTING_SUBSCRIPT)
+ t = DT_sub;
+ else if (atom->string() == ATOM_FORMATTING_SUPERSCRIPT)
+ t = DT_sup;
+ else
+ qDebug() << "DT_LAST";
+ writeStartTag(t);
+ if (atom->string() == ATOM_FORMATTING_PARAMETER) {
+ if (atom->next() != 0 && atom->next()->type() == Atom::String) {
+ QRegExp subscriptRegExp("([a-z]+)_([0-9n])");
+ if (subscriptRegExp.exactMatch(atom->next()->string())) {
+ xmlWriter().writeCharacters(subscriptRegExp.cap(1));
+ writeStartTag(DT_sub);
+ xmlWriter().writeCharacters(subscriptRegExp.cap(2));
+ writeEndTag(); // </sub>
+ skipAhead = 1;
+ }
}
}
}
@@ -796,7 +787,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
endLink();
}
else {
- xmlWriter().writeEndElement(); // ?
+ writeEndTag(); // ?
}
break;
case Atom::AnnotatedList:
@@ -985,7 +976,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
/*
First generate the table of contents.
*/
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
s = sections.constBegin();
while (s != sections.constEnd()) {
if (!(*s).members.isEmpty()) {
@@ -994,17 +985,17 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
}
++s;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
int idx = 0;
s = sections.constBegin();
while (s != sections.constEnd()) {
if (!(*s).members.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
writeGuidAttribute(Doc::canonicalTitle((*s).name));
xmlWriter().writeAttribute("outputclass","h3");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
if (idx == Class)
generateCompactList(0, marker, ncmap.value(), false, QString("Q"));
else if (idx == QmlClass)
@@ -1024,16 +1015,16 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
pmap = parentmaps.begin();
while (pmap != parentmaps.end()) {
NodeList nlist = pmap->values();
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeCharacters("Class ");
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",linkForNode(pmap.key(), 0));
QStringList pieces = fullName(pmap.key(), 0, marker).split("::");
writeCharacters(protectEnc(pieces.last()));
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
xmlWriter().writeCharacters(":");
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
generateSection(nlist, 0, marker, CodeMarker::Summary);
++pmap;
@@ -1065,8 +1056,8 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
fileName = QLatin1String("images/") + protectEnc(atom->string());
}
- xmlWriter().writeStartElement("fig");
- xmlWriter().writeStartElement("image");
+ writeStartTag(DT_fig);
+ writeStartTag(DT_image);
xmlWriter().writeAttribute("href",protectEnc(fileName));
if (atom->type() == Atom::InlineImage)
xmlWriter().writeAttribute("placement","inline");
@@ -1075,12 +1066,12 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
xmlWriter().writeAttribute("align","center");
}
if (!text.isEmpty()) {
- xmlWriter().writeStartElement("alt");
+ writeStartTag(DT_alt);
writeCharacters(protectEnc(text));
- xmlWriter().writeEndElement(); // </alt>
+ writeEndTag(); // </alt>
}
- xmlWriter().writeEndElement(); // </image>
- xmlWriter().writeEndElement(); // </fig>
+ writeEndTag(); // </image>
+ writeEndTag(); // </fig>
}
break;
case Atom::ImageText:
@@ -1134,47 +1125,47 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::ListLeft:
if (in_para) {
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
in_para = false;
}
if (atom->string() == ATOM_LIST_BULLET) {
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
}
else if (atom->string() == ATOM_LIST_TAG) {
- xmlWriter().writeStartElement("dl");
+ writeStartTag(DT_dl);
}
else if (atom->string() == ATOM_LIST_VALUE) {
threeColumnEnumValueTable = isThreeColumnEnumValueTable(atom);
if (threeColumnEnumValueTable) {
- xmlWriter().writeStartElement("simpletable");
+ writeStartTag(DT_simpletable);
xmlWriter().writeAttribute("outputclass","valuelist");
- xmlWriter().writeStartElement("sthead");
- xmlWriter().writeStartElement("stentry");
+ writeStartTag(DT_sthead);
+ writeStartTag(DT_stentry);
xmlWriter().writeCharacters("Constant");
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeStartElement("stentry");
+ writeEndTag(); // </stentry>
+ writeStartTag(DT_stentry);
xmlWriter().writeCharacters("Value");
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeStartElement("stentry");
+ writeEndTag(); // </stentry>
+ writeStartTag(DT_stentry);
xmlWriter().writeCharacters("Description");
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeEndElement(); // </sthead>
+ writeEndTag(); // </stentry>
+ writeEndTag(); // </sthead>
}
else {
- xmlWriter().writeStartElement("simpletable");
+ writeStartTag(DT_simpletable);
xmlWriter().writeAttribute("outputclass","valuelist");
- xmlWriter().writeStartElement("sthead");
- xmlWriter().writeStartElement("stentry");
+ writeStartTag(DT_sthead);
+ writeStartTag(DT_stentry);
xmlWriter().writeCharacters("Constant");
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeStartElement("stentry");
+ writeEndTag(); // </stentry>
+ writeStartTag(DT_stentry);
xmlWriter().writeCharacters("Value");
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeEndElement(); // </sthead>
+ writeEndTag(); // </stentry>
+ writeEndTag(); // </sthead>
}
}
else {
- xmlWriter().writeStartElement("ol");
+ writeStartTag(DT_ol);
if (atom->string() == ATOM_LIST_UPPERALPHA)
xmlWriter().writeAttribute("outputclass","upperalpha");
else if (atom->string() == ATOM_LIST_LOWERALPHA)
@@ -1196,17 +1187,17 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::ListTagLeft:
if (atom->string() == ATOM_LIST_TAG) {
- xmlWriter().writeStartElement("dt");
+ writeStartTag(DT_dt);
}
else { // (atom->string() == ATOM_LIST_VALUE)
- xmlWriter().writeStartElement("strow");
- xmlWriter().writeStartElement("stentry");
- xmlWriter().writeStartElement("tt");
+ writeStartTag(DT_strow);
+ writeStartTag(DT_stentry);
+ writeStartTag(DT_tt);
writeCharacters(protectEnc(plainCode(marker->markedUpEnumValue(atom->next()->string(),
relative))));
- xmlWriter().writeEndElement(); // </tt>
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeStartElement("stentry");
+ writeEndTag(); // </tt>
+ writeEndTag(); // </stentry>
+ writeStartTag(DT_stentry);
QString itemValue;
if (relative->type() == Node::Enum) {
@@ -1217,64 +1208,64 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
if (itemValue.isEmpty())
xmlWriter().writeCharacters("?");
else {
- xmlWriter().writeStartElement("tt");
+ writeStartTag(DT_tt);
writeCharacters(protectEnc(itemValue));
- xmlWriter().writeEndElement(); // </tt>
+ writeEndTag(); // </tt>
}
skipAhead = 1;
}
break;
case Atom::ListTagRight:
if (atom->string() == ATOM_LIST_TAG)
- xmlWriter().writeEndElement(); // </dt>
+ writeEndTag(); // </dt>
break;
case Atom::ListItemLeft:
if (atom->string() == ATOM_LIST_TAG) {
- xmlWriter().writeStartElement("dd");
+ writeStartTag(DT_dd);
}
else if (atom->string() == ATOM_LIST_VALUE) {
if (threeColumnEnumValueTable) {
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeStartElement("stentry");
+ writeEndTag(); // </stentry>
+ writeStartTag(DT_stentry);
}
}
else {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
}
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
break;
case Atom::ListItemRight:
if (atom->string() == ATOM_LIST_TAG) {
- xmlWriter().writeEndElement(); // </dd>
+ writeEndTag(); // </dd>
}
else if (atom->string() == ATOM_LIST_VALUE) {
- xmlWriter().writeEndElement(); // </stentry>
- xmlWriter().writeEndElement(); // </strow>
+ writeEndTag(); // </stentry>
+ writeEndTag(); // </strow>
}
else {
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
}
break;
case Atom::ListRight:
if (atom->string() == ATOM_LIST_BULLET) {
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
else if (atom->string() == ATOM_LIST_TAG) {
- xmlWriter().writeEndElement(); // </dl>
+ writeEndTag(); // </dl>
}
else if (atom->string() == ATOM_LIST_VALUE) {
- xmlWriter().writeEndElement(); // </simpletable>
+ writeEndTag(); // </simpletable>
}
else {
- xmlWriter().writeEndElement(); // </ol>
+ writeEndTag(); // </ol>
}
break;
case Atom::Nop:
// nothing
break;
case Atom::ParaLeft:
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
if (inLegaleseText)
xmlWriter().writeAttribute("outputclass","legalese");
in_para = true;
@@ -1282,15 +1273,15 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
case Atom::ParaRight:
endLink();
if (in_para) {
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
in_para = false;
}
break;
case Atom::QuotationLeft:
- xmlWriter().writeStartElement("lq");
+ writeStartTag(DT_lq);
break;
case Atom::QuotationRight:
- xmlWriter().writeEndElement(); // </lq>
+ writeEndTag(); // </lq>
break;
case Atom::RawString:
if (atom->string() == " ")
@@ -1298,41 +1289,41 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
if (atom->string().startsWith("&"))
writeCharacters(atom->string());
else if (atom->string() == "<sup>*</sup>") {
- xmlWriter().writeStartElement("sup");
+ writeStartTag(DT_sup);
writeCharacters("*");
- xmlWriter().writeEndElement(); // </sup>
+ writeEndTag(); // </sup>
}
else {
- xmlWriter().writeStartElement("pre");
+ writeStartTag(DT_pre);
xmlWriter().writeAttribute("outputclass","raw-html");
writeCharacters(atom->string());
- xmlWriter().writeEndElement(); // </pre>
+ writeEndTag(); // </pre>
}
break;
case Atom::SectionLeft:
if (inSection || inApiDesc) {
inApiDesc = false;
- xmlWriter().writeEndElement(); // </section> or </apiDesc>
+ writeEndTag(); // </section> or </apiDesc>
}
inSection = true;
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
writeGuidAttribute(Doc::canonicalTitle(Text::sectionHeading(atom).toString()));
xmlWriter().writeAttribute("outputclass","details");
break;
case Atom::SectionRight:
if (inSection) {
inSection = false;
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
break;
case Atom::SectionHeadingLeft:
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
hx = "h" + QString::number(atom->string().toInt() + hOffset(relative));
xmlWriter().writeAttribute("outputclass",hx);
inSectionHeading = true;
break;
case Atom::SectionHeadingRight:
- xmlWriter().writeEndElement(); // </title> (see case Atom::SectionHeadingLeft)
+ writeEndTag(); // </title> (see case Atom::SectionHeadingLeft)
inSectionHeading = false;
break;
case Atom::SidebarLeft:
@@ -1352,79 +1343,79 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
case Atom::TableLeft:
{
if (in_para) {
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
in_para = false;
}
- xmlWriter().writeStartElement("table");
+ writeStartTag(DT_table);
numTableRows = 0;
if (tableColumnCount != 0) {
qDebug() << "ERROR: Nested tables!";
tableColumnCount = 0;
}
tableColumnCount = countTableColumns(atom->next());
- xmlWriter().writeStartElement("tgroup");
+ writeStartTag(DT_tgroup);
xmlWriter().writeAttribute("cols",QString::number(tableColumnCount));
inTableHeader = false;
inTableBody = false;
}
break;
case Atom::TableRight:
- xmlWriter().writeEndElement(); // </tbody>
- xmlWriter().writeEndElement(); // </tgroup>
- xmlWriter().writeEndElement(); // </table>
+ writeEndTag(); // </tbody>
+ writeEndTag(); // </tgroup>
+ writeEndTag(); // </table>
inTableHeader = false;
inTableBody = false;
tableColumnCount = 0;
break;
case Atom::TableHeaderLeft:
if (inTableBody) {
- xmlWriter().writeEndElement(); // </tbody>
- xmlWriter().writeEndElement(); // </tgroup>
- xmlWriter().writeEndElement(); // </table>
+ writeEndTag(); // </tbody>
+ writeEndTag(); // </tgroup>
+ writeEndTag(); // </table>
inTableHeader = false;
inTableBody = false;
tableColumnCount = 0;
- xmlWriter().writeStartElement("table");
+ writeStartTag(DT_table);
numTableRows = 0;
tableColumnCount = countTableColumns(atom);
- xmlWriter().writeStartElement("tgroup");
+ writeStartTag(DT_tgroup);
xmlWriter().writeAttribute("cols",QString::number(tableColumnCount));
}
- xmlWriter().writeStartElement("thead");
+ writeStartTag(DT_thead);
xmlWriter().writeAttribute("valign","top");
- xmlWriter().writeStartElement("row");
+ writeStartTag(DT_row);
xmlWriter().writeAttribute("valign","top");
inTableHeader = true;
inTableBody = false;
break;
case Atom::TableHeaderRight:
- xmlWriter().writeEndElement(); // </row>
+ writeEndTag(); // </row>
if (matchAhead(atom, Atom::TableHeaderLeft)) {
skipAhead = 1;
- xmlWriter().writeStartElement("row");
+ writeStartTag(DT_row);
xmlWriter().writeAttribute("valign","top");
}
else {
- xmlWriter().writeEndElement(); // </thead>
+ writeEndTag(); // </thead>
inTableHeader = false;
inTableBody = true;
- xmlWriter().writeStartElement("tbody");
+ writeStartTag(DT_tbody);
}
break;
case Atom::TableRowLeft:
if (!inTableHeader && !inTableBody) {
inTableBody = true;
- xmlWriter().writeStartElement("tbody");
+ writeStartTag(DT_tbody);
}
- xmlWriter().writeStartElement("row");
+ writeStartTag(DT_row);
xmlWriter().writeAttribute("valign","top");
break;
case Atom::TableRowRight:
- xmlWriter().writeEndElement(); // </row>
+ writeEndTag(); // </row>
break;
case Atom::TableItemLeft:
{
- xmlWriter().writeStartElement("entry");
+ writeStartTag(DT_entry);
QStringList spans = atom->string().split(",");
if (spans.size() == 2) {
if (inTableHeader ||
@@ -1440,9 +1431,9 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::TableItemRight:
if (inTableHeader)
- xmlWriter().writeEndElement(); // </entry>
+ writeEndTag(); // </entry>
else {
- xmlWriter().writeEndElement(); // </entry>
+ writeEndTag(); // </entry>
}
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
@@ -1478,26 +1469,26 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::Target:
if (in_para) {
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
in_para = false;
}
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
writeGuidAttribute(Doc::canonicalTitle(atom->string()));
xmlWriter().writeAttribute("outputclass","target");
//xmlWriter().writeCharacters(protectEnc(atom->string()));
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
break;
case Atom::UnhandledFormat:
- xmlWriter().writeStartElement("b");
+ writeStartTag(DT_b);
xmlWriter().writeAttribute("outputclass","error");
xmlWriter().writeCharacters("<Missing DITAXML>");
- xmlWriter().writeEndElement(); // </b>
+ writeEndTag(); // </b>
break;
case Atom::UnknownCommand:
- xmlWriter().writeStartElement("b");
+ writeStartTag(DT_b);
xmlWriter().writeAttribute("outputclass","error unknown-command");
writeCharacters(protectEnc(atom->string()));
- xmlWriter().writeEndElement(); // </b>
+ writeEndTag(); // </b>
break;
case Atom::QmlText:
case Atom::EndQmlText:
@@ -1540,24 +1531,24 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
// not included: <prolog>
- xmlWriter().writeStartElement(CXXCLASSDETAIL);
- xmlWriter().writeStartElement(CXXCLASSDEFINITION);
+ writeStartTag(DT_cxxClassDetail);
+ writeStartTag(DT_cxxClassDefinition);
writeLocation(nsn);
- xmlWriter().writeEndElement(); // <cxxClassDefinition>
+ writeEndTag(); // <cxxClassDefinition>
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_apiDesc);
xmlWriter().writeAttribute("spectitle",title);
Text brief = nsn->doc().briefText(); // zzz
if (!brief.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
generateText(brief, nsn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
generateIncludes(nsn, marker);
generateStatus(nsn, marker);
generateThreadSafeness(nsn, marker);
generateSince(nsn, marker);
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
bool needOtherSection = false;
QList<Section> summarySections;
@@ -1571,51 +1562,51 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
else {
QString attr;
if (!s->members.isEmpty()) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
attr = cleanRef((*s).name).toLower() + " redundant";
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->members, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
if (!s->reimpMembers.isEmpty()) {
QString name = QString("Reimplemented ") + (*s).name;
attr = cleanRef(name).toLower() + " redundant";
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc(name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->reimpMembers, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
}
++s;
}
if (needOtherSection) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass","additional-inherited-members redundant");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeCharacters("Additional Inherited Members");
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
s = summarySections.begin();
while (s != summarySections.end()) {
if (s->members.isEmpty())
generateSectionInheritedList(*s, inner, marker);
++s;
}
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
writeDetailedDescription(nsn, marker, false, QString("Detailed Description"));
- xmlWriter().writeEndElement(); // </cxxClassDetail>
+ writeEndTag(); // </cxxClassDetail>
// not included: <related-links>
// not included: <cxxClassNested>
@@ -1651,7 +1642,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
generateLowStatusMembers(inner,marker,CodeMarker::Obsolete);
generateLowStatusMembers(inner,marker,CodeMarker::Compat);
- xmlWriter().writeEndElement(); // </cxxClass>
+ writeEndTag(); // </cxxClass>
}
else if (inner->type() == Node::Class) {
const ClassNode* cn = const_cast<ClassNode*>(static_cast<const ClassNode*>(inner));
@@ -1664,31 +1655,31 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
// not included: <prolog>
- xmlWriter().writeStartElement(CXXCLASSDETAIL);
- xmlWriter().writeStartElement(CXXCLASSDEFINITION);
- xmlWriter().writeStartElement(CXXCLASSACCESSSPECIFIER);
+ writeStartTag(DT_cxxClassDetail);
+ writeStartTag(DT_cxxClassDefinition);
+ writeStartTag(DT_cxxClassAccessSpecifier);
xmlWriter().writeAttribute("value",inner->accessString());
- xmlWriter().writeEndElement(); // <cxxClassAccessSpecifier>
+ writeEndTag(); // <cxxClassAccessSpecifier>
if (cn->isAbstract()) {
- xmlWriter().writeStartElement(CXXCLASSABSTRACT);
+ writeStartTag(DT_cxxClassAbstract);
xmlWriter().writeAttribute("name","abstract");
xmlWriter().writeAttribute("value","abstract");
- xmlWriter().writeEndElement(); // </cxxClassAbstract>
+ writeEndTag(); // </cxxClassAbstract>
}
writeDerivations(cn, marker); // <cxxClassDerivations>
// not included: <cxxClassTemplateParameters>
writeLocation(cn);
- xmlWriter().writeEndElement(); // <cxxClassDefinition>
+ writeEndTag(); // <cxxClassDefinition>
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_apiDesc);
xmlWriter().writeAttribute("spectitle",title);
Text brief = cn->doc().briefText(); // zzz
if (!brief.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
generateText(brief, cn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
generateIncludes(cn, marker);
generateStatus(cn, marker);
@@ -1696,7 +1687,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
generateInheritedBy(cn, marker);
generateThreadSafeness(cn, marker);
generateSince(cn, marker);
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
bool needOtherSection = false;
QList<Section> summarySections;
@@ -1710,54 +1701,54 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
else {
QString attr;
if (!s->members.isEmpty()) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
attr = cleanRef((*s).name).toLower() + " redundant";
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->members, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
if (!s->reimpMembers.isEmpty()) {
QString name = QString("Reimplemented ") + (*s).name;
attr = cleanRef(name).toLower() + " redundant";
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc(name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->reimpMembers, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
}
++s;
}
if (needOtherSection) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass","additional-inherited-members redundant");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeCharacters("Additional Inherited Members");
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
s = summarySections.begin();
while (s != summarySections.end()) {
if (s->members.isEmpty())
generateSectionInheritedList(*s, inner, marker);
++s;
}
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
writeDetailedDescription(cn, marker, false, QString("Detailed Description"));
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxClassDetail>
+ writeEndTag(); // </cxxClassDetail>
// not included: <related-links>
// not included: <cxxClassNested>
@@ -1787,7 +1778,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
generateLowStatusMembers(inner,marker,CodeMarker::Obsolete);
generateLowStatusMembers(inner,marker,CodeMarker::Compat);
- xmlWriter().writeEndElement(); // </cxxClass>
+ writeEndTag(); // </cxxClass>
}
else if ((inner->type() == Node::Fake) && (inner->subType() == Node::HeaderFile)) {
const FakeNode* fn = const_cast<FakeNode*>(static_cast<const FakeNode*>(inner));
@@ -1803,20 +1794,20 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
*/
generateHeader(inner, fullTitle);
generateBrief(inner, marker); // <shortdesc>
- xmlWriter().writeStartElement(CXXCLASSDETAIL);
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_cxxClassDetail);
+ writeStartTag(DT_apiDesc);
xmlWriter().writeAttribute("spectitle",title);
Text brief = fn->doc().briefText(); // zzz
if (!brief.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
generateText(brief, fn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
generateIncludes(fn, marker);
generateStatus(fn, marker);
generateThreadSafeness(fn, marker);
generateSince(fn, marker);
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
bool needOtherSection = false;
QList<Section> summarySections;
@@ -1830,51 +1821,51 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
else {
QString attr;
if (!s->members.isEmpty()) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
attr = cleanRef((*s).name).toLower() + " redundant";
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->members, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
if (!s->reimpMembers.isEmpty()) {
QString name = QString("Reimplemented ") + (*s).name;
attr = cleanRef(name).toLower() + " redundant";
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc(name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateSection(s->reimpMembers, inner, marker, CodeMarker::Summary);
generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
}
++s;
}
if (needOtherSection) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass","additional-inherited-members redundant");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeCharacters("Additional Inherited Members");
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
s = summarySections.begin();
while (s != summarySections.end()) {
if (s->members.isEmpty())
generateSectionInheritedList(*s, inner, marker);
++s;
}
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
writeDetailedDescription(fn, marker, false, QString("Detailed Description"));
- xmlWriter().writeEndElement(); // </cxxClassDetail>
+ writeEndTag(); // </cxxClassDetail>
// not included: <related-links>
// not included: <cxxClassNested>
@@ -1909,7 +1900,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
}
generateLowStatusMembers(inner,marker,CodeMarker::Obsolete);
generateLowStatusMembers(inner,marker,CodeMarker::Compat);
- xmlWriter().writeEndElement(); // </cxxClass>
+ writeEndTag(); // </cxxClass>
}
else if ((inner->type() == Node::Fake) && (inner->subType() == Node::QmlClass)) {
const QmlClassNode* qcn = const_cast<QmlClassNode*>(static_cast<const QmlClassNode*>(inner));
@@ -1925,20 +1916,20 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
// not included: <prolog>
- xmlWriter().writeStartElement(CXXCLASSDETAIL);
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_cxxClassDetail);
+ writeStartTag(DT_apiDesc);
xmlWriter().writeAttribute("spectitle",title);
Text brief = qcn->doc().briefText(); // zzz
if (!brief.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
generateText(brief, qcn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
generateQmlInstantiates(qcn, marker);
generateQmlInherits(qcn, marker);
generateQmlInheritedBy(qcn, marker);
generateSince(qcn, marker);
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
QList<Section> summarySections;
summarySections = marker->qmlSections(qcn,CodeMarker::Summary,0);
@@ -1946,17 +1937,17 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
while (s != summarySections.end()) {
QString attr;
if (!s->members.isEmpty()) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
attr = cleanRef((*s).name).toLower() + " redundant";
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateQmlSummary(*s,qcn,marker);
//generateSection(s->members, inner, marker, CodeMarker::Summary);
//generateSectionInheritedList(*s, inner, marker);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
++s;
}
@@ -1972,26 +1963,26 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
if (!s->members.isEmpty()) {
QString attr;
inSection = true;
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
attr = cleanRef((*s).name).toLower();
xmlWriter().writeAttribute("outputclass",attr);
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(protectEnc((*s).name));
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
NodeList::ConstIterator m = (*s).members.begin();
while (m != (*s).members.end()) {
generateDetailedQmlMember(*m, qcn, marker);
++m;
}
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
inSection = false;
}
++s;
}
- xmlWriter().writeEndElement(); // </cxxClassDetail>
- xmlWriter().writeEndElement(); // </cxxClass>
+ writeEndTag(); // </cxxClassDetail>
+ writeEndTag(); // </cxxClass>
}
}
@@ -2001,13 +1992,13 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark
*/
void DitaXmlGenerator::writeXrefListItem(const QString& link, const QString& text)
{
- xmlWriter().writeStartElement("li");
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_li);
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",link);
writeCharacters(text);
- xmlWriter().writeEndElement(); // </xref>
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </xref>
+ writeEndTag(); // </li>
}
/*!
@@ -2033,28 +2024,28 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker
generateHeader(fake, fullTitle);
generateBrief(fake, marker); // <shortdesc>
- xmlWriter().writeStartElement("body");
+ writeStartTag(DT_body);
if (fake->subType() == Node::Module) {
generateStatus(fake, marker);
if (moduleNamespaceMap.contains(fake->name())) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass","namespaces");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
xmlWriter().writeCharacters("Namespaces");
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateAnnotatedList(fake, marker, moduleNamespaceMap[fake->name()]);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
if (moduleClassMap.contains(fake->name())) {
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
xmlWriter().writeAttribute("outputclass","classes");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
xmlWriter().writeCharacters("Classes");
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
generateAnnotatedList(fake, marker, moduleClassMap[fake->name()]);
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
}
}
@@ -2062,11 +2053,11 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker
if (fake->subType() == Node::File) {
Text text;
Quoter quoter;
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass", "small-subtitle");
text << fake->subTitle();
generateText(text, fake, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
Doc::quoteFromFile(fake->doc().location(), quoter, fake->name());
QString code = quoter.quoteTo(fake->location(), "", "");
text.clear();
@@ -2091,9 +2082,9 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker
generateAnnotatedList(fake, marker, groupMembersMap);
}
}
- xmlWriter().writeEndElement(); // </body>
+ writeEndTag(); // </body>
writeRelatedLinks(fake, marker);
- xmlWriter().writeEndElement(); // </topic>
+ writeEndTag(); // </topic>
}
/*!
@@ -2108,13 +2099,13 @@ void DitaXmlGenerator::writeLink(const Node* node,
{
if (node) {
QString link = fileName(node) + "#" + node->guid();
- xmlWriter().writeStartElement("link");
+ writeStartTag(DT_link);
xmlWriter().writeAttribute("href", link);
xmlWriter().writeAttribute("role", role);
- xmlWriter().writeStartElement("linktext");
+ writeStartTag(DT_linktext);
writeCharacters(text);
- xmlWriter().writeEndElement(); // </linktext>
- xmlWriter().writeEndElement(); // </link>
+ writeEndTag(); // </linktext>
+ writeEndTag(); // </link>
}
}
@@ -2130,7 +2121,7 @@ void DitaXmlGenerator::writeRelatedLinks(const FakeNode* node, CodeMarker* marke
const Node* linkNode = 0;
QPair<QString,QString> linkPair;
if (node && !node->links().empty()) {
- xmlWriter().writeStartElement("related-links");
+ writeStartTag(DT_relatedLinks);
if (node->links().contains(Node::PreviousLink)) {
linkPair = node->links()[Node::PreviousLink];
linkNode = findNodeForTarget(linkPair.first, node, marker);
@@ -2146,7 +2137,7 @@ void DitaXmlGenerator::writeRelatedLinks(const FakeNode* node, CodeMarker* marke
linkNode = findNodeForTarget(linkPair.first, node, marker);
writeLink(linkNode, linkPair.second, "parent");
}
- xmlWriter().writeEndElement(); // </related-links>
+ writeEndTag(); // </related-links>
}
}
@@ -2172,59 +2163,59 @@ void DitaXmlGenerator::generateHeader(const Node* node,
if (!node)
return;
+ DitaTag mainTag = DT_cxxClass;
+ DitaTag nameTag = DT_apiName;
QString doctype;
- QString mainElement;
- QString nameElement;
QString dtd;
QString base;
QString version;
QString outputclass;
if (node->type() == Node::Class) {
- mainElement = "cxxClass";
- nameElement = "apiName";
+ mainTag = DT_cxxClass;
+ nameTag = DT_apiName;
dtd = "dtd/cxxClass.dtd";
version = "0.6.0";
- doctype = "<!DOCTYPE " + mainElement +
+ doctype = "<!DOCTYPE " + ditaTags[mainTag] +
" PUBLIC \"-//NOKIA//DTD DITA C++ API Class Reference Type v" +
version + "//EN\" \"" + dtd + "\">";
}
else if (node->type() == Node::Namespace) {
- mainElement = "cxxClass";
- nameElement = "apiName";
+ mainTag = DT_cxxClass;
+ nameTag = DT_apiName;
dtd = "dtd/cxxClass.dtd";
version = "0.6.0";
- doctype = "<!DOCTYPE " + mainElement +
+ doctype = "<!DOCTYPE " + ditaTags[mainTag] +
" PUBLIC \"-//NOKIA//DTD DITA C++ API Class Reference Type v" +
version + "//EN\" \"" + dtd + "\">";
outputclass = "namespace";
}
else if (node->type() == Node::Fake || subpage) {
if (node->subType() == Node::HeaderFile) {
- mainElement = "cxxClass";
- nameElement = "apiName";
+ mainTag = DT_cxxClass;
+ nameTag = DT_apiName;
dtd = "dtd/cxxClass.dtd";
version = "0.6.0";
- doctype = "<!DOCTYPE " + mainElement +
+ doctype = "<!DOCTYPE " + ditaTags[mainTag] +
" PUBLIC \"-//NOKIA//DTD DITA C++ API Class Reference Type v" +
version + "//EN\" \"" + dtd + "\">";
outputclass = "headerfile";
}
else if (node->subType() == Node::QmlClass) {
- mainElement = "cxxClass";
- nameElement = "apiName";
+ mainTag = DT_cxxClass;
+ nameTag = DT_apiName;
dtd = "dtd/cxxClass.dtd";
version = "0.6.0";
- doctype = "<!DOCTYPE " + mainElement +
+ doctype = "<!DOCTYPE " + ditaTags[mainTag] +
" PUBLIC \"-//NOKIA//DTD DITA C++ API Class Reference Type v" +
version + "//EN\" \"" + dtd + "\">";
outputclass = "QML-class";
}
else {
- mainElement = "topic";
- nameElement = "title";
+ mainTag = DT_topic;
+ nameTag = DT_title;
dtd = "dtd/topic.dtd";
- doctype = "<!DOCTYPE " + mainElement +
+ doctype = "<!DOCTYPE " + ditaTags[mainTag] +
" PUBLIC \"-//OASIS//DTD DITA Topic//EN\" \"" + dtd + "\">";
switch (node->subType()) {
case Node::Page:
@@ -2256,13 +2247,13 @@ void DitaXmlGenerator::generateHeader(const Node* node,
xmlWriter().writeDTD(doctype);
xmlWriter().writeComment(node->doc().location().fileName());
- xmlWriter().writeStartElement(mainElement);
+ writeStartTag(mainTag);
xmlWriter().writeAttribute("id",node->guid());
if (!outputclass.isEmpty())
xmlWriter().writeAttribute("outputclass",outputclass);
- xmlWriter().writeStartElement(nameElement); // <title> or <apiName>
+ writeStartTag(nameTag); // <title> or <apiName>
writeCharacters(name);
- xmlWriter().writeEndElement(); // </title> or </apiName>
+ writeEndTag(); // </title> or </apiName>
}
/*!
@@ -2283,9 +2274,9 @@ void DitaXmlGenerator::generateBrief(const Node* node, CodeMarker* marker)
void DitaXmlGenerator::generateIncludes(const InnerNode* inner, CodeMarker* marker)
{
if (!inner->includes().isEmpty()) {
- xmlWriter().writeStartElement("codeblock");
+ writeStartTag(DT_codeblock);
writeText(marker->markedUpIncludes(inner->includes()), marker, inner);
- xmlWriter().writeEndElement(); // </codeblock>
+ writeEndTag(); // </codeblock>
}
}
@@ -2557,20 +2548,20 @@ void DitaXmlGenerator::generateClassHierarchy(const Node* relative,
QStack<NodeMap > stack;
stack.push(topLevel);
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
while (!stack.isEmpty()) {
if (stack.top().isEmpty()) {
stack.pop();
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
if (!stack.isEmpty())
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
}
else {
const ClassNode *child =
static_cast<const ClassNode *>(*stack.top().begin());
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
generateFullName(child, relative, marker);
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
stack.top().erase(stack.top().begin());
NodeMap newTop;
@@ -2580,8 +2571,8 @@ void DitaXmlGenerator::generateClassHierarchy(const Node* relative,
}
if (!newTop.isEmpty()) {
stack.push(newTop);
- xmlWriter().writeStartElement("li");
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_li);
+ writeStartTag(DT_ul);
}
}
}
@@ -2597,11 +2588,11 @@ void DitaXmlGenerator::generateAnnotatedList(const Node* relative,
{
if (nodeMap.isEmpty())
return;
- xmlWriter().writeStartElement("table");
+ writeStartTag(DT_table);
xmlWriter().writeAttribute("outputclass","annotated");
- xmlWriter().writeStartElement("tgroup");
+ writeStartTag(DT_tgroup);
xmlWriter().writeAttribute("cols","2");
- xmlWriter().writeStartElement("tbody");
+ writeStartTag(DT_tbody);
foreach (const QString& name, nodeMap.keys()) {
const Node* node = nodeMap[name];
@@ -2609,35 +2600,35 @@ void DitaXmlGenerator::generateAnnotatedList(const Node* relative,
if (node->status() == Node::Obsolete)
continue;
- xmlWriter().writeStartElement("row");
- xmlWriter().writeStartElement("entry");
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_row);
+ writeStartTag(DT_entry);
+ writeStartTag(DT_p);
generateFullName(node, relative, marker);
- xmlWriter().writeEndElement(); // </p>
- xmlWriter().writeEndElement(); // <entry>
+ writeEndTag(); // </p>
+ writeEndTag(); // <entry>
if (!(node->type() == Node::Fake)) {
Text brief = node->doc().trimmedBriefText(name);
if (!brief.isEmpty()) {
- xmlWriter().writeStartElement("entry");
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_entry);
+ writeStartTag(DT_p);
generateText(brief, node, marker);
- xmlWriter().writeEndElement(); // </p>
- xmlWriter().writeEndElement(); // <entry>
+ writeEndTag(); // </p>
+ writeEndTag(); // <entry>
}
}
else {
- xmlWriter().writeStartElement("entry");
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_entry);
+ writeStartTag(DT_p);
writeCharacters(protectEnc(node->doc().briefText().toString())); // zzz
- xmlWriter().writeEndElement(); // </p>
- xmlWriter().writeEndElement(); // <entry>
+ writeEndTag(); // </p>
+ writeEndTag(); // <entry>
}
- xmlWriter().writeEndElement(); // </row>
+ writeEndTag(); // </row>
}
- xmlWriter().writeEndElement(); // </tbody>
- xmlWriter().writeEndElement(); // </tgroup>
- xmlWriter().writeEndElement(); // </table>
+ writeEndTag(); // </tbody>
+ writeEndTag(); // </tgroup>
+ writeEndTag(); // </table>
}
/*!
@@ -2774,27 +2765,27 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
Output the alphabet as a row of links.
*/
if (includeAlphabet) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","alphabet");
for (int i = 0; i < 26; i++) {
QChar ch('a' + i);
if (usedParagraphNames.contains(char('a' + i))) {
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
xmlWriter().writeCharacters(QString(ch.toUpper()));
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
}
}
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
/*
Output a <p> element to contain all the <dl> elements.
*/
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","compactlist");
for (int i=0; i<classMap.count()-1; i++) {
@@ -2809,25 +2800,25 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
*/
if (curParOffset == 0) {
if (i > 0) {
- xmlWriter().writeEndElement(); // </dlentry>
- xmlWriter().writeEndElement(); // </dl>
+ writeEndTag(); // </dlentry>
+ writeEndTag(); // </dl>
}
- xmlWriter().writeStartElement("dl");
- xmlWriter().writeStartElement("dlentry");
- xmlWriter().writeStartElement("dt");
+ writeStartTag(DT_dl);
+ writeStartTag(DT_dlentry);
+ writeStartTag(DT_dt);
if (includeAlphabet) {
QChar c = paragraphName[curParNr][0].toLower();
writeGuidAttribute(QString(c));
}
xmlWriter().writeAttribute("outputclass","sublist-header");
xmlWriter().writeCharacters(paragraphName[curParNr]);
- xmlWriter().writeEndElement(); // </dt>
+ writeEndTag(); // </dt>
}
/*
Output a <dd> for the current offset in the current paragraph.
*/
- xmlWriter().writeStartElement("dd");
+ writeStartTag(DT_dd);
if ((curParNr < NumParagraphs) &&
!paragraphName[curParNr].isEmpty()) {
NodeMap::Iterator it;
@@ -2839,7 +2830,7 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
Previously, we used generateFullName() for this, but we
require some special formatting.
*/
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",linkForNode(it.value(), relative));
@@ -2849,19 +2840,19 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
else
pieces = fullName(it.value(), relative, marker).split("::");
xmlWriter().writeCharacters(protectEnc(pieces.last()));
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
if (pieces.size() > 1) {
xmlWriter().writeCharacters(" (");
generateFullName(it.value()->parent(),relative,marker);
xmlWriter().writeCharacters(")");
}
}
- xmlWriter().writeEndElement(); // </dd>
+ writeEndTag(); // </dd>
curParOffset++;
}
- xmlWriter().writeEndElement(); // </dlentry>
- xmlWriter().writeEndElement(); // </dl>
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </dlentry>
+ writeEndTag(); // </dl>
+ writeEndTag(); // </p>
}
/*!
@@ -2870,35 +2861,35 @@ void DitaXmlGenerator::generateCompactList(const Node* relative,
void DitaXmlGenerator::generateFunctionIndex(const Node* relative,
CodeMarker* marker)
{
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","alphabet");
for (int i = 0; i < 26; i++) {
QChar ch('a' + i);
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
QString guid = lookupGuid(outFileName(),QString(ch));
QString attr = outFileName() + QString("#%1").arg(guid);
xmlWriter().writeAttribute("href", attr);
xmlWriter().writeCharacters(QString(ch.toUpper()));
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
}
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
char nextLetter = 'a';
char currentLetter;
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
QMap<QString, NodeMap >::ConstIterator f = funcIndex.begin();
while (f != funcIndex.end()) {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
currentLetter = f.key()[0].unicode();
while (islower(currentLetter) && currentLetter >= nextLetter) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
writeGuidAttribute(QString(nextLetter));
xmlWriter().writeAttribute("outputclass","target");
xmlWriter().writeCharacters(QString(nextLetter));
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
nextLetter++;
}
xmlWriter().writeCharacters(protectEnc(f.key()));
@@ -2909,10 +2900,10 @@ void DitaXmlGenerator::generateFunctionIndex(const Node* relative,
generateFullName((*s)->parent(), relative, marker, *s);
++s;
}
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
++f;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
/*!
@@ -2925,14 +2916,14 @@ void DitaXmlGenerator::generateLegaleseList(const Node* relative,
while (it != legaleseTexts.end()) {
Text text = it.key();
generateText(text, relative, marker);
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
do {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
generateFullName(it.value(), relative, marker);
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
++it;
} while (it != legaleseTexts.end() && it.key() == text);
- xmlWriter().writeEndElement(); //</ul>
+ writeEndTag(); //</ul>
}
}
@@ -3053,53 +3044,53 @@ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /*
if (!fakeNodeMap.isEmpty()) {
foreach (const QString& groupTitle, groupTitlesMap.keys()) {
const FakeNode* groupNode = groupTitlesMap[groupTitle];
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","h3");
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",linkForNode(groupNode, relative));
writeCharacters(protectEnc(groupNode->fullTitle()));
- xmlWriter().writeEndElement(); // </xref>
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </xref>
+ writeEndTag(); // </p>
if (fakeNodeMap[groupNode].count() == 0)
continue;
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
foreach (const FakeNode* fakeNode, fakeNodeMap[groupNode]) {
QString title = fakeNode->fullTitle();
if (title.startsWith("The "))
title.remove(0, 4);
- xmlWriter().writeStartElement("li");
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_li);
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
- xmlWriter().writeEndElement(); // </xref>
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </xref>
+ writeEndTag(); // </li>
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
}
if (!uncategorizedNodeMap.isEmpty()) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","h3");
xmlWriter().writeCharacters("Miscellaneous");
- xmlWriter().writeEndElement(); // </p>
- xmlWriter().writeStartElement("ul");
+ writeEndTag(); // </p>
+ writeStartTag(DT_ul);
foreach (const FakeNode *fakeNode, uncategorizedNodeMap) {
QString title = fakeNode->fullTitle();
if (title.startsWith("The "))
title.remove(0, 4);
- xmlWriter().writeStartElement("li");
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_li);
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative));
writeCharacters(protectEnc(title));
- xmlWriter().writeEndElement(); // </xref>
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </xref>
+ writeEndTag(); // </li>
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
}
@@ -3114,18 +3105,18 @@ void DitaXmlGenerator::generateSection(const NodeList& nl,
CodeMarker::SynopsisStyle style)
{
if (!nl.isEmpty()) {
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
NodeList::ConstIterator m = nl.begin();
while (m != nl.end()) {
if ((*m)->access() != Node::Private) {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
QString marked = getMarkedUpSynopsis(*m, relative, marker, style);
writeText(marked, marker, relative);
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
}
++m;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
}
@@ -3138,10 +3129,10 @@ void DitaXmlGenerator::generateSectionInheritedList(const Section& section,
{
if (section.inherited.isEmpty())
return;
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
QList<QPair<ClassNode*,int> >::ConstIterator p = section.inherited.begin();
while (p != section.inherited.end()) {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
QString text;
text.setNum((*p).second);
text += " ";
@@ -3151,7 +3142,7 @@ void DitaXmlGenerator::generateSectionInheritedList(const Section& section,
text += section.pluralMember;
text += " inherited from ";
writeCharacters(text);
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
// zzz
text = fileName((*p).first) + "#";
@@ -3159,11 +3150,11 @@ void DitaXmlGenerator::generateSectionInheritedList(const Section& section,
xmlWriter().writeAttribute("href",text);
text = protectEnc(marker->plainFullName((*p).first, relative));
writeCharacters(text);
- xmlWriter().writeEndElement(); // </xref>
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </xref>
+ writeEndTag(); // </li>
++p;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
/*!
@@ -3312,18 +3303,18 @@ void DitaXmlGenerator::writeText(const QString& markedCode,
writeCharacters(html);
html.clear();
}
- xmlWriter().writeStartElement("i");
+ writeStartTag(DT_i);
writeCharacters(arg.toString());
- xmlWriter().writeEndElement(); // </i>
+ writeEndTag(); // </i>
}
else if (k == 5) { // <@extra>
if (!html.isEmpty()) {
writeCharacters(html);
html.clear();
}
- xmlWriter().writeStartElement("tt");
+ writeStartTag(DT_tt);
writeCharacters(arg.toString());
- xmlWriter().writeEndElement(); // </tt>
+ writeEndTag(); // </tt>
}
else {
if (!html.isEmpty()) {
@@ -3375,10 +3366,10 @@ void DitaXmlGenerator::generateLink(const Atom* atom,
writeCharacters(protectEnc(atom->string().left(k)));
if (link.isEmpty()) {
if (showBrokenLinks)
- xmlWriter().writeEndElement(); // </i>
+ writeEndTag(); // </i>
}
else
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
inLink = false;
writeCharacters(protectEnc(atom->string().mid(k)));
}
@@ -3387,12 +3378,12 @@ void DitaXmlGenerator::generateLink(const Atom* atom,
bool func = atom->string().endsWith("()");
bool tt = (func || atom->string().contains(camelCase));
if (tt)
- xmlWriter().writeStartElement("tt");
+ writeStartTag(DT_tt);
if (func)
writeCharacters(protectEnc(atom->string().left(atom->string().length() - 2)));
else
writeCharacters(protectEnc(atom->string()));
- xmlWriter().writeEndElement(); // </tt>
+ writeEndTag(); // </tt>
}
else
writeCharacters(protectEnc(atom->string()));
@@ -3727,12 +3718,12 @@ void DitaXmlGenerator::generateFullName(const Node* apparentNode,
{
if (actualNode == 0)
actualNode = apparentNode;
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
QString href = linkForNode(actualNode, relative);
xmlWriter().writeAttribute("href",href);
writeCharacters(protectEnc(fullName(apparentNode, relative, marker)));
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
}
void DitaXmlGenerator::findAllClasses(const InnerNode* node)
@@ -4156,7 +4147,7 @@ void DitaXmlGenerator::beginLink(const QString& link)
this->link = link;
if (link.isEmpty())
return;
- xmlWriter().writeStartElement("xref");
+ writeStartTag(DT_xref);
// formathtml
xmlWriter().writeAttribute("href",link);
inLink = true;
@@ -4167,15 +4158,15 @@ void DitaXmlGenerator::endLink()
if (inLink) {
if (link.isEmpty()) {
if (showBrokenLinks)
- xmlWriter().writeEndElement(); // </i>
+ writeEndTag(); // </i>
}
else {
if (inObsoleteLink) {
- xmlWriter().writeStartElement("sup");
+ writeStartTag(DT_sup);
xmlWriter().writeCharacters("(obsolete)");
- xmlWriter().writeEndElement(); // </sup>
+ writeEndTag(); // </sup>
}
- xmlWriter().writeEndElement(); // </xref>
+ writeEndTag(); // </xref>
}
}
inLink = false;
@@ -4193,16 +4184,16 @@ void DitaXmlGenerator::generateQmlSummary(const Section& section,
CodeMarker* marker)
{
if (!section.members.isEmpty()) {
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
NodeList::ConstIterator m;
m = section.members.begin();
while (m != section.members.end()) {
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
generateQmlItem(*m,relative,marker,true);
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
++m;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
}
@@ -4220,11 +4211,11 @@ void DitaXmlGenerator::generateDetailedQmlMember(const Node* node,
if (node->subType() == Node::QmlPropertyGroup) {
const QmlPropGroupNode* qpgn = static_cast<const QmlPropGroupNode*>(node);
NodeList::ConstIterator p = qpgn->childNodes().begin();
- xmlWriter().writeStartElement("ul");
+ writeStartTag(DT_ul);
while (p != qpgn->childNodes().end()) {
if ((*p)->type() == Node::QmlProperty) {
qpn = static_cast<const QmlPropertyNode*>(*p);
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_li);
writeGuidAttribute((Node*)qpn);
QString attr;
if (!qpn->isWritable(myTree))
@@ -4237,31 +4228,31 @@ void DitaXmlGenerator::generateDetailedQmlMember(const Node* node,
if (!attr.isEmpty())
xmlWriter().writeAttribute("outputclass",attr);
generateQmlItem(qpn, relative, marker, false);
- xmlWriter().writeEndElement(); // </li>
+ writeEndTag(); // </li>
}
++p;
}
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </ul>
}
else if (node->type() == Node::QmlSignal) {
Node* n = const_cast<Node*>(node);
- xmlWriter().writeStartElement("ul");
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_ul);
+ writeStartTag(DT_li);
writeGuidAttribute(n);
marked = getMarkedUpSynopsis(n, relative, marker, CodeMarker::Detailed);
writeText(marked, marker, relative);
- xmlWriter().writeEndElement(); // </li>
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </li>
+ writeEndTag(); // </ul>
}
else if (node->type() == Node::QmlMethod) {
Node* n = const_cast<Node*>(node);
- xmlWriter().writeStartElement("ul");
- xmlWriter().writeStartElement("li");
+ writeStartTag(DT_ul);
+ writeStartTag(DT_li);
writeGuidAttribute(n);
marked = getMarkedUpSynopsis(n, relative, marker, CodeMarker::Detailed);
writeText(marked, marker, relative);
- xmlWriter().writeEndElement(); // </li>
- xmlWriter().writeEndElement(); // </ul>
+ writeEndTag(); // </li>
+ writeEndTag(); // </ul>
}
generateStatus(node, marker);
generateBody(node, marker);
@@ -4285,7 +4276,7 @@ void DitaXmlGenerator::generateQmlInherits(const QmlClassNode* cn,
const Node* n = myTree->findNode(strList,Node::Fake);
if (n && n->subType() == Node::QmlClass) {
const QmlClassNode* qcn = static_cast<const QmlClassNode*>(n);
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","inherits");
Text text;
text << "[Inherits ";
@@ -4295,7 +4286,7 @@ void DitaXmlGenerator::generateQmlInherits(const QmlClassNode* cn,
text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK);
text << "]";
generateText(text, cn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
}
}
@@ -4333,7 +4324,7 @@ void DitaXmlGenerator::generateQmlInstantiates(const QmlClassNode* qcn,
{
const ClassNode* cn = qcn->classNode();
if (cn && (cn->status() != Node::Internal)) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","instantiates");
Text text;
text << "[";
@@ -4348,7 +4339,7 @@ void DitaXmlGenerator::generateQmlInstantiates(const QmlClassNode* qcn,
text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK);
text << "]";
generateText(text, qcn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
}
@@ -4365,7 +4356,7 @@ void DitaXmlGenerator::generateInstantiatedBy(const ClassNode* cn,
if (cn && cn->status() != Node::Internal && !cn->qmlElement().isEmpty()) {
const Node* n = myTree->root()->findNode(cn->qmlElement(),Node::Fake);
if (n && n->subType() == Node::QmlClass) {
- xmlWriter().writeStartElement("p");
+ writeStartTag(DT_p);
xmlWriter().writeAttribute("outputclass","instantiated-by");
Text text;
text << "[";
@@ -4380,7 +4371,7 @@ void DitaXmlGenerator::generateInstantiatedBy(const ClassNode* cn,
text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK);
text << "]";
generateText(text, cn, marker);
- xmlWriter().writeEndElement(); // </p>
+ writeEndTag(); // </p>
}
}
}
@@ -4436,32 +4427,32 @@ void DitaXmlGenerator::writeDerivations(const ClassNode* cn, CodeMarker* marker)
int index;
if (!cn->baseClasses().isEmpty()) {
- xmlWriter().writeStartElement(CXXCLASSDERIVATIONS);
+ writeStartTag(DT_cxxClassDerivations);
r = cn->baseClasses().begin();
index = 0;
while (r != cn->baseClasses().end()) {
- xmlWriter().writeStartElement(CXXCLASSDERIVATION);
- xmlWriter().writeStartElement(CXXCLASSDERIVATIONACCESSSPECIFIER);
+ writeStartTag(DT_cxxClassDerivation);
+ writeStartTag(DT_cxxClassDerivationAccessSpecifier);
xmlWriter().writeAttribute("value",(*r).accessString());
- xmlWriter().writeEndElement(); // </cxxClassDerivationAccessSpecifier>
+ writeEndTag(); // </cxxClassDerivationAccessSpecifier>
// not included: <cxxClassDerivationVirtual>
- xmlWriter().writeStartElement(CXXCLASSBASECLASS);
+ writeStartTag(DT_cxxClassBaseClass);
QString attr = fileName((*r).node) + "#" + (*r).node->guid();
xmlWriter().writeAttribute("href",attr);
writeCharacters(marker->plainFullName((*r).node));
- xmlWriter().writeEndElement(); // </cxxClassBaseClass>
+ writeEndTag(); // </cxxClassBaseClass>
// not included: <ClassBaseStruct> or <cxxClassBaseUnion>
- xmlWriter().writeEndElement(); // </cxxClassDerivation>
+ writeEndTag(); // </cxxClassDerivation>
// not included: <cxxStructDerivation>
++r;
}
- xmlWriter().writeEndElement(); // </cxxClassDerivations>
+ writeEndTag(); // </cxxClassDerivations>
}
}
@@ -4472,73 +4463,77 @@ void DitaXmlGenerator::writeDerivations(const ClassNode* cn, CodeMarker* marker)
*/
void DitaXmlGenerator::writeLocation(const Node* n)
{
- QString s1, s2, s3, s4, s5, s6;
+ DitaTag s1, s2, s3, s4, s5, s6;
+ s1 = DT_cxxClassAPIItemLocation;
+ s2 = DT_cxxClassDeclarationFile;
+ s3 = DT_cxxClassDeclarationFileLine;
+ s4 = DT_LAST;
if (n->type() == Node::Class || n->type() == Node::Namespace) {
- s1 = CXXCLASSAPIITEMLOCATION;
- s2 = CXXCLASSDECLARATIONFILE;
- s3 = CXXCLASSDECLARATIONFILELINE;
+ s1 = DT_cxxClassAPIItemLocation;
+ s2 = DT_cxxClassDeclarationFile;
+ s3 = DT_cxxClassDeclarationFileLine;
}
else if (n->type() == Node::Function) {
FunctionNode* fn = const_cast<FunctionNode*>(static_cast<const FunctionNode*>(n));
if (fn->isMacro()) {
- s1 = CXXDEFINEAPIITEMLOCATION;
- s2 = CXXDEFINEDECLARATIONFILE;
- s3 = CXXDEFINEDECLARATIONFILELINE;
+ s1 = DT_cxxDefineAPIItemLocation;
+ s2 = DT_cxxDefineDeclarationFile;
+ s3 = DT_cxxDefineDeclarationFileLine;
}
else {
- s1 = CXXFUNCTIONAPIITEMLOCATION;
- s2 = CXXFUNCTIONDECLARATIONFILE;
- s3 = CXXFUNCTIONDECLARATIONFILELINE;
+ s1 = DT_cxxFunctionAPIItemLocation;
+ s2 = DT_cxxFunctionDeclarationFile;
+ s3 = DT_cxxFunctionDeclarationFileLine;
}
}
else if (n->type() == Node::Enum) {
- s1 = CXXENUMERATIONAPIITEMLOCATION;
- s2 = CXXENUMERATIONDECLARATIONFILE;
- s3 = CXXENUMERATIONDECLARATIONFILELINE;
- s4 = CXXENUMERATIONDEFINITIONFILE;
- s5 = CXXENUMERATIONDEFINITIONFILELINESTART;
- s6 = CXXENUMERATIONDEFINITIONFILELINEEND;
+ s1 = DT_cxxEnumerationAPIItemLocation;
+ s2 = DT_cxxEnumerationDeclarationFile;
+ s3 = DT_cxxEnumerationDeclarationFileLine;
+ s4 = DT_cxxEnumerationDefinitionFile;
+ s5 = DT_cxxEnumerationDefinitionFileLineStart;
+ s6 = DT_cxxEnumerationDefinitionFileLineEnd;
}
else if (n->type() == Node::Typedef) {
- s1 = CXXTYPEDEFAPIITEMLOCATION;
- s2 = CXXTYPEDEFDECLARATIONFILE;
- s3 = CXXTYPEDEFDECLARATIONFILELINE;
+ s1 = DT_cxxTypedefAPIItemLocation;
+ s2 = DT_cxxTypedefDeclarationFile;
+ s3 = DT_cxxTypedefDeclarationFileLine;
}
else if ((n->type() == Node::Property) ||
(n->type() == Node::Variable)) {
- s1 = CXXVARIABLEAPIITEMLOCATION;
- s2 = CXXVARIABLEDECLARATIONFILE;
- s3 = CXXVARIABLEDECLARATIONFILELINE;
+ s1 = DT_cxxVariableAPIItemLocation;
+ s2 = DT_cxxVariableDeclarationFile;
+ s3 = DT_cxxVariableDeclarationFileLine;
}
- xmlWriter().writeStartElement(s1);
- xmlWriter().writeStartElement(s2);
+ writeStartTag(s1);
+ writeStartTag(s2);
xmlWriter().writeAttribute("name","filePath");
xmlWriter().writeAttribute("value",n->location().filePath());
- xmlWriter().writeEndElement(); // </cxx<s2>DeclarationFile>
- xmlWriter().writeStartElement(s3);
+ writeEndTag(); // </cxx<s2>DeclarationFile>
+ writeStartTag(s3);
xmlWriter().writeAttribute("name","lineNumber");
QString lineNr;
xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo()));
- xmlWriter().writeEndElement(); // </cxx<s3>DeclarationFileLine>
- if (!s4.isEmpty()) { // zzz This stuff is temporary, I think.
- xmlWriter().writeStartElement(s4);
+ writeEndTag(); // </cxx<s3>DeclarationFileLine>
+ if (s4 != DT_LAST) { // zzz This stuff is temporary, I think.
+ writeStartTag(s4);
xmlWriter().writeAttribute("name","filePath");
xmlWriter().writeAttribute("value",n->location().filePath());
- xmlWriter().writeEndElement(); // </cxx<s4>DefinitionFile>
- xmlWriter().writeStartElement(s5);
+ writeEndTag(); // </cxx<s4>DefinitionFile>
+ writeStartTag(s5);
xmlWriter().writeAttribute("name","lineNumber");
xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo()));
- xmlWriter().writeEndElement(); // </cxx<s5>DefinitionFileLineStart>
- xmlWriter().writeStartElement(s6);
+ writeEndTag(); // </cxx<s5>DefinitionFileLineStart>
+ writeStartTag(s6);
xmlWriter().writeAttribute("name","lineNumber");
xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo()));
- xmlWriter().writeEndElement(); // </cxx<s6>DefinitionFileLineEnd>
+ writeEndTag(); // </cxx<s6>DefinitionFileLineEnd>
}
// not included: <cxxXXXDefinitionFile>, <cxxXXXDefinitionFileLineStart>,
// and <cxxXXXDefinitionFileLineEnd>
- xmlWriter().writeEndElement(); // </cxx<s1>ApiItemLocation>
+ writeEndTag(); // </cxx<s1>ApiItemLocation>
}
/*!
@@ -4553,90 +4548,90 @@ void DitaXmlGenerator::writeFunctions(const Section& s,
while (m != s.members.end()) {
if ((*m)->type() == Node::Function) {
FunctionNode* fn = const_cast<FunctionNode*>(static_cast<const FunctionNode*>(*m));
- xmlWriter().writeStartElement(CXXFUNCTION);
+ writeStartTag(DT_cxxFunction);
xmlWriter().writeAttribute("id",fn->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
if (fn->metaness() == FunctionNode::Signal)
xmlWriter().writeAttribute("class","signal");
else if (fn->metaness() == FunctionNode::Slot)
xmlWriter().writeAttribute("class","slot");
writeCharacters(fn->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(fn,marker);
// not included: <prolog>
- xmlWriter().writeStartElement(CXXFUNCTIONDETAIL);
- xmlWriter().writeStartElement(CXXFUNCTIONDEFINITION);
- xmlWriter().writeStartElement(CXXFUNCTIONACCESSSPECIFIER);
+ writeStartTag(DT_cxxFunctionDetail);
+ writeStartTag(DT_cxxFunctionDefinition);
+ writeStartTag(DT_cxxFunctionAccessSpecifier);
xmlWriter().writeAttribute("value",fn->accessString());
- xmlWriter().writeEndElement(); // <cxxFunctionAccessSpecifier>
+ writeEndTag(); // <cxxFunctionAccessSpecifier>
// not included: <cxxFunctionStorageClassSpecifierExtern>
if (fn->isStatic()) {
- xmlWriter().writeStartElement(CXXFUNCTIONSTORAGECLASSSPECIFIERSTATIC);
+ writeStartTag(DT_cxxFunctionStorageClassSpecifierStatic);
xmlWriter().writeAttribute("name","static");
xmlWriter().writeAttribute("value","static");
- xmlWriter().writeEndElement(); // <cxxFunctionStorageClassSpecifierStatic>
+ writeEndTag(); // <cxxFunctionStorageClassSpecifierStatic>
}
// not included: <cxxFunctionStorageClassSpecifierMutable>,
if (fn->isConst()) {
- xmlWriter().writeStartElement(CXXFUNCTIONCONST);
+ writeStartTag(DT_cxxFunctionConst);
xmlWriter().writeAttribute("name","const");
xmlWriter().writeAttribute("value","const");
- xmlWriter().writeEndElement(); // <cxxFunctionConst>
+ writeEndTag(); // <cxxFunctionConst>
}
// not included: <cxxFunctionExplicit>
// <cxxFunctionInline
if (fn->virtualness() != FunctionNode::NonVirtual) {
- xmlWriter().writeStartElement(CXXFUNCTIONVIRTUAL);
+ writeStartTag(DT_cxxFunctionVirtual);
xmlWriter().writeAttribute("name","virtual");
xmlWriter().writeAttribute("value","virtual");
- xmlWriter().writeEndElement(); // <cxxFunctionVirtual>
+ writeEndTag(); // <cxxFunctionVirtual>
if (fn->virtualness() == FunctionNode::PureVirtual) {
- xmlWriter().writeStartElement(CXXFUNCTIONPUREVIRTUAL);
+ writeStartTag(DT_cxxFunctionPureVirtual);
xmlWriter().writeAttribute("name","pure virtual");
xmlWriter().writeAttribute("value","pure virtual");
- xmlWriter().writeEndElement(); // <cxxFunctionPureVirtual>
+ writeEndTag(); // <cxxFunctionPureVirtual>
}
}
if (fn->name() == n->name()) {
- xmlWriter().writeStartElement(CXXFUNCTIONCONSTRUCTOR);
+ writeStartTag(DT_cxxFunctionConstructor);
xmlWriter().writeAttribute("name","constructor");
xmlWriter().writeAttribute("value","constructor");
- xmlWriter().writeEndElement(); // <cxxFunctionConstructor>
+ writeEndTag(); // <cxxFunctionConstructor>
}
else if (fn->name()[0] == QChar('~')) {
- xmlWriter().writeStartElement(CXXFUNCTIONDESTRUCTOR);
+ writeStartTag(DT_cxxFunctionDestructor);
xmlWriter().writeAttribute("name","destructor");
xmlWriter().writeAttribute("value","destructor");
- xmlWriter().writeEndElement(); // <cxxFunctionDestructor>
+ writeEndTag(); // <cxxFunctionDestructor>
}
else {
- xmlWriter().writeStartElement(CXXFUNCTIONDECLAREDTYPE);
+ writeStartTag(DT_cxxFunctionDeclaredType);
writeCharacters(fn->returnType());
- xmlWriter().writeEndElement(); // <cxxFunctionDeclaredType>
+ writeEndTag(); // <cxxFunctionDeclaredType>
}
// not included: <cxxFunctionReturnType>
QString fq = fullQualification(fn);
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXFUNCTIONSCOPEDNAME);
+ writeStartTag(DT_cxxFunctionScopedName);
writeCharacters(fq);
- xmlWriter().writeEndElement(); // <cxxFunctionScopedName>
+ writeEndTag(); // <cxxFunctionScopedName>
}
- xmlWriter().writeStartElement(CXXFUNCTIONPROTOTYPE);
+ writeStartTag(DT_cxxFunctionPrototype);
writeCharacters(fn->signature(true));
- xmlWriter().writeEndElement(); // <cxxFunctionPrototype>
+ writeEndTag(); // <cxxFunctionPrototype>
QString fnl = fn->signature(false);
int idx = fnl.indexOf(' ');
@@ -4645,30 +4640,30 @@ void DitaXmlGenerator::writeFunctions(const Section& s,
else
++idx;
fnl = fn->parent()->name() + "::" + fnl.mid(idx);
- xmlWriter().writeStartElement(CXXFUNCTIONNAMELOOKUP);
+ writeStartTag(DT_cxxFunctionNameLookup);
writeCharacters(fnl);
- xmlWriter().writeEndElement(); // <cxxFunctionNameLookup>
+ writeEndTag(); // <cxxFunctionNameLookup>
if (!fn->isInternal() && fn->isReimp() && fn->reimplementedFrom() != 0) {
FunctionNode* rfn = (FunctionNode*)fn->reimplementedFrom();
if (rfn && !rfn->isInternal()) {
- xmlWriter().writeStartElement(CXXFUNCTIONREIMPLEMENTED);
+ writeStartTag(DT_cxxFunctionReimplemented);
xmlWriter().writeAttribute("href",rfn->ditaXmlHref());
writeCharacters(marker->plainFullName(rfn));
- xmlWriter().writeEndElement(); // </cxxFunctionReimplemented>
+ writeEndTag(); // </cxxFunctionReimplemented>
}
}
writeParameters(fn);
writeLocation(fn);
- xmlWriter().writeEndElement(); // <cxxFunctionDefinition>
+ writeEndTag(); // <cxxFunctionDefinition>
writeDetailedDescription(fn, marker, true, QString());
// generateAlsoList(inner, marker);
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxFunctionDetail>
- xmlWriter().writeEndElement(); // </cxxFunction>
+ writeEndTag(); // </cxxFunctionDetail>
+ writeEndTag(); // </cxxFunction>
if (fn->metaness() == FunctionNode::Ctor ||
fn->metaness() == FunctionNode::Dtor ||
@@ -4686,33 +4681,33 @@ void DitaXmlGenerator::writeParameters(const FunctionNode* fn)
{
const QList<Parameter>& parameters = fn->parameters();
if (!parameters.isEmpty()) {
- xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERS);
+ writeStartTag(DT_cxxFunctionParameters);
QList<Parameter>::ConstIterator p = parameters.begin();
while (p != parameters.end()) {
- xmlWriter().writeStartElement(CXXFUNCTIONPARAMETER);
- xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDECLAREDTYPE);
+ writeStartTag(DT_cxxFunctionParameter);
+ writeStartTag(DT_cxxFunctionParameterDeclaredType);
writeCharacters((*p).leftType());
if (!(*p).rightType().isEmpty())
writeCharacters((*p).rightType());
- xmlWriter().writeEndElement(); // <cxxFunctionParameterDeclaredType>
- xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDECLARATIONNAME);
+ writeEndTag(); // <cxxFunctionParameterDeclaredType>
+ writeStartTag(DT_cxxFunctionParameterDeclarationName);
writeCharacters((*p).name());
- xmlWriter().writeEndElement(); // <cxxFunctionParameterDeclarationName>
+ writeEndTag(); // <cxxFunctionParameterDeclarationName>
// not included: <cxxFunctionParameterDefinitionName>
if (!(*p).defaultValue().isEmpty()) {
- xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDEFAULTVALUE);
+ writeStartTag(DT_cxxFunctionParameterDefaultValue);
writeCharacters((*p).defaultValue());
- xmlWriter().writeEndElement(); // <cxxFunctionParameterDefaultValue>
+ writeEndTag(); // <cxxFunctionParameterDefaultValue>
}
// not included: <apiDefNote>
- xmlWriter().writeEndElement(); // <cxxFunctionParameter>
+ writeEndTag(); // <cxxFunctionParameter>
++p;
}
- xmlWriter().writeEndElement(); // <cxxFunctionParameters>
+ writeEndTag(); // <cxxFunctionParameters>
}
}
@@ -4727,32 +4722,32 @@ void DitaXmlGenerator::writeEnumerations(const Section& s,
while (m != s.members.end()) {
if ((*m)->type() == Node::Enum) {
const EnumNode* en = static_cast<const EnumNode*>(*m);
- xmlWriter().writeStartElement(CXXENUMERATION);
+ writeStartTag(DT_cxxEnumeration);
xmlWriter().writeAttribute("id",en->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
writeCharacters(en->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(en,marker);
// not included <prolog>
- xmlWriter().writeStartElement(CXXENUMERATIONDETAIL);
- xmlWriter().writeStartElement(CXXENUMERATIONDEFINITION);
- xmlWriter().writeStartElement(CXXENUMERATIONACCESSSPECIFIER);
+ writeStartTag(DT_cxxEnumerationDetail);
+ writeStartTag(DT_cxxEnumerationDefinition);
+ writeStartTag(DT_cxxEnumerationAccessSpecifier);
xmlWriter().writeAttribute("value",en->accessString());
- xmlWriter().writeEndElement(); // <cxxEnumerationAccessSpecifier>
+ writeEndTag(); // <cxxEnumerationAccessSpecifier>
QString fq = fullQualification(en);
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXENUMERATIONSCOPEDNAME);
+ writeStartTag(DT_cxxEnumerationScopedName);
writeCharacters(fq);
- xmlWriter().writeEndElement(); // <cxxEnumerationScopedName>
+ writeEndTag(); // <cxxEnumerationScopedName>
}
const QList<EnumItem>& items = en->items();
if (!items.isEmpty()) {
- xmlWriter().writeStartElement(CXXENUMERATIONPROTOTYPE);
+ writeStartTag(DT_cxxEnumerationPrototype);
writeCharacters(en->name());
xmlWriter().writeCharacters(" = { ");
QList<EnumItem>::ConstIterator i = items.begin();
@@ -4767,68 +4762,68 @@ void DitaXmlGenerator::writeEnumerations(const Section& s,
xmlWriter().writeCharacters(", ");
}
xmlWriter().writeCharacters(" }");
- xmlWriter().writeEndElement(); // <cxxEnumerationPrototype>
+ writeEndTag(); // <cxxEnumerationPrototype>
}
- xmlWriter().writeStartElement(CXXENUMERATIONNAMELOOKUP);
+ writeStartTag(DT_cxxEnumerationNameLookup);
writeCharacters(en->parent()->name() + "::" + en->name());
- xmlWriter().writeEndElement(); // <cxxEnumerationNameLookup>
+ writeEndTag(); // <cxxEnumerationNameLookup>
// not included: <cxxEnumerationReimplemented>
if (!items.isEmpty()) {
- xmlWriter().writeStartElement(CXXENUMERATORS);
+ writeStartTag(DT_cxxEnumerators);
QList<EnumItem>::ConstIterator i = items.begin();
while (i != items.end()) {
- xmlWriter().writeStartElement(CXXENUMERATOR);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_cxxEnumerator);
+ writeStartTag(DT_apiName);
writeCharacters((*i).name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
QString fq = fullQualification(en->parent());
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXENUMERATORSCOPEDNAME);
+ writeStartTag(DT_cxxEnumeratorScopedName);
writeCharacters(fq + "::" + (*i).name());
- xmlWriter().writeEndElement(); // <cxxEnumeratorScopedName>
+ writeEndTag(); // <cxxEnumeratorScopedName>
}
- xmlWriter().writeStartElement(CXXENUMERATORPROTOTYPE);
+ writeStartTag(DT_cxxEnumeratorPrototype);
writeCharacters((*i).name());
- xmlWriter().writeEndElement(); // <cxxEnumeratorPrototype>
- xmlWriter().writeStartElement(CXXENUMERATORNAMELOOKUP);
+ writeEndTag(); // <cxxEnumeratorPrototype>
+ writeStartTag(DT_cxxEnumeratorNameLookup);
writeCharacters(en->parent()->name() + "::" + (*i).name());
- xmlWriter().writeEndElement(); // <cxxEnumeratorNameLookup>
+ writeEndTag(); // <cxxEnumeratorNameLookup>
if (!(*i).value().isEmpty()) {
- xmlWriter().writeStartElement(CXXENUMERATORINITIALISER);
+ writeStartTag(DT_cxxEnumeratorInitialiser);
xmlWriter().writeAttribute("value", (*i).value());
- xmlWriter().writeEndElement(); // <cxxEnumeratorInitialiser>
+ writeEndTag(); // <cxxEnumeratorInitialiser>
}
// not included: <cxxEnumeratorAPIItemLocation>
if (!(*i).text().isEmpty()) {
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_apiDesc);
generateText((*i).text(), en, marker);
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
}
- xmlWriter().writeEndElement(); // <cxxEnumerator>
+ writeEndTag(); // <cxxEnumerator>
++i;
}
- xmlWriter().writeEndElement(); // <cxxEnumerators>
+ writeEndTag(); // <cxxEnumerators>
}
writeLocation(en);
- xmlWriter().writeEndElement(); // <cxxEnumerationDefinition>
+ writeEndTag(); // <cxxEnumerationDefinition>
writeDetailedDescription(en, marker, true, QString());
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxEnumerationDetail>
+ writeEndTag(); // </cxxEnumerationDetail>
// not included: <related-links>
- xmlWriter().writeEndElement(); // </cxxEnumeration>
+ writeEndTag(); // </cxxEnumeration>
}
++m;
}
@@ -4846,52 +4841,52 @@ void DitaXmlGenerator::writeTypedefs(const Section& s,
while (m != s.members.end()) {
if ((*m)->type() == Node::Typedef) {
const TypedefNode* tn = static_cast<const TypedefNode*>(*m);
- xmlWriter().writeStartElement(CXXTYPEDEF);
+ writeStartTag(DT_cxxTypedef);
xmlWriter().writeAttribute("id",tn->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
writeCharacters(tn->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(tn,marker);
// not included: <prolog>
- xmlWriter().writeStartElement(CXXTYPEDEFDETAIL);
- xmlWriter().writeStartElement(CXXTYPEDEFDEFINITION);
- xmlWriter().writeStartElement(CXXTYPEDEFACCESSSPECIFIER);
+ writeStartTag(DT_cxxTypedefDetail);
+ writeStartTag(DT_cxxTypedefDefinition);
+ writeStartTag(DT_cxxTypedefAccessSpecifier);
xmlWriter().writeAttribute("value",tn->accessString());
- xmlWriter().writeEndElement(); // <cxxTypedefAccessSpecifier>
+ writeEndTag(); // <cxxTypedefAccessSpecifier>
// not included: <cxxTypedefDeclaredType>
QString fq = fullQualification(tn);
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXTYPEDEFSCOPEDNAME);
+ writeStartTag(DT_cxxTypedefScopedName);
writeCharacters(fq);
- xmlWriter().writeEndElement(); // <cxxTypedefScopedName>
+ writeEndTag(); // <cxxTypedefScopedName>
}
// not included: <cxxTypedefPrototype>
- xmlWriter().writeStartElement(CXXTYPEDEFNAMELOOKUP);
+ writeStartTag(DT_cxxTypedefNameLookup);
writeCharacters(tn->parent()->name() + "::" + tn->name());
- xmlWriter().writeEndElement(); // <cxxTypedefNameLookup>
+ writeEndTag(); // <cxxTypedefNameLookup>
// not included: <cxxTypedefReimplemented>
writeLocation(tn);
- xmlWriter().writeEndElement(); // <cxxTypedefDefinition>
+ writeEndTag(); // <cxxTypedefDefinition>
writeDetailedDescription(tn, marker, true, QString());
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxTypedefDetail>
+ writeEndTag(); // </cxxTypedefDetail>
// not included: <related-links>
- xmlWriter().writeEndElement(); // </cxxTypedef>
+ writeEndTag(); // </cxxTypedef>
}
++m;
}
@@ -4909,22 +4904,22 @@ void DitaXmlGenerator::writeProperties(const Section& s,
while (m != s.members.end()) {
if ((*m)->type() == Node::Property) {
const PropertyNode* pn = static_cast<const PropertyNode*>(*m);
- xmlWriter().writeStartElement(CXXVARIABLE);
+ writeStartTag(DT_cxxVariable);
xmlWriter().writeAttribute("id",pn->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
writeCharacters(pn->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(pn,marker);
// not included: <prolog>
- xmlWriter().writeStartElement(CXXVARIABLEDETAIL);
- xmlWriter().writeStartElement(CXXVARIABLEDEFINITION);
- xmlWriter().writeStartElement(CXXVARIABLEACCESSSPECIFIER);
+ writeStartTag(DT_cxxVariableDetail);
+ writeStartTag(DT_cxxVariableDefinition);
+ writeStartTag(DT_cxxVariableAccessSpecifier);
xmlWriter().writeAttribute("value",pn->accessString());
- xmlWriter().writeEndElement(); // <cxxVariableAccessSpecifier>
+ writeEndTag(); // <cxxVariableAccessSpecifier>
// not included: <cxxVariableStorageClassSpecifierExtern>,
// <cxxVariableStorageClassSpecifierStatic>,
@@ -4932,18 +4927,18 @@ void DitaXmlGenerator::writeProperties(const Section& s,
// <cxxVariableConst>, <cxxVariableVolatile>
if (!pn->qualifiedDataType().isEmpty()) {
- xmlWriter().writeStartElement(CXXVARIABLEDECLAREDTYPE);
+ writeStartTag(DT_cxxVariableDeclaredType);
writeCharacters(pn->qualifiedDataType());
- xmlWriter().writeEndElement(); // <cxxVariableDeclaredType>
+ writeEndTag(); // <cxxVariableDeclaredType>
}
QString fq = fullQualification(pn);
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXVARIABLESCOPEDNAME);
+ writeStartTag(DT_cxxVariableScopedName);
writeCharacters(fq);
- xmlWriter().writeEndElement(); // <cxxVariableScopedName>
+ writeEndTag(); // <cxxVariableScopedName>
}
- xmlWriter().writeStartElement(CXXVARIABLEPROTOTYPE);
+ writeStartTag(DT_cxxVariablePrototype);
xmlWriter().writeCharacters("Q_PROPERTY(");
writeCharacters(pn->qualifiedDataType());
xmlWriter().writeCharacters(" ");
@@ -4979,32 +4974,32 @@ void DitaXmlGenerator::writeProperties(const Section& s,
if (pn->isFinal())
xmlWriter().writeCharacters(" FINAL");
xmlWriter().writeCharacters(")");
- xmlWriter().writeEndElement(); // <cxxVariablePrototype>
+ writeEndTag(); // <cxxVariablePrototype>
- xmlWriter().writeStartElement(CXXVARIABLENAMELOOKUP);
+ writeStartTag(DT_cxxVariableNameLookup);
writeCharacters(pn->parent()->name() + "::" + pn->name());
- xmlWriter().writeEndElement(); // <cxxVariableNameLookup>
+ writeEndTag(); // <cxxVariableNameLookup>
if (pn->overriddenFrom() != 0) {
PropertyNode* opn = (PropertyNode*)pn->overriddenFrom();
- xmlWriter().writeStartElement(CXXVARIABLEREIMPLEMENTED);
+ writeStartTag(DT_cxxVariableReimplemented);
xmlWriter().writeAttribute("href",opn->ditaXmlHref());
writeCharacters(marker->plainFullName(opn));
- xmlWriter().writeEndElement(); // </cxxVariableReimplemented>
+ writeEndTag(); // </cxxVariableReimplemented>
}
writeLocation(pn);
- xmlWriter().writeEndElement(); // <cxxVariableDefinition>
+ writeEndTag(); // <cxxVariableDefinition>
writeDetailedDescription(pn, marker, true, QString());
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxVariableDetail>
+ writeEndTag(); // </cxxVariableDetail>
// not included: <related-links>
- xmlWriter().writeEndElement(); // </cxxVariable>
+ writeEndTag(); // </cxxVariable>
}
++m;
}
@@ -5021,74 +5016,74 @@ void DitaXmlGenerator::writeDataMembers(const Section& s,
while (m != s.members.end()) {
if ((*m)->type() == Node::Variable) {
const VariableNode* vn = static_cast<const VariableNode*>(*m);
- xmlWriter().writeStartElement(CXXVARIABLE);
+ writeStartTag(DT_cxxVariable);
xmlWriter().writeAttribute("id",vn->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
writeCharacters(vn->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(vn,marker);
// not included: <prolog>
- xmlWriter().writeStartElement(CXXVARIABLEDETAIL);
- xmlWriter().writeStartElement(CXXVARIABLEDEFINITION);
- xmlWriter().writeStartElement(CXXVARIABLEACCESSSPECIFIER);
+ writeStartTag(DT_cxxVariableDetail);
+ writeStartTag(DT_cxxVariableDefinition);
+ writeStartTag(DT_cxxVariableAccessSpecifier);
xmlWriter().writeAttribute("value",vn->accessString());
- xmlWriter().writeEndElement(); // <cxxVariableAccessSpecifier>
+ writeEndTag(); // <cxxVariableAccessSpecifier>
// not included: <cxxVAriableStorageClassSpecifierExtern>
if (vn->isStatic()) {
- xmlWriter().writeStartElement(CXXVARIABLESTORAGECLASSSPECIFIERSTATIC);
+ writeStartTag(DT_cxxVariableStorageClassSpecifierStatic);
xmlWriter().writeAttribute("name","static");
xmlWriter().writeAttribute("value","static");
- xmlWriter().writeEndElement(); // <cxxVariableStorageClassSpecifierStatic>
+ writeEndTag(); // <cxxVariableStorageClassSpecifierStatic>
}
// not included: <cxxVAriableStorageClassSpecifierMutable>,
// <cxxVariableConst>, <cxxVariableVolatile>
- xmlWriter().writeStartElement(CXXVARIABLEDECLAREDTYPE);
+ writeStartTag(DT_cxxVariableDeclaredType);
writeCharacters(vn->leftType());
if (!vn->rightType().isEmpty())
writeCharacters(vn->rightType());
- xmlWriter().writeEndElement(); // <cxxVariableDeclaredType>
+ writeEndTag(); // <cxxVariableDeclaredType>
QString fq = fullQualification(vn);
if (!fq.isEmpty()) {
- xmlWriter().writeStartElement(CXXVARIABLESCOPEDNAME);
+ writeStartTag(DT_cxxVariableScopedName);
writeCharacters(fq);
- xmlWriter().writeEndElement(); // <cxxVariableScopedName>
+ writeEndTag(); // <cxxVariableScopedName>
}
- xmlWriter().writeStartElement(CXXVARIABLEPROTOTYPE);
+ writeStartTag(DT_cxxVariablePrototype);
writeCharacters(vn->leftType() + " ");
//writeCharacters(vn->parent()->name() + "::" + vn->name());
writeCharacters(vn->name());
if (!vn->rightType().isEmpty())
writeCharacters(vn->rightType());
- xmlWriter().writeEndElement(); // <cxxVariablePrototype>
+ writeEndTag(); // <cxxVariablePrototype>
- xmlWriter().writeStartElement(CXXVARIABLENAMELOOKUP);
+ writeStartTag(DT_cxxVariableNameLookup);
writeCharacters(vn->parent()->name() + "::" + vn->name());
- xmlWriter().writeEndElement(); // <cxxVariableNameLookup>
+ writeEndTag(); // <cxxVariableNameLookup>
// not included: <cxxVariableReimplemented>
writeLocation(vn);
- xmlWriter().writeEndElement(); // <cxxVariableDefinition>
+ writeEndTag(); // <cxxVariableDefinition>
writeDetailedDescription(vn, marker, true, QString());
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxVariableDetail>
+ writeEndTag(); // </cxxVariableDetail>
// not included: <related-links>
- xmlWriter().writeEndElement(); // </cxxVariable>
+ writeEndTag(); // </cxxVariable>
}
++m;
}
@@ -5106,24 +5101,24 @@ void DitaXmlGenerator::writeMacros(const Section& s,
if ((*m)->type() == Node::Function) {
const FunctionNode* fn = static_cast<const FunctionNode*>(*m);
if (fn->isMacro()) {
- xmlWriter().writeStartElement(CXXDEFINE);
+ writeStartTag(DT_cxxDefine);
xmlWriter().writeAttribute("id",fn->guid());
if (!attribute.isEmpty())
xmlWriter().writeAttribute("outputclass",attribute);
- xmlWriter().writeStartElement("apiName");
+ writeStartTag(DT_apiName);
writeCharacters(fn->name());
- xmlWriter().writeEndElement(); // </apiName>
+ writeEndTag(); // </apiName>
generateBrief(fn,marker);
// not included: <prolog>
- xmlWriter().writeStartElement(CXXDEFINEDETAIL);
- xmlWriter().writeStartElement(CXXDEFINEDEFINITION);
- xmlWriter().writeStartElement(CXXDEFINEACCESSSPECIFIER);
+ writeStartTag(DT_cxxDefineDetail);
+ writeStartTag(DT_cxxDefineDefinition);
+ writeStartTag(DT_cxxDefineAccessSpecifier);
xmlWriter().writeAttribute("value",fn->accessString());
- xmlWriter().writeEndElement(); // <cxxDefineAccessSpecifier>
+ writeEndTag(); // <cxxDefineAccessSpecifier>
- xmlWriter().writeStartElement(CXXDEFINEPROTOTYPE);
+ writeStartTag(DT_cxxDefinePrototype);
xmlWriter().writeCharacters("#define ");
writeCharacters(fn->name());
if (fn->metaness() == FunctionNode::MacroWithParams) {
@@ -5141,50 +5136,50 @@ void DitaXmlGenerator::writeMacros(const Section& s,
xmlWriter().writeCharacters(")");
}
}
- xmlWriter().writeEndElement(); // <cxxDefinePrototype>
+ writeEndTag(); // <cxxDefinePrototype>
- xmlWriter().writeStartElement(CXXDEFINENAMELOOKUP);
+ writeStartTag(DT_cxxDefineNameLookup);
writeCharacters(fn->name());
- xmlWriter().writeEndElement(); // <cxxDefineNameLookup>
+ writeEndTag(); // <cxxDefineNameLookup>
if (fn->reimplementedFrom() != 0) {
FunctionNode* rfn = (FunctionNode*)fn->reimplementedFrom();
- xmlWriter().writeStartElement(CXXDEFINEREIMPLEMENTED);
+ writeStartTag(DT_cxxDefineReimplemented);
xmlWriter().writeAttribute("href",rfn->ditaXmlHref());
writeCharacters(marker->plainFullName(rfn));
- xmlWriter().writeEndElement(); // </cxxDefineReimplemented>
+ writeEndTag(); // </cxxDefineReimplemented>
}
if (fn->metaness() == FunctionNode::MacroWithParams) {
QStringList params = fn->parameterNames();
if (!params.isEmpty()) {
- xmlWriter().writeStartElement(CXXDEFINEPARAMETERS);
+ writeStartTag(DT_cxxDefineParameters);
for (int i = 0; i < params.size(); ++i) {
- xmlWriter().writeStartElement(CXXDEFINEPARAMETER);
- xmlWriter().writeStartElement(CXXDEFINEPARAMETERDECLARATIONNAME);
+ writeStartTag(DT_cxxDefineParameter);
+ writeStartTag(DT_cxxDefineParameterDeclarationName);
writeCharacters(params[i]);
- xmlWriter().writeEndElement(); // <cxxDefineParameterDeclarationName>
+ writeEndTag(); // <cxxDefineParameterDeclarationName>
// not included: <apiDefNote>
- xmlWriter().writeEndElement(); // <cxxDefineParameter>
+ writeEndTag(); // <cxxDefineParameter>
}
- xmlWriter().writeEndElement(); // <cxxDefineParameters>
+ writeEndTag(); // <cxxDefineParameters>
}
}
writeLocation(fn);
- xmlWriter().writeEndElement(); // <cxxDefineDefinition>
+ writeEndTag(); // <cxxDefineDefinition>
writeDetailedDescription(fn, marker, true, QString());
// not included: <example> or <apiImpl>
- xmlWriter().writeEndElement(); // </cxxDefineDetail>
+ writeEndTag(); // </cxxDefineDetail>
// not included: <related-links>
- xmlWriter().writeEndElement(); // </cxxDefine>
+ writeEndTag(); // </cxxDefine>
}
}
++m;
@@ -5271,7 +5266,7 @@ void DitaXmlGenerator::writeDetailedDescription(const Node* node,
inDetailedDescription = true;
if (apiDesc) {
inApiDesc = true;
- xmlWriter().writeStartElement("apiDesc");
+ writeStartTag(DT_apiDesc);
if (!title.isEmpty()) {
writeGuidAttribute(title);
xmlWriter().writeAttribute("spectitle",title);
@@ -5282,14 +5277,14 @@ void DitaXmlGenerator::writeDetailedDescription(const Node* node,
}
else {
inSection = true;
- xmlWriter().writeStartElement("section");
+ writeStartTag(DT_section);
if (!title.isEmpty()) {
writeGuidAttribute(title);
xmlWriter().writeAttribute("outputclass","details");
- xmlWriter().writeStartElement("title");
+ writeStartTag(DT_title);
xmlWriter().writeAttribute("outputclass","h2");
writeCharacters(title);
- xmlWriter().writeEndElement(); // </title>
+ writeEndTag(); // </title>
}
else {
writeGuidAttribute("Detailed Description");
@@ -5298,11 +5293,11 @@ void DitaXmlGenerator::writeDetailedDescription(const Node* node,
}
generateBody(node, marker);
if (inApiDesc) {
- xmlWriter().writeEndElement(); // </apiDesc>
+ writeEndTag(); // </apiDesc>
inApiDesc = false;
}
else if (inSection) {
- xmlWriter().writeEndElement(); // </section>
+ writeEndTag(); // </section>
inSection = false;
}
}
@@ -5317,23 +5312,23 @@ void DitaXmlGenerator::writeNestedClasses(const Section& s,
{
if (s.members.isEmpty())
return;
- xmlWriter().writeStartElement("cxxClassNested");
- xmlWriter().writeStartElement("cxxClassNestedDetail");
+ writeStartTag(DT_cxxClassNested);
+ writeStartTag(DT_cxxClassNestedDetail);
NodeList::ConstIterator m = s.members.begin();
while (m != s.members.end()) {
if ((*m)->type() == Node::Class) {
- xmlWriter().writeStartElement("cxxClassNestedClass");
+ writeStartTag(DT_cxxClassNestedClass);
QString link = linkForNode((*m), n);
xmlWriter().writeAttribute("href", link);
QString name = n->name() + "::" + (*m)->name();
writeCharacters(name);
- xmlWriter().writeEndElement(); // <cxxClassNestedClass>
+ writeEndTag(); // <cxxClassNestedClass>
}
++m;
}
- xmlWriter().writeEndElement(); // <cxxClassNestedDetail>
- xmlWriter().writeEndElement(); // <cxxClassNested>
+ writeEndTag(); // <cxxClassNestedDetail>
+ writeEndTag(); // <cxxClassNested>
}
/*!
@@ -5404,20 +5399,20 @@ void DitaXmlGenerator::writeDitaMap()
doctype = "<!DOCTYPE cxxAPIMap PUBLIC \"-//NOKIA//DTD DITA C++ API Map Reference Type v0.6.0//EN\" \"dtd/cxxAPIMap.dtd\">";
xmlWriter().writeDTD(doctype);
- xmlWriter().writeStartElement("cxxAPIMap");
+ writeStartTag(DT_cxxAPIMap);
xmlWriter().writeAttribute("id","Qt-DITA-Map");
xmlWriter().writeAttribute("title","Qt DITA Map");
- xmlWriter().writeStartElement("topicmeta");
- xmlWriter().writeStartElement("shortdesc");
+ writeStartTag(DT_topicmeta);
+ writeStartTag(DT_shortdesc);
xmlWriter().writeCharacters("The top level map for the Qt documentation");
- xmlWriter().writeEndElement(); // </shortdesc>
- xmlWriter().writeEndElement(); // </topicmeta>
+ writeEndTag(); // </shortdesc>
+ writeEndTag(); // </topicmeta>
GuidMaps::iterator i = guidMaps.begin();
while (i != guidMaps.end()) {
- xmlWriter().writeStartElement("topicref");
+ writeStartTag(DT_topicref);
xmlWriter().writeAttribute("href",i.key());
xmlWriter().writeAttribute("type","topic");
- xmlWriter().writeEndElement(); // </topicref>
+ writeEndTag(); // </topicref>
++i;
}
endSubPage();
diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h
index 1a42e5f..599844f 100644
--- a/tools/qdoc3/ditaxmlgenerator.h
+++ b/tools/qdoc3/ditaxmlgenerator.h
@@ -81,6 +81,151 @@ class DitaXmlGenerator : public PageGenerator
LastSinceType
};
+ enum DitaTag {
+ DT_alt,
+ DT_apiDesc,
+ DT_APIMap,
+ DT_apiName,
+ DT_b,
+ DT_body,
+ DT_bodydiv,
+ DT_codeblock,
+ DT_comment,
+ DT_cxxAPIMap,
+ DT_cxxClass,
+ DT_cxxClassAbstract,
+ DT_cxxClassAccessSpecifier,
+ DT_cxxClassAPIItemLocation,
+ DT_cxxClassBaseClass,
+ DT_cxxClassDeclarationFile,
+ DT_cxxClassDeclarationFileLine,
+ DT_cxxClassDefinition,
+ DT_cxxClassDerivation,
+ DT_cxxClassDerivationAccessSpecifier,
+ DT_cxxClassDerivations,
+ DT_cxxClassDetail,
+ DT_cxxClassNested,
+ DT_cxxClassNestedClass,
+ DT_cxxClassNestedDetail,
+ DT_cxxDefine,
+ DT_cxxDefineAccessSpecifier,
+ DT_cxxDefineAPIItemLocation,
+ DT_cxxDefineDeclarationFile,
+ DT_cxxDefineDeclarationFileLine,
+ DT_cxxDefineDefinition,
+ DT_cxxDefineDetail,
+ DT_cxxDefineNameLookup,
+ DT_cxxDefineParameter,
+ DT_cxxDefineParameterDeclarationName,
+ DT_cxxDefineParameters,
+ DT_cxxDefinePrototype,
+ DT_cxxDefineReimplemented,
+ DT_cxxEnumeration,
+ DT_cxxEnumerationAccessSpecifier,
+ DT_cxxEnumerationAPIItemLocation,
+ DT_cxxEnumerationDeclarationFile,
+ DT_cxxEnumerationDeclarationFileLine,
+ DT_cxxEnumerationDefinition,
+ DT_cxxEnumerationDefinitionFile,
+ DT_cxxEnumerationDefinitionFileLineStart,
+ DT_cxxEnumerationDefinitionFileLineEnd,
+ DT_cxxEnumerationDetail,
+ DT_cxxEnumerationNameLookup,
+ DT_cxxEnumerationPrototype,
+ DT_cxxEnumerationScopedName,
+ DT_cxxEnumerator,
+ DT_cxxEnumeratorInitialiser,
+ DT_cxxEnumeratorNameLookup,
+ DT_cxxEnumeratorPrototype,
+ DT_cxxEnumerators,
+ DT_cxxEnumeratorScopedName,
+ DT_cxxFunction,
+ DT_cxxFunctionAccessSpecifier,
+ DT_cxxFunctionAPIItemLocation,
+ DT_cxxFunctionConst,
+ DT_cxxFunctionConstructor,
+ DT_cxxFunctionDeclarationFile,
+ DT_cxxFunctionDeclarationFileLine,
+ DT_cxxFunctionDeclaredType,
+ DT_cxxFunctionDefinition,
+ DT_cxxFunctionDestructor,
+ DT_cxxFunctionDetail,
+ DT_cxxFunctionNameLookup,
+ DT_cxxFunctionParameter,
+ DT_cxxFunctionParameterDeclarationName,
+ DT_cxxFunctionParameterDeclaredType,
+ DT_cxxFunctionParameterDefaultValue,
+ DT_cxxFunctionParameters,
+ DT_cxxFunctionPrototype,
+ DT_cxxFunctionPureVirtual,
+ DT_cxxFunctionReimplemented,
+ DT_cxxFunctionScopedName,
+ DT_cxxFunctionStorageClassSpecifierStatic,
+ DT_cxxFunctionVirtual,
+ DT_cxxTypedef,
+ DT_cxxTypedefAccessSpecifier,
+ DT_cxxTypedefAPIItemLocation,
+ DT_cxxTypedefDeclarationFile,
+ DT_cxxTypedefDeclarationFileLine,
+ DT_cxxTypedefDefinition,
+ DT_cxxTypedefDetail,
+ DT_cxxTypedefNameLookup,
+ DT_cxxTypedefScopedName,
+ DT_cxxVariable,
+ DT_cxxVariableAccessSpecifier,
+ DT_cxxVariableAPIItemLocation,
+ DT_cxxVariableDeclarationFile,
+ DT_cxxVariableDeclarationFileLine,
+ DT_cxxVariableDeclaredType,
+ DT_cxxVariableDefinition,
+ DT_cxxVariableDetail,
+ DT_cxxVariableNameLookup,
+ DT_cxxVariablePrototype,
+ DT_cxxVariableReimplemented,
+ DT_cxxVariableScopedName,
+ DT_cxxVariableStorageClassSpecifierStatic,
+ DT_dd,
+ DT_dl,
+ DT_dlentry,
+ DT_dt,
+ DT_entry,
+ DT_fig,
+ DT_i,
+ DT_image,
+ DT_li,
+ DT_link,
+ DT_linktext,
+ DT_lq,
+ DT_ol,
+ DT_p,
+ DT_parameter,
+ DT_pre,
+ DT_relatedLinks,
+ DT_row,
+ DT_section,
+ DT_sectiondiv,
+ DT_shortdesc,
+ DT_simpletable,
+ DT_stentry,
+ DT_sthead,
+ DT_strow,
+ DT_sub,
+ DT_sup,
+ DT_table,
+ DT_tbody,
+ DT_tgroup,
+ DT_thead,
+ DT_title,
+ DT_topic,
+ DT_topicmeta,
+ DT_topicref,
+ DT_tt,
+ DT_ul,
+ DT_u,
+ DT_xref,
+ DT_LAST
+ };
+
public:
DitaXmlGenerator();
~DitaXmlGenerator();
@@ -260,6 +405,9 @@ class DitaXmlGenerator : public PageGenerator
const QString& title);
void addLink(const QString& href, const QStringRef& text);
void writeDitaMap();
+ void writeStartTag(DitaTag t);
+ void writeEndTag();
+ DitaTag currentTag();
private:
QMap<QString, QString> refMap;
@@ -317,8 +465,9 @@ class DitaXmlGenerator : public PageGenerator
static bool inSection;
static bool inDetailedDescription;
static bool inLegaleseText;
-
+ static QString ditaTags[];
QStack<QXmlStreamWriter*> xmlWriterStack;
+ QStack<DitaTag> tagStack;
};
#define DITAXMLGENERATOR_ADDRESS "address"
diff --git a/tools/qdoc3/generator.cpp b/tools/qdoc3/generator.cpp
index 65b9a09..26f8de1 100644
--- a/tools/qdoc3/generator.cpp
+++ b/tools/qdoc3/generator.cpp
@@ -262,6 +262,7 @@ void Generator::initialize(const Config &config)
}
else {
int paramPos = def.indexOf("\1");
+ qDebug() << "ZZZZZ:" << *n << def.left(paramPos) << def.mid(paramPos + 1);
fmtLeftMaps[*f].insert(*n, def.left(paramPos));
fmtRightMaps[*f].insert(*n, def.mid(paramPos + 1));
}
--
cgit v0.12
From fe8684d338a2344d890f1d5d57d58f21af877346 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 12 Jan 2011 12:13:28 +0100
Subject: qdoc: Replaced many raw-html cases with \div {something}.
Only 22 raw-html uses remaining.
---
src/gui/widgets/qmenu.cpp | 37 ++++++++-----------------------------
tools/qdoc3/doc.cpp | 11 ++++-------
2 files changed, 12 insertions(+), 36 deletions(-)
diff --git a/src/gui/widgets/qmenu.cpp b/src/gui/widgets/qmenu.cpp
index 74c2a9e..56ca004 100644
--- a/src/gui/widgets/qmenu.cpp
+++ b/src/gui/widgets/qmenu.cpp
@@ -1247,37 +1247,16 @@ void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action)
response to button presses; these are just like context menus
except for how they are invoked.
- \raw HTML
- <table align="center" cellpadding="0">
- <tr>
- <td>
- \endraw
- \inlineimage plastique-menu.png
- \raw HTML
- </td>
- <td>
- \endraw
- \inlineimage windowsxp-menu.png
- \raw HTML
- </td>
- <td>
- \endraw
- \inlineimage macintosh-menu.png
- \raw HTML
- </td>
-
- </tr>
- <tr>
- <td colspan="3">
- \endraw
- A menu shown in \l{Plastique Style Widget Gallery}{Plastique widget style},
+ \table
+ \row
+ \o \inlineimage plastique-menu.png
+ \o \inlineimage windowsxp-menu.png
+ \o \inlineimage macintosh-menu.png
+ \row
+ \o {3,1} A menu shown in \l{Plastique Style Widget Gallery}{Plastique widget style},
\l{Windows XP Style Widget Gallery}{Windows XP widget style},
and \l{Macintosh Style Widget Gallery}{Macintosh widget style}.
- \raw HTML
- </td>
- </tr>
- </table>
- \endraw
+ \endtable
\section1 Actions
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index 4873d8b..f7f537c 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -562,24 +562,21 @@ void DocParser::parse(const QString& source,
case CMD_DIV:
x = getArgument(true);
leavePara();
- enterPara(Atom::DivLeft, Atom::DivRight,x);
-#if 0
if (x.contains('=')) {
- leavePara();
enterPara(Atom::DivLeft, Atom::DivRight,x);
+ openedCommands.push(cmd);
}
else {
- leavePara();
append(Atom::DivLeft, x);
openedCommands.push(cmd);
enterPara();
}
-#endif
+
break;
case CMD_ENDDIV:
leavePara();
- // append(Atom::DivRight);
- // closeCommand(cmd);
+ append(Atom::DivRight);
+ closeCommand(cmd);
break;
case CMD_CODELINE:
{
--
cgit v0.12
From f803b62b4526f0f81693a59bdf4b07e36f3900c9 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 13 Jan 2011 10:14:15 +0100
Subject: qdoc: Added the \caption command.
And removed some \raw cases. Only 13 raw-html uses remaining.
Added the figCaption clause to style.css.
---
doc/src/template/style/style.css | 17 ++++++++++++-----
src/gui/dialogs/qabstractprintdialog.cpp | 18 +++++-------------
src/gui/widgets/qmenu.cpp | 7 +++----
tools/qdoc3/ditaxmlgenerator.cpp | 6 ++++++
tools/qdoc3/ditaxmlgenerator.h | 1 +
tools/qdoc3/doc.cpp | 2 +-
tools/qdoc3/htmlgenerator.cpp | 17 +++++++++++++++--
7 files changed, 43 insertions(+), 25 deletions(-)
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index 5f60199..de9e76c 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -135,10 +135,11 @@
font-size: 11px;
margin-bottom: 25px;
}
- pre.highlightedCode {
- display: block;
- overflow:hidden;
- }
+ pre.highlightedCode
+ {
+ display: block;
+ overflow:hidden;
+ }
thead
{
margin-top: 5px;
@@ -283,7 +284,13 @@
background: #c0c0c0;
color: #000000;
}
-
+ .figCaption
+ {
+ color:#363534;
+ font:italic 11px/1.2 Verdana;
+ text-align: center;
+ padding-top:0;
+ }
span.comment
{
color: #008B00;
diff --git a/src/gui/dialogs/qabstractprintdialog.cpp b/src/gui/dialogs/qabstractprintdialog.cpp
index 641419f..7e0b924 100644
--- a/src/gui/dialogs/qabstractprintdialog.cpp
+++ b/src/gui/dialogs/qabstractprintdialog.cpp
@@ -381,19 +381,11 @@ void QAbstractPrintDialogPrivate::setPrinter(QPrinter *newPrinter)
If the dialog is accepted by the user, the QPrinter object is
correctly configured for printing.
- \raw HTML
- <table align="center">
- <tr><td>
- \endraw
- \inlineimage plastique-printdialog.png
- \raw HTML
- </td><td>
- \endraw
- \inlineimage plastique-printdialog-properties.png
- \raw HTML
- </td></tr>
- </table>
- \endraw
+ \table
+ \row
+ \o \inlineimage plastique-printdialog.png
+ \o \inlineimage plastique-printdialog-properties.png
+ \endtable
The printer dialog (shown above in Plastique style) enables access to common
printing properties. On X11 platforms that use the CUPS printing system, the
diff --git a/src/gui/widgets/qmenu.cpp b/src/gui/widgets/qmenu.cpp
index 56ca004..9c8ddbb 100644
--- a/src/gui/widgets/qmenu.cpp
+++ b/src/gui/widgets/qmenu.cpp
@@ -1247,16 +1247,15 @@ void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action)
response to button presses; these are just like context menus
except for how they are invoked.
- \table
+ \table 100%
\row
\o \inlineimage plastique-menu.png
\o \inlineimage windowsxp-menu.png
\o \inlineimage macintosh-menu.png
- \row
- \o {3,1} A menu shown in \l{Plastique Style Widget Gallery}{Plastique widget style},
+ \endtable
+ \caption Fig. A menu shown in \l{Plastique Style Widget Gallery}{Plastique widget style},
\l{Windows XP Style Widget Gallery}{Windows XP widget style},
and \l{Macintosh Style Widget Gallery}{Macintosh widget style}.
- \endtable
\section1 Actions
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index e99af42..24ecea5 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -225,6 +225,7 @@ QString DitaXmlGenerator::ditaTags[] =
"tgroup",
"thead",
"title",
+ "tm",
"topic",
"topicmeta",
"topicref",
@@ -1293,6 +1294,11 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
writeCharacters("*");
writeEndTag(); // </sup>
}
+ else if (atom->string() == "<sup>®</sup>") {
+ writeStartTag(DT_tm);
+ xmlWriter().writeAttribute("tmtype","reg");
+ writeEndTag(); // </tm>
+ }
else {
writeStartTag(DT_pre);
xmlWriter().writeAttribute("outputclass","raw-html");
diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h
index 599844f..785b10a 100644
--- a/tools/qdoc3/ditaxmlgenerator.h
+++ b/tools/qdoc3/ditaxmlgenerator.h
@@ -216,6 +216,7 @@ class DitaXmlGenerator : public PageGenerator
DT_tgroup,
DT_thead,
DT_title,
+ DT_tm,
DT_topic,
DT_topicmeta,
DT_topicref,
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index f7f537c..b7dba8a 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -541,7 +541,7 @@ void DocParser::parse(const QString& source,
break;
case CMD_CAPTION:
leavePara();
- /* ... */
+ enterPara(Atom::CaptionLeft, Atom::CaptionRight);
break;
case CMD_CHAPTER:
startSection(Doc::Chapter, cmd);
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 1ddc0b9..7b6ec16 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -482,6 +482,17 @@ int HtmlGenerator::generateAtom(const Atom *atom,
}
out() << formattingRightMap()[ATOM_FORMATTING_TELETYPE];
break;
+ case Atom::CaptionLeft:
+ out() << "<p class=\"figCaption\">";
+ in_para = true;
+ break;
+ case Atom::CaptionRight:
+ endLink();
+ if (in_para) {
+ out() << "</p\n";
+ in_para = false;
+ }
+ break;
case Atom::Code:
out() << "<pre class=\"highlightedCode brush: cpp\">"
<< trimmedTrailing(highlightedCode(indent(codeIndent,atom->string()),
@@ -1063,8 +1074,10 @@ int HtmlGenerator::generateAtom(const Atom *atom,
in_para = false;
}
if (!atom->string().isEmpty()) {
- if (atom->string().contains("%"))
- out() << "<table class=\"generic\">\n "; // width=\"" << atom->string() << "\">\n ";
+ if (atom->string().contains("%")) {
+ out() << "<table class=\"generic\" width=\""
+ << atom->string() << "\">\n ";
+ }
else {
out() << "<table class=\"generic\">\n";
}
--
cgit v0.12
From 02d904d5983ff0597f52d8d6ec76439f81da6504 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 13 Jan 2011 13:17:48 +0100
Subject: qdoc: Added a parameter to \row
And removed some \raw cases. Only 11 raw-html uses remaining.
---
doc/src/getting-started/installation.qdoc | 169 ++++++++++++++++++------------
doc/src/template/style/style.css | 50 +++++++++
tools/qdoc3/doc.cpp | 3 +-
tools/qdoc3/htmlgenerator.cpp | 25 +++--
4 files changed, 172 insertions(+), 75 deletions(-)
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index f622192..f6498c1 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -1007,78 +1007,113 @@ We hope you will enjoy using Qt.
\image x11_dependencies.png Qt for X11 Dependencies
- \raw HTML
- <style type="text/css" id="colorstyles">
- #QtGuiColor { background-color: #98fd00; color: black }
- #QtCoreColor { background-color: #9c9cff; color: black }
- #DefaultColor { background-color: #f6f6dc; color: black }
- #FreetypeColor { background-color: #e6e6fa; color: black }
- #GLColor { background-color: #ffc0cb; color: black }
- #PthreadColor { background-color: #bdb76b; color: black }
- #OptionalColor { background-color: #cae1ff; color: black }
- #SMColor { background-color: #c2fafa; color: black }
- #MiscColor { background-color: #f0f9ff; color: black }
- #GlibColor { background-color: #b3b3b3; color: black }
- </style>
- \endraw
-
The QtGui module and the QtCore module, which provides the non-GUI features required
by QtGui, depend on the libraries described in the following table. To build
Qt from its source code, you will also need to install the development
packages for these libraries for your system.
- \raw HTML
- <table class="generic">
- <thead><tr class="qt-style topAlign"><th>Name</th><th>Library</th><th>Notes</th><th>Configuration options</th><th>Minimum working version
- <tr id="OptionalColor">
- <td> XRender </td><td> libXrender </td><td> X Rendering Extension; used for anti-aliasing</td>
- <td><tt>-xrender</tt> or auto-detected</td><td>0.9.0</td>
- </tr><tr id="OptionalColor">
- <td> Xrandr </td><td> libXrandr </td><td> X Resize and Rotate Extension</td>
- <td><tt>-xrandr</tt> or auto-detected</td><td>1.0.2</td>
- </tr><tr id="OptionalColor">
- <td> Xcursor </td><td> libXcursor </td><td> X Cursor Extension</td>
- <td><tt>-xcursor</tt> or auto-detected</td><td>1.1.4</td>
- </tr><tr id="OptionalColor">
- <td> Xfixes </td><td> libXfixes </td><td> X Fixes Extension</td>
- <td><tt>-xfixes</tt> or auto-detected</td><td>3.0.0</td>
- </tr><tr id="OptionalColor">
- <td> Xinerama </td><td> libXinerama </td><td> Multi-head support</td>
- <td><tt>-xinerama</tt> or auto-detected</td><td>1.1.0</td>
-
- </tr><tr id="OptionalColor">
- <td> Fontconfig </td><td> libfontconfig </td><td> Font customization and configuration</td>
- <td><tt>-fontconfig</tt> or auto-detected</td><td>2.1</td>
- </tr><tr id="OptionalColor">
- <td> FreeType </td><td> libfreetype </td><td> Font engine</td>
- <td></td><td>2.1.3</td>
-
- </tr><tr id="DefaultColor">
- <td> Xi </td><td> libXi </td><td> X11 Input Extensions</td>
- <td><tt>-xinput</tt> or auto-detected</td><td>1.3.0</td>
- </tr><tr id="DefaultColor">
- <td> Xt </td><td> libXt </td><td> Xt Intrinsics</td><td></td><td>0.99</td>
- </tr><tr id="DefaultColor">
- <td> Xext </td><td> libXext </td><td> X Extensions</td><td></td><td>6.4.3</td>
- </tr><tr id="DefaultColor">
- <td> X11 </td><td> libX11 </td><td> X11 Client-Side Library</td><td></td><td>6.2.1</td>
-
- </tr><tr id="SMColor">
- <td> SM </td><td> libSM </td><td> X Session Management</td>
- <td><tt>-sm</tt> or auto-detected</td><td>6.0.4</td>
- </tr><tr id="SMColor">
- <td> ICE </td><td> libICE </td><td> Inter-Client Exchange</td>
- <td><tt>-sm</tt> or auto-detected</td><td>6.3.5</td>
-
- </tr><tr id="GlibColor">
- <td> glib </td><td> libglib-2.0 </td><td> Common event loop handling</td>
- <td><tt>-glib</tt> or auto-detected</td><td>2.8.3</td>
- </tr><tr id="PthreadColor">
- <td> pthread </td><td> libpthread </td><td> Multithreading</td>
- <td></td><td>2.3.5</td>
- </tr></th></tr></thead>
- </table>
- \endraw
+ \table 100%
+ \header
+ \o Name
+ \o Library
+ \o Notes
+ \o Configuration options
+ \o Minimum working version
+ \row {id="OptionalColor"}
+ \o XRender
+ \o libXrender
+ \o X Rendering Extension; used for anti-aliasing
+ \o \tt{-xrender} or auto-detected
+ \o 0.9.0
+ \row {id="OptionalColor"}
+ \o Xrandr
+ \o libXrandr
+ \o X Resize and Rotate Extension
+ \o \tt{-xrandr} or auto-detected
+ \o 1.0.2
+ \row {id="OptionalColor"}
+ \o Xcursor
+ \o libXcursor
+ \o X Cursor Extension
+ \o \tt{-xcursor} or auto-detected
+ \o 1.1.4
+ \row {id="OptionalColor"}
+ \o Xfixes
+ \o libXfixes
+ \o X Fixes Extension
+ \o \tt{-xfixes} or auto-detected
+ \o 3.0.0
+ \row {id="OptionalColor"}
+ \o Xinerama
+ \o libXinerama
+ \o Multi-head support
+ \o \tt{-xinerama} or auto-detected
+ \o 1.1.0
+
+ \row {id="OptionalColor"}
+ \o Fontconfig
+ \o libfontconfig
+ \o Font customization and configuration
+ \o \tt{-fontconfig} or auto-detected
+ \o 2.1
+ \row {id="OptionalColor"}
+ \o FreeType
+ \o libfreetype
+ \o Font engine
+ \o
+ \o 2.1.3
+
+ \row {id="DefaultColor"}
+ \o Xi
+ \o libXi
+ \o X11 Input Extensions
+ \o \tt{-xinput} or auto-detected
+ \o 1.3.0
+ \row {id="DefaultColor"}
+ \o Xt
+ \o libXt
+ \o Xt Intrinsics
+ \o
+ \o 0.99
+ \row {id="DefaultColor"}
+ \o Xext
+ \o libXext
+ \o X Extensions
+ \o
+ \o 6.4.3
+ \row {id="DefaultColor"}
+ \o X11
+ \o libX11
+ \o X11 Client-Side Library
+ \o
+ \o 6.2.1
+
+ \row {id="SMColor"}
+ \o SM
+ \o libSM
+ \o X Session Management
+ \o \tt{-sm} or auto-detected
+ \o 6.0.4
+ \row {id="SMColor"}
+ \o ICE
+ \o libICE
+ \o Inter-Client Exchange
+ \o \tt{-sm} or auto-detected
+ \o 6.3.5
+
+ \row {id="GlibColor"}
+ \o glib
+ \o libglib-2.0
+ \o Common event loop handling
+ \o \tt{-glib} or auto-detected
+ \o 2.8.3
+ \row {id="PthreadColor"}
+ \o pthread
+ \o libpthread
+ \o Multithreading
+ \o
+ \o 2.3.5
+ \endtable
\note You must compile with XRender support to get alpha transparency
support for pixmaps and images.
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index de9e76c..7af5141 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -284,6 +284,56 @@
background: #c0c0c0;
color: #000000;
}
+ #QtGuiColor
+ {
+ background-color: #98fd00;
+ color: black;
+ }
+ #QtCoreColor
+ {
+ background-color: #9c9cff;
+ color: black;
+ }
+ #DefaultColor
+ {
+ background-color: #f6f6dc;
+ color: black;
+ }
+ #FreetypeColor
+ {
+ background-color: #e6e6fa;
+ color: black;
+ }
+ #GLColor
+ {
+ background-color: #ffc0cb;
+ color: black;
+ }
+ #PthreadColor
+ {
+ background-color: #bdb76b;
+ color: black;
+ }
+ #OptionalColor
+ {
+ background-color: #cae1ff;
+ color: black;
+ }
+ #SMColor
+ {
+ background-color: #c2fafa;
+ color: black;
+ }
+ #MiscColor
+ {
+ background-color: #f0f9ff;
+ color: black;
+ }
+ #GlibColor
+ {
+ background-color: #b3b3b3;
+ color: black;
+ }
.figCaption
{
color:#363534;
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index b7dba8a..7c3d141 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -1028,8 +1028,9 @@ void DocParser::parse(const QString& source,
break;
case CMD_ROW:
if (openedCommands.top() == CMD_TABLE) {
+ x = getArgument(true);
leaveTableRow();
- append(Atom::TableRowLeft);
+ append(Atom::TableRowLeft,x);
inTableRow = true;
}
else {
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 7b6ec16..81bd7a8 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -1106,7 +1106,14 @@ int HtmlGenerator::generateAtom(const Atom *atom,
}
break;
case Atom::TableRowLeft:
- if (++numTableRows % 2 == 1)
+ if (!atom->string().isEmpty()) {
+ out() << "<tr ";
+ if (atom->string().contains('='))
+ out() << " " << atom->string() << ">";
+ else
+ out() << " class=\"" << atom->string() << "\">";
+ }
+ else if (++numTableRows % 2 == 1)
out() << "<tr class=\"odd topAlign\">";
else
out() << "<tr class=\"even topAlign\">";
@@ -1127,10 +1134,12 @@ int HtmlGenerator::generateAtom(const Atom *atom,
out() << " colspan=\"" << spans.at(0) << "\"";
if (spans.at(1) != "1")
out() << " rowspan=\"" << spans.at(1) << "\"";
- if (inTableHeader)
- out() << ">";
- else
- out() << "><p>";
+ if (inTableHeader)
+ out() << ">";
+ else {
+ out() << ">";
+ //out() << "><p>";
+ }
}
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
@@ -1139,8 +1148,10 @@ int HtmlGenerator::generateAtom(const Atom *atom,
case Atom::TableItemRight:
if (inTableHeader)
out() << "</th>";
- else
- out() << "</p></td>";
+ else {
+ out() << "</td>";
+ //out() << "</p></td>";
+ }
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
break;
--
cgit v0.12
From 74f63cebc430ef6634917577783dafeed9a233d5 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 14 Jan 2011 14:02:57 +0100
Subject: qdoc: Added colorizing of individual table cells.
---
doc/src/examples/icons.qdoc | 4 +-
tools/qdoc3/atom.h | 65 +++++++++++++------
tools/qdoc3/doc.cpp | 146 ++++++++++++++++++++++--------------------
tools/qdoc3/htmlgenerator.cpp | 38 +++++++----
4 files changed, 150 insertions(+), 103 deletions(-)
diff --git a/doc/src/examples/icons.qdoc b/doc/src/examples/icons.qdoc
index 21a308d..a1a8e72 100644
--- a/doc/src/examples/icons.qdoc
+++ b/doc/src/examples/icons.qdoc
@@ -147,8 +147,8 @@
render the other six mode/state combinations, QIcon uses the
search algorithm described in the table below:
- \table
- \header \o{2,1} Requested Pixmap \o{8,1} Preferred Alternatives (mode/state)
+ \table 100%
+ \header \o{2,1} Requested Pixmap \o {8,1} Preferred Alternatives (mode/state)
\header \o Mode \o State \o 1 \o 2 \o 3 \o 4 \o 5 \o 6 \o 7 \o 8
\row \o{1,2} Normal \o Off \o \bold N0 \o A0 \o N1 \o A1 \o D0 \o S0 \o D1 \o S1
\row \o On \o N1 \o \bold A1 \o N0 \o A0 \o D1 \o S1 \o D0 \o S0
diff --git a/tools/qdoc3/atom.h b/tools/qdoc3/atom.h
index 739d8e3..c2b7cd6 100644
--- a/tools/qdoc3/atom.h
+++ b/tools/qdoc3/atom.h
@@ -46,7 +46,7 @@
#ifndef ATOM_H
#define ATOM_H
-#include <qstring.h>
+#include <qstringlist.h>
#define QDOC_QML
@@ -137,24 +137,51 @@ class Atom
Last = UnknownCommand
};
- Atom(Type type, const QString &string = "")
- : nxt(0), typ(type), str(string) { }
- Atom(Atom *prev, Type type, const QString &string = "")
- : nxt(prev->nxt), typ(type), str(string) { prev->nxt = this; }
-
- void appendChar(QChar ch) { str += ch; }
- void appendString(const QString& string) { str += string; }
- void chopString() { str.chop(1); }
- void setString(const QString &string) { str = string; }
- Atom *next() { return nxt; }
- void setNext(Atom *newNext) { nxt = newNext; }
-
- const Atom *next() const { return nxt; }
- const Atom *next(Type t) const;
- const Atom *next(Type t, const QString& s) const;
+ Atom(Type type, const QString& string = "")
+ : nxt(0), typ(type)
+ {
+ strs << string;
+ }
+
+ Atom(Type type, const QString& p1, const QString& p2)
+ : nxt(0), typ(type)
+ {
+ strs << p1;
+ if (!p2.isEmpty())
+ strs << p2;
+ }
+
+ Atom(Atom* prev, Type type, const QString& string = "")
+ : nxt(prev->nxt), typ(type)
+ {
+ strs << string;
+ prev->nxt = this;
+ }
+
+ Atom(Atom* prev, Type type, const QString& p1, const QString& p2)
+ : nxt(prev->nxt), typ(type)
+ {
+ strs << p1;
+ if (!p2.isEmpty())
+ strs << p2;
+ prev->nxt = this;
+ }
+
+ void appendChar(QChar ch) { strs[0] += ch; }
+ void appendString(const QString& string) { strs[0] += string; }
+ void chopString() { strs[0].chop(1); }
+ void setString(const QString& string) { strs[0] = string; }
+ Atom* next() { return nxt; }
+ void setNext(Atom* newNext) { nxt = newNext; }
+
+ const Atom* next() const { return nxt; }
+ const Atom* next(Type t) const;
+ const Atom* next(Type t, const QString& s) const;
Type type() const { return typ; }
QString typeString() const;
- const QString& string() const { return str; }
+ const QString& string() const { return strs[0]; }
+ const QString& string(int i) const { return strs[i]; }
+ int count() const { return strs.size(); }
void dump() const;
static QString BOLD_;
@@ -177,9 +204,9 @@ class Atom
static QString UPPERROMAN_;
private:
- Atom *nxt;
+ Atom* nxt;
Type typ;
- QString str;
+ QStringList strs;
};
#define ATOM_FORMATTING_BOLD "bold"
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index 7c3d141..36c1d94 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -364,6 +364,7 @@ class DocParser
void endSection(int unit, int endCmd);
void parseAlso();
void append(Atom::Type type, const QString& string = "");
+ void append(Atom::Type type, const QString& p1, const QString& p2);
void appendChar(QChar ch);
void appendWord(const QString &word);
void appendToCode(const QString &code);
@@ -467,7 +468,7 @@ void DocParser::parse(const QString& source,
CodeMarker *marker = 0;
Atom *currentLinkAtom = 0;
- QString x;
+ QString p1, p2;
QStack<bool> preprocessorSkipping;
int numPreprocessorSkipping = 0;
@@ -506,11 +507,11 @@ void DocParser::parse(const QString& source,
switch (cmd) {
case CMD_A:
enterPara();
- x = getArgument();
+ p1 = getArgument();
append(Atom::FormattingLeft,ATOM_FORMATTING_PARAMETER);
- append(Atom::String, x);
+ append(Atom::String, p1);
append(Atom::FormattingRight,ATOM_FORMATTING_PARAMETER);
- priv->params.insert(x);
+ priv->params.insert(p1);
break;
case CMD_ABSTRACT:
if (openCommand(cmd)) {
@@ -535,9 +536,9 @@ void DocParser::parse(const QString& source,
break;
case CMD_C:
enterPara();
- x = untabifyEtc(getArgument(true));
- marker = CodeMarker::markerForCode(x);
- append(Atom::C, marker->markedUpCode(x, 0, ""));
+ p1 = untabifyEtc(getArgument(true));
+ marker = CodeMarker::markerForCode(p1);
+ append(Atom::C, marker->markedUpCode(p1, 0, ""));
break;
case CMD_CAPTION:
leavePara();
@@ -560,14 +561,14 @@ void DocParser::parse(const QString& source,
break;
#endif
case CMD_DIV:
- x = getArgument(true);
+ p1 = getArgument(true);
leavePara();
- if (x.contains('=')) {
- enterPara(Atom::DivLeft, Atom::DivRight,x);
+ if (p1.contains('=')) {
+ enterPara(Atom::DivLeft, Atom::DivRight,p1);
openedCommands.push(cmd);
}
else {
- append(Atom::DivLeft, x);
+ append(Atom::DivLeft, p1);
openedCommands.push(cmd);
enterPara();
}
@@ -823,23 +824,23 @@ void DocParser::parse(const QString& source,
case CMD_L:
enterPara();
if (isLeftBraceAhead()) {
- x = getArgument();
- append(Atom::Link, x);
+ p1 = getArgument();
+ append(Atom::Link, p1);
if (isLeftBraceAhead()) {
currentLinkAtom = priv->text.lastAtom();
startFormat(ATOM_FORMATTING_LINK, cmd);
}
else {
append(Atom::FormattingLeft, ATOM_FORMATTING_LINK);
- append(Atom::String, cleanLink(x));
+ append(Atom::String, cleanLink(p1));
append(Atom::FormattingRight, ATOM_FORMATTING_LINK);
}
}
else {
- x = getArgument();
- append(Atom::Link, x);
+ p1 = getArgument();
+ append(Atom::Link, p1);
append(Atom::FormattingLeft, ATOM_FORMATTING_LINK);
- append(Atom::String, cleanLink(x));
+ append(Atom::String, cleanLink(p1));
append(Atom::FormattingRight, ATOM_FORMATTING_LINK);
}
break;
@@ -852,8 +853,8 @@ void DocParser::parse(const QString& source,
case CMD_LINK:
if (openCommand(cmd)) {
enterPara();
- x = getArgument();
- append(Atom::Link, x);
+ p1 = getArgument();
+ append(Atom::Link, p1);
append(Atom::FormattingLeft, ATOM_FORMATTING_LINK);
skipSpacesOrOneEndl();
}
@@ -867,8 +868,8 @@ void DocParser::parse(const QString& source,
break;
case CMD_META:
priv->constructExtra();
- x = getArgument();
- priv->extra->metaMap.insert(x, getRestOfLine());
+ p1 = getArgument();
+ priv->extra->metaMap.insert(p1, getRestOfLine());
break;
case CMD_NEWCODE:
location().warning(tr("Unexpected '\\%1'").arg(cmdName(CMD_NEWCODE)));
@@ -892,9 +893,13 @@ void DocParser::parse(const QString& source,
enterPara();
}
else if (openedCommands.top() == CMD_TABLE) {
- x = "1,1";
- if (isLeftBraceAhead())
- x = getArgument();
+ p1 = "1,1";
+ if (isLeftBraceAhead()) {
+ p1 = getArgument();
+ if (isLeftBraceAhead()) {
+ p2 = getArgument();
+ }
+ }
if (!inTableHeader && !inTableRow) {
location().warning(tr("Missing '\\%1' or '\\%1' before '\\%3'")
@@ -909,7 +914,7 @@ void DocParser::parse(const QString& source,
inTableItem = false;
}
- append(Atom::TableItemLeft, x);
+ append(Atom::TableItemLeft, p1, p2);
inTableItem = true;
}
else {
@@ -928,11 +933,11 @@ void DocParser::parse(const QString& source,
getUntilEnd(cmd);
break;
case CMD_OMITVALUE:
- x = getArgument();
- if (!priv->enumItemList.contains(x))
- priv->enumItemList.append(x);
- if (!priv->omitEnumItemList.contains(x))
- priv->omitEnumItemList.append(x);
+ p1 = getArgument();
+ if (!priv->enumItemList.contains(p1))
+ priv->enumItemList.append(p1);
+ if (!priv->omitEnumItemList.contains(p1))
+ priv->omitEnumItemList.append(p1);
break;
case CMD_PART:
startSection(Doc::Part, cmd);
@@ -1001,36 +1006,38 @@ void DocParser::parse(const QString& source,
case CMD_QUOTEFUNCTION:
leavePara();
marker = quoteFromFile();
- x = getRestOfLine();
+ p1 = getRestOfLine();
if (!quoting) {
quoter.quoteTo(location(), cmdStr,
- slashed(marker->functionBeginRegExp(x)));
+ slashed(marker->functionBeginRegExp(p1)));
append(Atom::Code,
quoter.quoteUntil(location(), cmdStr,
- slashed(marker->functionEndRegExp(x))));
+ slashed(marker->functionEndRegExp(p1))));
quoter.reset();
}
else {
append(Atom::CodeQuoteCommand, cmdStr);
- append(Atom::CodeQuoteArgument, slashed(marker->functionEndRegExp(x)));
+ append(Atom::CodeQuoteArgument, slashed(marker->functionEndRegExp(p1)));
}
break;
case CMD_RAW:
leavePara();
- x = getRestOfLine();
- if (x.isEmpty())
+ p1 = getRestOfLine();
+ if (p1.isEmpty())
location().warning(tr("Missing format name after '\\%1")
.arg(cmdName(CMD_RAW)));
- append(Atom::FormatIf, x);
+ append(Atom::FormatIf, p1);
append(Atom::RawString, untabifyEtc(getUntilEnd(cmd)));
append(Atom::FormatElse);
append(Atom::FormatEndif);
break;
case CMD_ROW:
if (openedCommands.top() == CMD_TABLE) {
- x = getArgument(true);
+ p1.clear();
+ if (isLeftBraceAhead())
+ p1 = getArgument(true);
leaveTableRow();
- append(Atom::TableRowLeft,x);
+ append(Atom::TableRowLeft,p1);
inTableRow = true;
}
else {
@@ -1124,22 +1131,22 @@ void DocParser::parse(const QString& source,
startFormat(ATOM_FORMATTING_SUPERSCRIPT, cmd);
break;
case CMD_TABLE:
- x = getRestOfLine();
+ p1 = getRestOfLine();
if (openCommand(cmd)) {
leavePara();
- append(Atom::TableLeft, x);
+ append(Atom::TableLeft, p1);
inTableHeader = false;
inTableRow = false;
inTableItem = false;
}
break;
case CMD_TABLEOFCONTENTS:
- x = "1";
+ p1 = "1";
if (isLeftBraceAhead())
- x = getArgument();
- x += ",";
- x += QString::number((int)getSectioningUnit());
- append(Atom::TableOfContents, x);
+ p1 = getArgument();
+ p1 += ",";
+ p1 += QString::number((int)getSectioningUnit());
+ append(Atom::TableOfContents, p1);
break;
case CMD_TARGET:
insertTarget(getRestOfLine(),false);
@@ -1152,16 +1159,16 @@ void DocParser::parse(const QString& source,
break;
case CMD_UNICODE:
enterPara();
- x = getArgument();
+ p1 = getArgument();
{
bool ok;
- uint unicodeChar = x.toUInt(&ok, 0);
+ uint unicodeChar = p1.toUInt(&ok, 0);
if (!ok ||
(unicodeChar == 0x0000) ||
(unicodeChar > 0xFFFE)) {
location().warning(tr("Invalid Unicode character '%1' specified "
"with '%2'")
- .arg(x, cmdName(CMD_UNICODE)));
+ .arg(p1, cmdName(CMD_UNICODE)));
}
else {
append(Atom::String, QChar(unicodeChar));
@@ -1171,13 +1178,13 @@ void DocParser::parse(const QString& source,
case CMD_VALUE:
leaveValue();
if (openedLists.top().style() == OpenedList::Value) {
- x = getArgument();
- if (!priv->enumItemList.contains(x))
- priv->enumItemList.append(x);
+ p1 = getArgument();
+ if (!priv->enumItemList.contains(p1))
+ priv->enumItemList.append(p1);
openedLists.top().next();
append(Atom::ListTagLeft, ATOM_LIST_VALUE);
- append(Atom::String, x);
+ append(Atom::String, p1);
append(Atom::ListTagRight, ATOM_LIST_VALUE);
append(Atom::ListItemLeft, ATOM_LIST_VALUE);
@@ -1198,13 +1205,13 @@ void DocParser::parse(const QString& source,
break;
case CMD_OVERLOAD:
priv->metacommandsUsed.insert(cmdStr);
- x.clear();
+ p1.clear();
if (!isBlankLine())
- x = getRestOfLine();
- if (!x.isEmpty()) {
+ p1 = getRestOfLine();
+ if (!p1.isEmpty()) {
append(Atom::ParaLeft);
append(Atom::String, "This function overloads ");
- append(Atom::AutoLink,x);
+ append(Atom::AutoLink,p1);
append(Atom::String, ".");
append(Atom::ParaRight);
}
@@ -1212,9 +1219,9 @@ void DocParser::parse(const QString& source,
append(Atom::ParaLeft);
append(Atom::String,"This is an overloaded function.");
append(Atom::ParaRight);
- x = getMetaCommandArgument(cmdStr);
+ p1 = getMetaCommandArgument(cmdStr);
}
- priv->metaCommandMap[cmdStr].append(x);
+ priv->metaCommandMap[cmdStr].append(p1);
break;
case NOT_A_CMD:
if (metaCommandSet.contains(cmdStr)) {
@@ -1816,9 +1823,6 @@ void DocParser::parseAlso()
}
//static bool debug = false;
-
-void DocParser::append(Atom::Type type, const QString &string)
-{
#if 0
if (type == Atom::DivLeft)
debug = true;
@@ -1827,17 +1831,23 @@ void DocParser::append(Atom::Type type, const QString &string)
if (type == Atom::DivRight)
debug = false;
#endif
+
+void DocParser::append(Atom::Type type, const QString &string)
+{
Atom::Type lastType = priv->text.lastAtom()->type();
-#ifdef QDOC_QML
- if (((lastType == Atom::Code) || (lastType == Atom::Code)) &&
-#else
- if ((lastType == Atom::Code) &&
-#endif
- priv->text.lastAtom()->string().endsWith(QLatin1String("\n\n")))
+ if ((lastType == Atom::Code) && priv->text.lastAtom()->string().endsWith(QLatin1String("\n\n")))
priv->text.lastAtom()->chopString();
priv->text << Atom(type, string);
}
+void DocParser::append(Atom::Type type, const QString& p1, const QString& p2)
+{
+ Atom::Type lastType = priv->text.lastAtom()->type();
+ if ((lastType == Atom::Code) && priv->text.lastAtom()->string().endsWith(QLatin1String("\n\n")))
+ priv->text.lastAtom()->chopString();
+ priv->text << Atom(type, p1, p2);
+}
+
void DocParser::appendChar(QChar ch)
{
if (priv->text.lastAtom()->type() != Atom::String)
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 81bd7a8..2f990b0 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -1091,14 +1091,14 @@ int HtmlGenerator::generateAtom(const Atom *atom,
out() << "</table>\n";
break;
case Atom::TableHeaderLeft:
- out() << "<thead><tr class=\"qt-style topAlign\">";
+ out() << "<thead><tr class=\"qt-style\">";
inTableHeader = true;
break;
case Atom::TableHeaderRight:
out() << "</tr>";
if (matchAhead(atom, Atom::TableHeaderLeft)) {
skipAhead = 1;
- out() << "\n<tr class=\"qt-style topAlign\">";
+ out() << "\n<tr class=\"qt-style\">";
}
else {
out() << "</thead>\n";
@@ -1114,9 +1114,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
out() << " class=\"" << atom->string() << "\">";
}
else if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd topAlign\">";
+ out() << "<tr class=\"odd\">";
else
- out() << "<tr class=\"even topAlign\">";
+ out() << "<tr class=\"even\">";
break;
case Atom::TableRowRight:
out() << "</tr>\n";
@@ -1128,19 +1128,29 @@ int HtmlGenerator::generateAtom(const Atom *atom,
else
out() << "<td ";
- QStringList spans = atom->string().split(",");
- if (spans.size() == 2) {
- if (spans.at(0) != "1")
- out() << " colspan=\"" << spans.at(0) << "\"";
- if (spans.at(1) != "1")
- out() << " rowspan=\"" << spans.at(1) << "\"";
- if (inTableHeader)
- out() << ">";
+ for (int i=0; i<atom->count(); ++i) {
+ if (i > 0)
+ out() << " ";
+ QString p = atom->string(i);
+ if (p.contains('=')) {
+ out() << p;
+ }
else {
- out() << ">";
- //out() << "><p>";
+ QStringList spans = p.split(",");
+ if (spans.size() == 2) {
+ if (spans.at(0) != "1")
+ out() << " colspan=\"" << spans.at(0) << "\"";
+ if (spans.at(1) != "1")
+ out() << " rowspan=\"" << spans.at(1) << "\"";
+ }
}
}
+ if (inTableHeader)
+ out() << ">";
+ else {
+ out() << ">";
+ //out() << "><p>";
+ }
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
}
--
cgit v0.12
From ebaf3a991d0ef0533c829305ae1968bed41e2773 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 19 Jan 2011 13:58:48 +0100
Subject: qdoc: Fixed some validation errors in the DITA files
11 instances of raw-html remain.
---
doc/src/declarative/positioners.qdoc | 10 +--
doc/src/declarative/qdeclarativemodels.qdoc | 2 +-
doc/src/development/designer-manual.qdoc | 30 ++++----
doc/src/getting-started/how-to-learn-qt.qdoc | 2 +-
doc/src/index.qdoc | 36 +++++-----
doc/src/tutorials/widgets-tutorial.qdoc | 8 +--
doc/src/zh_CN/getting-started/how-to-learn-qt.qdoc | 2 +-
.../graphicsitems/qdeclarativeflickable.cpp | 2 +-
.../graphicsitems/qdeclarativegridview.cpp | 4 +-
.../graphicsitems/qdeclarativemousearea.cpp | 2 +-
.../graphicsitems/qdeclarativerectangle.cpp | 10 +--
src/declarative/util/qdeclarativelistmodel.cpp | 4 +-
src/gui/graphicsview/qgraphicsanchorlayout.cpp | 2 +-
tools/qdoc3/ditaxmlgenerator.cpp | 83 +++++++++++++++++-----
tools/qdoc3/ditaxmlgenerator.h | 3 +-
tools/qdoc3/doc.cpp | 35 +++++----
tools/qdoc3/htmlgenerator.cpp | 20 ++----
17 files changed, 147 insertions(+), 108 deletions(-)
diff --git a/doc/src/declarative/positioners.qdoc b/doc/src/declarative/positioners.qdoc
index d97acbd..26631a6 100644
--- a/doc/src/declarative/positioners.qdoc
+++ b/doc/src/declarative/positioners.qdoc
@@ -53,7 +53,7 @@ graphical elements:
\section2 Column
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-column.png
\enddiv
@@ -70,7 +70,7 @@ must be added to a parent Rectangle, if desired.
\section2 Row
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-row.png
\enddiv
@@ -87,7 +87,7 @@ left around the edges of the horizontally centered Row item.
\section2 Grid
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-grid-spacing.png
\enddiv
@@ -108,7 +108,7 @@ at the appropriate places in the Grid definition.
\section2 Flow
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-flow-text1.png
\inlineimage qml-flow-text2.png
\enddiv
@@ -137,7 +137,7 @@ control of spacing between items and between lines of items.
\section1 Repeaters
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-repeater-grid-index.png
\enddiv
diff --git a/doc/src/declarative/qdeclarativemodels.qdoc b/doc/src/declarative/qdeclarativemodels.qdoc
index 495b3bd..84d4e7e 100644
--- a/doc/src/declarative/qdeclarativemodels.qdoc
+++ b/doc/src/declarative/qdeclarativemodels.qdoc
@@ -504,7 +504,7 @@ a Web browser.
\l ListView shows a classic list of items with horizontal or vertical placing
of items.
-\div{float-right}
+\div {class="float-right"}
\inlineimage qml-listview-snippet.png
\enddiv
diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc
index e5f3b99..78d9afa 100644
--- a/doc/src/development/designer-manual.qdoc
+++ b/doc/src/development/designer-manual.qdoc
@@ -1385,7 +1385,7 @@
\target CreatingAMenu
- \div {float-left}
+ \div {class="float-left"}
\inlineimage designer-creating-menu1.png
\inlineimage designer-creating-menu2.png
\br
@@ -1406,7 +1406,7 @@
\key Escape to reject it. You can undo the editing operation later if
required.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
Menus can also be rearranged in the menu bar simply by dragging and
@@ -1418,7 +1418,7 @@
navigating the menu structure in the usual way.
\target CreatingAMenuEntry
- \div {float-right}
+ \div {class="float-right"}
\inlineimage designer-creating-menu-entry1.png
\inlineimage designer-creating-menu-entry2.png
\br
@@ -1444,7 +1444,7 @@
be accessible via the \l{#TheActionEditor}{Action Editor}, and any
associated keyboard shortcut can be set there.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
Just like with menus, entries can be moved around simply by dragging and
@@ -1455,7 +1455,7 @@
\section1 Toolbars
- \div {float-left}
+ \div {class="float-left"}
\inlineimage designer-creating-toolbar.png
\enddiv
@@ -1469,7 +1469,7 @@
Toolbars are removed from the form via an entry in the toolbar's context
menu.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
\section2 Adding and Removing Toolbar Buttons
@@ -1479,7 +1479,7 @@
Since actions can be represented by menu entries and toolbar buttons,
they can be moved between menus and toolbars.
- \div {float-right}
+ \div {class="float-right"}
\inlineimage designer-adding-toolbar-action.png
\inlineimage designer-removing-toolbar-action.png
\enddiv
@@ -1491,7 +1491,7 @@
Toolbar buttons are removed via the toolbar's context menu.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
\section1 Actions
@@ -1501,7 +1501,7 @@
action editor window, simplifying the creation and management of actions.
\target TheActionEditor
- \div {float-left}
+ \div {class="float-left"}
\inlineimage designer-action-editor.png
\enddiv
@@ -1519,7 +1519,7 @@
\gui{Detailed View}. You can also copy and paste actions between menus,
toolbars and forms.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
\section2 Creating an Action
@@ -1535,11 +1535,11 @@
Once the action is created, it can be used wherever actions are applicable.
- \div {clear-left}
+ \div {class="clear-left"}
\enddiv
\target AddingAnAction
- \div {float-right}
+ \div {class="float-right"}
\inlineimage designer-adding-menu-action.png
\inlineimage designer-adding-toolbar-action.png
\enddiv
@@ -1554,7 +1554,7 @@
will be added. Release the mouse button to add the action when you have
found the right spot.
- \div {clear-right}
+ \div {class="clear-right"}
\enddiv
\section1 Dock Widgets
@@ -1567,7 +1567,7 @@
\target AddingADockWidget
- \div {float-left}
+ \div {class="float-left"}
\inlineimage designer-adding-dockwidget.png
\enddiv
@@ -1588,7 +1588,7 @@
\l{QDockWidget::}{windowTitle} property. This also helps to identify them on the
form.
- \div {clear-both}
+ \div {class="clear-both"}
\enddiv
*/
diff --git a/doc/src/getting-started/how-to-learn-qt.qdoc b/doc/src/getting-started/how-to-learn-qt.qdoc
index 0d5fd0a..7c55586 100644
--- a/doc/src/getting-started/how-to-learn-qt.qdoc
+++ b/doc/src/getting-started/how-to-learn-qt.qdoc
@@ -51,7 +51,7 @@
key overviews to deepen your understanding of Qt: The Qt \l{Object
Model} and \l{Signals and Slots}.
- \div{float-left}
+ \div {class="float-left"}
\inlineimage qtdemo-small.png
\enddiv
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index aefbea1..bdde170 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -29,21 +29,21 @@
\page index.html
\keyword Qt Reference Documentation
- \div {indexbox guide}
- \div {heading}
+ \div {class="indexbox guide"}
+ \div {class="heading"}
Qt Developer Guide
\enddiv
- \div {indexboxcont indexboxbar}
- \div {section indexIcon} \emptyspan
+ \div {class="indexboxcont indexboxbar"}
+ \div {class="section indexIcon"} \emptyspan
\enddiv
- \div {section}
+ \div {class="section"}
Qt is a cross-platform application and UI
framework. Using Qt, you can write web-enabled
applications once and deploy them across desktop,
mobile and embedded operating systems without
rewriting the source code.
\enddiv
- \div {section sectionlist}
+ \div {class="section sectionlist"}
\list
\o \l{Getting Started Guides}{Getting started}
\o \l{Installation}{Installation}
@@ -55,12 +55,12 @@
\enddiv
\enddiv
\enddiv
- \div {indexbox api}
- \div {heading}
+ \div {class="indexbox api"}
+ \div {class="heading"}
Qt API
\enddiv
- \div {indexboxcont indexboxbar }
- \div {sectionlist tricol}
+ \div {class="indexboxcont indexboxbar "}
+ \div {class="sectionlist tricol"}
\list
\o \l{All Classes}{All Classes}
\o \l{All Functions}{All Functions}
@@ -70,7 +70,7 @@
\o \l{Qt Licenses and Credits}{Licenses and Credits}
\endlist
\enddiv
- \div {sectionlist tricol}
+ \div {class="sectionlist tricol"}
\list
\o \l{qt-basic-concepts.html}{Programming with Qt}
\o \l{qt-gui-concepts.html}{UI Design with Qt}
@@ -79,7 +79,7 @@
\o \l{best-practices.html}{Best Practices Guides}
\endlist
\enddiv
- \div {sectionlist}
+ \div {class="sectionlist"}
\list
\o \l{qtquick.html}{Qt Quick}
\o \l{qdeclarativeintroduction.html}{Introduction to QML}
@@ -89,19 +89,19 @@
\enddiv
\enddiv
\enddiv
- \div {indexbox tools}
- \div {heading}
+ \div {class="indexbox tools"}
+ \div {class="heading"}
Qt Tools
\enddiv
- \div {indexboxcont}
- \div {section indexIcon} \emptyspan
+ \div {class="indexboxcont"}
+ \div {class="section indexIcon"} \emptyspan
\enddiv
- \div {section}
+ \div {class="section"}
Qt offers a selection of development tools for
different tasks. Use Qt Creator for project and code
management as well as building powerfull UIs.
\enddiv
- \div {section sectionlist}
+ \div {class="section sectionlist"}
\list
\o \l{http://doc.qt.nokia.com/qtcreator-2.0/index.html}{Qt Creator}
\o \l{designer-manual.html}{Qt Designer}
diff --git a/doc/src/tutorials/widgets-tutorial.qdoc b/doc/src/tutorials/widgets-tutorial.qdoc
index 42c8852..925b143 100644
--- a/doc/src/tutorials/widgets-tutorial.qdoc
+++ b/doc/src/tutorials/widgets-tutorial.qdoc
@@ -133,7 +133,7 @@
In the following example, we use QWidget to create and show a window with
a default size:
- \div {qt-code}
+ \div {class="qt-code"}
\table
\row
\o \snippet tutorials/widgets/toplevel/main.cpp main program
@@ -155,7 +155,7 @@
passing \c window as the parent to its constructor. In this case, we add a
button to the window and place it in a specific location:
- \div {qt-code}
+ \div {class="qt-code"}
\table
\row
\o \snippet tutorials/widgets/childwidget/main.cpp main program
@@ -177,7 +177,7 @@
construct a label and line edit widget that we would like to arrange
side-by-side.
- \div {qt-code}
+ \div {class="qt-code"}
\table
\row
\o \snippet tutorials/widgets/windowlayout/main.cpp main program
@@ -215,7 +215,7 @@
\c{mainLayout} is a QVBoxLayout that contains \c{queryLayout} and a
QTableView arranged vertically.
- \div {qt-code}
+ \div {class="qt-code"}
\table
\row
\o \snippet tutorials/widgets/nestedlayouts/main.cpp first part
diff --git a/doc/src/zh_CN/getting-started/how-to-learn-qt.qdoc b/doc/src/zh_CN/getting-started/how-to-learn-qt.qdoc
index e74c84c..42a5f43 100644
--- a/doc/src/zh_CN/getting-started/how-to-learn-qt.qdoc
+++ b/doc/src/zh_CN/getting-started/how-to-learn-qt.qdoc
@@ -41,7 +41,7 @@
现在您已经编写了一些小型可用的应用程序，并对 Qt 编程有更加广泛的了解。您可以直接着手做自己的项目，但我们建议您阅读以下一些关键简介以加深您对 Qt 的了解：\l{Qt Object Model}Qt 对象模型}和\l{Signals and Slots}{信号和槽}。
- \div {float-left}
+ \div {class="float-left"}
\inlineimage qtdemo-small.png
\enddiv
diff --git a/src/declarative/graphicsitems/qdeclarativeflickable.cpp b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
index 7ebed2f..2939c35 100644
--- a/src/declarative/graphicsitems/qdeclarativeflickable.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
@@ -373,7 +373,7 @@ void QDeclarativeFlickablePrivate::updateBeginningEnd()
\section1 Example Usage
- \div {float-right}
+ \div {class="float-right"}
\inlineimage flickable.gif
\enddiv
diff --git a/src/declarative/graphicsitems/qdeclarativegridview.cpp b/src/declarative/graphicsitems/qdeclarativegridview.cpp
index bb5b68b..2191e65 100644
--- a/src/declarative/graphicsitems/qdeclarativegridview.cpp
+++ b/src/declarative/graphicsitems/qdeclarativegridview.cpp
@@ -1095,7 +1095,7 @@ void QDeclarativeGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal m
\snippet doc/src/snippets/declarative/gridview/ContactModel.qml 0
- \div {float-right}
+ \div {class="float-right"}
\inlineimage gridview-simple.png
\enddiv
@@ -1111,7 +1111,7 @@ void QDeclarativeGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal m
\codeline
\snippet doc/src/snippets/declarative/gridview/gridview.qml classdocs simple
- \div {float-right}
+ \div {class="float-right"}
\inlineimage gridview-highlight.png
\enddiv
diff --git a/src/declarative/graphicsitems/qdeclarativemousearea.cpp b/src/declarative/graphicsitems/qdeclarativemousearea.cpp
index 3d5c29f..d95cb33 100644
--- a/src/declarative/graphicsitems/qdeclarativemousearea.cpp
+++ b/src/declarative/graphicsitems/qdeclarativemousearea.cpp
@@ -216,7 +216,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
\section1 Example Usage
- \div {float-right}
+ \div {class="float-right"}
\inlineimage qml-mousearea-snippet.png
\enddiv
diff --git a/src/declarative/graphicsitems/qdeclarativerectangle.cpp b/src/declarative/graphicsitems/qdeclarativerectangle.cpp
index 7bb6afb..56acfa4 100644
--- a/src/declarative/graphicsitems/qdeclarativerectangle.cpp
+++ b/src/declarative/graphicsitems/qdeclarativerectangle.cpp
@@ -131,7 +131,7 @@ void QDeclarativeGradientStop::updateGradient()
\section1 Example Usage
- \div {float-right}
+ \div {class="float-right"}
\inlineimage qml-gradient.png
\enddiv
@@ -217,7 +217,7 @@ void QDeclarativeGradient::doUpdate()
\section1 Example Usage
- \div {float-right}
+ \div {class="float-right"}
\inlineimage declarative-rect.png
\enddiv
@@ -269,7 +269,7 @@ void QDeclarativeRectangle::doUpdate()
rectangle (as documented for QRect rendering). This can cause unintended effects if
\c border.width is 1 and the rectangle is \l{Item::clip}{clipped} by a parent item:
- \div {float-right}
+ \div {class="float-right"}
\inlineimage rect-border-width.png
\enddiv
@@ -293,7 +293,7 @@ QDeclarativePen *QDeclarativeRectangle::border()
This property allows for the construction of simple vertical gradients.
Other gradients may by formed by adding rotation to the rectangle.
- \div {float-left}
+ \div {class="float-left"}
\inlineimage declarative-rect_gradient.png
\enddiv
@@ -361,7 +361,7 @@ void QDeclarativeRectangle::setRadius(qreal radius)
The default color is white.
- \div {float-right}
+ \div {class="float-right"}
\inlineimage rect-color.png
\enddiv
diff --git a/src/declarative/util/qdeclarativelistmodel.cpp b/src/declarative/util/qdeclarativelistmodel.cpp
index 0f117f5..27b969b 100644
--- a/src/declarative/util/qdeclarativelistmodel.cpp
+++ b/src/declarative/util/qdeclarativelistmodel.cpp
@@ -108,7 +108,7 @@ QDeclarativeListModelParser::ListInstruction *QDeclarativeListModelParser::ListM
The following example shows a ListModel containing three elements, with the roles
"name" and "cost".
- \div {float-right}
+ \div {class="float-right"}
\inlineimage listmodel.png
\enddiv
@@ -133,7 +133,7 @@ QDeclarativeListModelParser::ListInstruction *QDeclarativeListModelParser::ListM
The delegate displays all the fruit attributes:
- \div {float-right}
+ \div {class="float-right"}
\inlineimage listmodel-nested.png
\enddiv
diff --git a/src/gui/graphicsview/qgraphicsanchorlayout.cpp b/src/gui/graphicsview/qgraphicsanchorlayout.cpp
index fe0ad86..4205f26 100644
--- a/src/gui/graphicsview/qgraphicsanchorlayout.cpp
+++ b/src/gui/graphicsview/qgraphicsanchorlayout.cpp
@@ -56,7 +56,7 @@
Items that are anchored are automatically added to the layout, and if items
are removed, all their anchors will be automatically removed.
- \div {float-left}
+ \div {class="float-left"}
\inlineimage simpleanchorlayout-example.png Using an anchor layout to align simple colored widgets.
\enddiv
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 24ecea5..667bf80 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -91,6 +91,7 @@ QString DitaXmlGenerator::sinceTitles[] =
*/
QString DitaXmlGenerator::ditaTags[] =
{
+ "",
"alt",
"apiDesc",
"APIMap",
@@ -286,9 +287,11 @@ void DitaXmlGenerator::writeStartTag(DitaTag t)
Pop the current DITA tag off the stack, and write the
appropriate end tag to the DITA XML file.
*/
-void DitaXmlGenerator::writeEndTag()
+void DitaXmlGenerator::writeEndTag(DitaTag t)
{
- tagStack.pop();
+ DitaTag top = tagStack.pop();
+ if (t > DT_NONE && top != t)
+ qDebug() << "Expected:" << t << "ACTUAL:" << top;
xmlWriter().writeEndElement();
}
@@ -583,7 +586,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
int skipAhead = 0;
QString hx, str;
static bool in_para = false;
- QString guid, hc;
+ QString guid, hc, attr;
switch (atom->type()) {
case Atom::AbstractLeft:
@@ -694,15 +697,12 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::DivLeft:
{
- QString attr = atom->string();
+ attr = atom->string();
DitaTag t = currentTag();
if ((t == DT_section) || (t == DT_sectiondiv))
- t = DT_sectiondiv;
+ writeStartTag(DT_sectiondiv);
else if ((t == DT_body) || (t == DT_bodydiv))
- t = DT_bodydiv;
- else
- t = DT_p;
- writeStartTag(t);
+ writeStartTag(DT_bodydiv);
if (!attr.isEmpty()) {
if (attr.contains('=')) {
int index = 0;
@@ -729,7 +729,8 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
}
break;
case Atom::DivRight:
- writeEndTag(); // </sectiondiv>
+ if ((currentTag() == DT_sectiondiv) || (currentTag() == DT_bodydiv))
+ writeEndTag(); // </sectiondiv>, </bodydiv>, or </p>
break;
case Atom::FootnoteLeft:
// ### For now
@@ -1414,6 +1415,30 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
writeStartTag(DT_tbody);
}
writeStartTag(DT_row);
+ attr = atom->string();
+ if (!attr.isEmpty()) {
+ if (attr.contains('=')) {
+ int index = 0;
+ int from = 0;
+ QString values;
+ while (index >= 0) {
+ index = attr.indexOf('"',from);
+ if (index >= 0) {
+ ++index;
+ from = index;
+ index = attr.indexOf('"',from);
+ if (index > from) {
+ if (!values.isEmpty())
+ values.append(' ');
+ values += attr.mid(from,index-from);
+ from = index+1;
+ }
+ }
+ }
+ attr = values;
+ }
+ xmlWriter().writeAttribute("outputclass", attr);
+ }
xmlWriter().writeAttribute("valign","top");
break;
case Atom::TableRowRight:
@@ -1421,16 +1446,40 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::TableItemLeft:
{
+ QString values = "";
writeStartTag(DT_entry);
- QStringList spans = atom->string().split(",");
- if (spans.size() == 2) {
- if (inTableHeader ||
- (spans[0].toInt() != 1) ||
- (spans[1].toInt() != 1)) {
- QString s = "span(" + spans[0] + "," + spans[1] + ")";
- xmlWriter().writeAttribute("outputclass",s);
+ for (int i=0; i<atom->count(); ++i) {
+ attr = atom->string(i);
+ if (attr.contains('=')) {
+ int index = 0;
+ int from = 0;
+ while (index >= 0) {
+ index = attr.indexOf('"',from);
+ if (index >= 0) {
+ ++index;
+ from = index;
+ index = attr.indexOf('"',from);
+ if (index > from) {
+ if (!values.isEmpty())
+ values.append(' ');
+ values += attr.mid(from,index-from);
+ from = index+1;
+ }
+ }
+ }
+ }
+ else {
+ qDebug() << "ATTR:" << attr;
+ QStringList spans = attr.split(",");
+ if (spans.size() == 2) {
+ if ((spans[0].toInt()>1) || (spans[1].toInt()>1)) {
+ values += "span(" + spans[0] + "," + spans[1] + ")";
+ }
+ }
}
}
+ if (!values.isEmpty())
+ xmlWriter().writeAttribute("outputclass",values);
if (matchAhead(atom, Atom::ParaLeft))
skipAhead = 1;
}
diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h
index 785b10a..4676770 100644
--- a/tools/qdoc3/ditaxmlgenerator.h
+++ b/tools/qdoc3/ditaxmlgenerator.h
@@ -82,6 +82,7 @@ class DitaXmlGenerator : public PageGenerator
};
enum DitaTag {
+ DT_NONE,
DT_alt,
DT_apiDesc,
DT_APIMap,
@@ -407,7 +408,7 @@ class DitaXmlGenerator : public PageGenerator
void addLink(const QString& href, const QStringRef& text);
void writeDitaMap();
void writeStartTag(DitaTag t);
- void writeEndTag();
+ void writeEndTag(DitaTag t=DT_NONE);
DitaTag currentTag();
private:
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index 36c1d94..e54b7dd 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -403,9 +403,14 @@ class DocParser
Location cachedLoc;
int cachedPos;
- DocPrivate *priv;
- enum ParaState { OutsidePara, InsideSingleLinePara, InsideMultiLinePara };
- ParaState paraState;
+ DocPrivate* priv;
+ enum ParagraphState {
+ OutsidePara,
+ InSingleLinePara,
+ InMultiLinePara
+ };
+ QStack<ParagraphState> paragraphStateStack;
+ ParagraphState paraState;
bool inTableHeader;
bool inTableRow;
bool inTableItem;
@@ -452,6 +457,7 @@ void DocParser::parse(const QString& source,
priv = docPrivate;
priv->text << Atom::Nop;
+ paragraphStateStack.clear();
paraState = OutsidePara;
inTableHeader = false;
inTableRow = false;
@@ -561,18 +567,11 @@ void DocParser::parse(const QString& source,
break;
#endif
case CMD_DIV:
- p1 = getArgument(true);
leavePara();
- if (p1.contains('=')) {
- enterPara(Atom::DivLeft, Atom::DivRight,p1);
- openedCommands.push(cmd);
- }
- else {
- append(Atom::DivLeft, p1);
- openedCommands.push(cmd);
- enterPara();
- }
-
+ p1 = getArgument(true);
+ //enterPara(Atom::DivLeft, Atom::DivRight, p1);
+ append(Atom::DivLeft, p1);
+ openedCommands.push(cmd);
break;
case CMD_ENDDIV:
leavePara();
@@ -658,7 +657,7 @@ void DocParser::parse(const QString& source,
if (closeCommand(cmd)) {
leavePara();
append(Atom::FootnoteRight);
- paraState = InsideMultiLinePara; // ###
+ paraState = InMultiLinePara; // ###
}
break;
case CMD_ENDIF:
@@ -1339,7 +1338,7 @@ void DocParser::parse(const QString& source,
if (ch.isSpace()) {
++pos;
if ((ch == '\n') &&
- (paraState == InsideSingleLinePara ||
+ (paraState == InSingleLinePara ||
isBlankLine())) {
leavePara();
newWord = false;
@@ -1904,10 +1903,10 @@ void DocParser::enterPara(Atom::Type leftType,
pendingParaRightType = rightType;
pendingParaString = string;
if (leftType == Atom::SectionHeadingLeft) {
- paraState = InsideSingleLinePara;
+ paraState = InSingleLinePara;
}
else {
- paraState = InsideMultiLinePara;
+ paraState = InMultiLinePara;
}
skipSpacesOrOneEndl();
}
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 2f990b0..e095685 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -524,14 +524,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
break;
case Atom::DivLeft:
out() << "<div";
- if (!atom->string().isEmpty()) {
- if (atom->string().contains('='))
- out() << " " << atom->string() << ">";
- else
- out() << " class=\"" << atom->string() << "\">";
- }
- else
- out() << ">";
+ if (!atom->string().isEmpty())
+ out() << " " << atom->string();
+ out() << ">";
break;
case Atom::DivRight:
out() << "</div>";
@@ -1106,13 +1101,8 @@ int HtmlGenerator::generateAtom(const Atom *atom,
}
break;
case Atom::TableRowLeft:
- if (!atom->string().isEmpty()) {
- out() << "<tr ";
- if (atom->string().contains('='))
- out() << " " << atom->string() << ">";
- else
- out() << " class=\"" << atom->string() << "\">";
- }
+ if (!atom->string().isEmpty())
+ out() << "<tr " << atom->string() << ">";
else if (++numTableRows % 2 == 1)
out() << "<tr class=\"odd\">";
else
--
cgit v0.12
From d1eca385ada333483c7f7191327d096233d124ba Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 20 Jan 2011 09:14:10 +0100
Subject: qdoc: Removed some uses of \raw an d \endraw.
8 instances of raw-html remain.
---
doc/src/declarative/basictypes.qdoc | 3 ---
doc/src/examples/fademessage.qdoc | 8 ++------
2 files changed, 2 insertions(+), 9 deletions(-)
diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc
index 034b7d1..3ceb5a0 100644
--- a/doc/src/declarative/basictypes.qdoc
+++ b/doc/src/declarative/basictypes.qdoc
@@ -130,9 +130,6 @@
Image { source: "pics/logo.png" }
\endqml
- \raw HTML
- \endraw
-
\sa {QML Basic Types}
*/
diff --git a/doc/src/examples/fademessage.qdoc b/doc/src/examples/fademessage.qdoc
index 15f7ce4..aca9ac9 100644
--- a/doc/src/examples/fademessage.qdoc
+++ b/doc/src/examples/fademessage.qdoc
@@ -29,13 +29,9 @@
\example effects/fademessage
\title Fade Message Effect Example
- \raw HTML
- <div style="text-align: center">
- \endraw
+ \div { style="text-align: center"}
\inlineimage fademessageeffect-example.png
\inlineimage fademessageeffect-example-faded.png
- \raw HTML
- </div>
- \endraw
+ \enddiv
*/
--
cgit v0.12
From adf175a0f69e9ae325622510ae23e8c797991afc Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 24 Jan 2011 11:28:17 +0100
Subject: qdoc: Added the \span command.
e.g. \span {id="color-red"} {Color this text only}, not this text.
---
doc/src/examples/globalVariables.qdoc | 61 ++++++++++--------------------
doc/src/template/style/style.css | 11 ++++++
src/corelib/global/qnamespace.qdoc | 34 ++++++++---------
tools/qdoc3/atom.cpp | 1 +
tools/qdoc3/atom.h | 2 +
tools/qdoc3/ditaxmlgenerator.cpp | 31 ++++++++++++++++
tools/qdoc3/ditaxmlgenerator.h | 2 +
tools/qdoc3/doc.cpp | 70 +++++++++++++++++------------------
tools/qdoc3/htmlgenerator.cpp | 21 +++++++----
9 files changed, 132 insertions(+), 101 deletions(-)
diff --git a/doc/src/examples/globalVariables.qdoc b/doc/src/examples/globalVariables.qdoc
index 8468abb..286efac 100644
--- a/doc/src/examples/globalVariables.qdoc
+++ b/doc/src/examples/globalVariables.qdoc
@@ -101,48 +101,25 @@
The \c xmlpatterns command loads and parses \c globals.gccxml,
runs the XQuery \c reportGlobals.xq, and generates this report:
- \raw HTML
-<html xmlns="http://www.w3.org/1999/xhtml/" xml:lang="en" lang="en">
- <head>
- <title>Global variables report for globals.gccxml</title>
- </head>
- <style type="text/css">
- .details
- {
- text-align: left;
- font-size: 80%;
- color: blue
- }
- .variableName
- {
- font-family: courier;
- color: blue
- }
- </style>
- <body>
- <p class="details">Start report: 2008-12-16T13:43:49.65Z</p>
- <p>Global variables with complex types:</p>
- <ol>
- <li>
- <span class="variableName">mutableComplex1</span> in globals.cpp at line 14</li>
- <li>
- <span class="variableName">mutableComplex2</span> in globals.cpp at line 15</li>
- <li>
- <span class="variableName">constComplex1</span> in globals.cpp at line 16</li>
- <li>
- <span class="variableName">constComplex2</span> in globals.cpp at line 17</li>
- </ol>
- <p>Mutable global variables with primitives types:</p>
- <ol>
- <li>
- <span class="variableName">mutablePrimitive1</span> in globals.cpp at line 1</li>
- <li>
- <span class="variableName">mutablePrimitive2</span> in globals.cpp at line 2</li>
- </ol>
- <p class="details">End report: 2008-12-16T13:43:49.65Z</p>
- </body>
-</html>
- \endraw
+ \div {class="details"}
+ Start report: 2008-12-16T13:43:49.65Z
+ \enddiv
+
+ Global variables with complex types:
+ \list 1
+ \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
+ \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
+ \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
+ \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
+ \endlist
+
+ Mutable global variables with primitives types:
+ \list 1
+ \o \span {class="variableName"} {mutablePrimitive1} in globals.cpp at line 1
+ \o \span {class="variableName"} {mutablePrimitive2} in globals.cpp at line 2
+ \endlist
+
+ \div {class="details"} End report: 2008-12-16T13:43:49.65Z \enddiv
\section1 XQuery Code Walk-Through
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index 7af5141..b32b025 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -1204,6 +1204,17 @@
margin: 15px;
}
+ .details
+ {
+ text-align: left;
+ font-size: 80%;
+ color: blue
+ }
+ .variableName
+ {
+ font-family: courier;
+ color: blue
+ }
.qmltype
{
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 060b979..e1a1fff 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -233,23 +233,23 @@
Qt's predefined QColor objects:
- \value white \div {id="color-white"} White (#ffffff) \enddiv
- \value black \div {id="color-black"} Black (#000000) \enddiv
- \value red \div {id="color-red"} Red (#ff0000) \enddiv
- \value darkRed \div {id="color-darkRed"} Dark red (#800000) \enddiv
- \value green \div {id="color-green"} Green (#00ff00) \enddiv
- \value darkGreen \div {id="color-darkGreen"} Dark green (#008000) \enddiv
- \value blue \div {id="color-blue"} Blue (#0000ff) \enddiv
- \value darkBlue \div {id="color-darkBlue"} Dark blue (#000080) \enddiv
- \value cyan \div {id="color-cyan"} Cyan (#00ffff) \enddiv
- \value darkCyan \div {id="color-darkCyan"} Dark cyan (#008080) \enddiv
- \value magenta \div {id="color-magenta"} Magenta (#ff00ff) \enddiv
- \value darkMagenta \div {id="color-darkMagenta"} Dark magenta (#800080) \enddiv
- \value yellow \div {id="color-yellow"} Yellow (#ffff00) \enddiv
- \value darkYellow \div {id="color-darkYellow"} Dark yellow (#808000) \enddiv
- \value gray \div {id="color-gray"} Gray (#a0a0a4) \enddiv
- \value darkGray \div {id="color-darkGray"} Dark gray (#808080) \enddiv
- \value lightGray \div {id="color-lightGray"} Light gray (#c0c0c0) \enddiv
+ \value white \span {id="color-white"} {White (#ffffff) }
+ \value black \span {id="color-black"} {Black (#000000) }
+ \value red \span {id="color-red"} {Red (#ff0000) }
+ \value darkRed \span {id="color-darkRed"} {Dark red (#800000) }
+ \value green \span {id="color-green"} {Green (#00ff00) }
+ \value darkGreen \span {id="color-darkGreen"} {Dark green (#008000) }
+ \value blue \span {id="color-blue"} {Blue (#0000ff) }
+ \value darkBlue \span {id="color-darkBlue"} {Dark blue (#000080) }
+ \value cyan \span {id="color-cyan"} {Cyan (#00ffff) }
+ \value darkCyan \span {id="color-darkCyan"} {Dark cyan (#008080) }
+ \value magenta \span {id="color-magenta"} {Magenta (#ff00ff) }
+ \value darkMagenta \span {id="color-darkMagenta"} {Dark magenta (#800080) }
+ \value yellow \span {id="color-yellow"} {Yellow (#ffff00) }
+ \value darkYellow \span {id="color-darkYellow"} {Dark yellow (#808000) }
+ \value gray \span {id="color-gray"} {Gray (#a0a0a4) }
+ \value darkGray \span {id="color-darkGray"} {Dark gray (#808080) }
+ \value lightGray \span {id="color-lightGray"} {Light gray (#c0c0c0) }
\value transparent a transparent black value (i.e., QColor(0, 0, 0, 0))
\value color0 0 pixel value (for bitmaps)
\value color1 1 pixel value (for bitmaps)
diff --git a/tools/qdoc3/atom.cpp b/tools/qdoc3/atom.cpp
index ef5b6c8..e6647ed 100644
--- a/tools/qdoc3/atom.cpp
+++ b/tools/qdoc3/atom.cpp
@@ -51,6 +51,7 @@ QString Atom::INDEX_ ("index");
QString Atom::ITALIC_ ("italic");
QString Atom::LINK_ ("link");
QString Atom::PARAMETER_ ("parameter");
+QString Atom::SPAN_ ("span");
QString Atom::SUBSCRIPT_ ("subscript");
QString Atom::SUPERSCRIPT_ ("superscript");
QString Atom::TELETYPE_ ("teletype");
diff --git a/tools/qdoc3/atom.h b/tools/qdoc3/atom.h
index c2b7cd6..325df28 100644
--- a/tools/qdoc3/atom.h
+++ b/tools/qdoc3/atom.h
@@ -189,6 +189,7 @@ class Atom
static QString ITALIC_;
static QString LINK_;
static QString PARAMETER_;
+ static QString SPAN_;
static QString SUBSCRIPT_;
static QString SUPERSCRIPT_;
static QString TELETYPE_;
@@ -214,6 +215,7 @@ class Atom
#define ATOM_FORMATTING_ITALIC "italic"
#define ATOM_FORMATTING_LINK "link"
#define ATOM_FORMATTING_PARAMETER "parameter"
+#define ATOM_FORMATTING_SPAN "span "
#define ATOM_FORMATTING_SUBSCRIPT "subscript"
#define ATOM_FORMATTING_SUPERSCRIPT "superscript"
#define ATOM_FORMATTING_TELETYPE "teletype"
diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp
index 667bf80..bc97dcd 100644
--- a/tools/qdoc3/ditaxmlgenerator.cpp
+++ b/tools/qdoc3/ditaxmlgenerator.cpp
@@ -202,6 +202,7 @@ QString DitaXmlGenerator::ditaTags[] =
"fig",
"i",
"image",
+ "keyword",
"li",
"link",
"linktext",
@@ -209,6 +210,7 @@ QString DitaXmlGenerator::ditaTags[] =
"ol",
"p",
"parameter",
+ "ph",
"pre",
"related-links",
"row",
@@ -759,6 +761,9 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
t = DT_i;
else if (atom->string() == ATOM_FORMATTING_TELETYPE)
t = DT_tt;
+ else if (atom->string().startsWith("span ")) {
+ t = DT_keyword;
+ }
else if (atom->string() == ATOM_FORMATTING_UNDERLINE)
t = DT_u;
else if (atom->string() == ATOM_FORMATTING_INDEX)
@@ -782,6 +787,32 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
}
}
}
+ else if (t == DT_keyword) {
+ QString attr = atom->string().mid(5);
+ if (!attr.isEmpty()) {
+ if (attr.contains('=')) {
+ int index = 0;
+ int from = 0;
+ QString values;
+ while (index >= 0) {
+ index = attr.indexOf('"',from);
+ if (index >= 0) {
+ ++index;
+ from = index;
+ index = attr.indexOf('"',from);
+ if (index > from) {
+ if (!values.isEmpty())
+ values.append(' ');
+ values += attr.mid(from,index-from);
+ from = index+1;
+ }
+ }
+ }
+ attr = values;
+ }
+ }
+ xmlWriter().writeAttribute("outputclass", attr);
+ }
}
break;
case Atom::FormattingRight:
diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h
index 4676770..488c5b0 100644
--- a/tools/qdoc3/ditaxmlgenerator.h
+++ b/tools/qdoc3/ditaxmlgenerator.h
@@ -193,6 +193,7 @@ class DitaXmlGenerator : public PageGenerator
DT_fig,
DT_i,
DT_image,
+ DT_keyword,
DT_li,
DT_link,
DT_linktext,
@@ -200,6 +201,7 @@ class DitaXmlGenerator : public PageGenerator
DT_ol,
DT_p,
DT_parameter,
+ DT_ph,
DT_pre,
DT_relatedLinks,
DT_row,
diff --git a/tools/qdoc3/doc.cpp b/tools/qdoc3/doc.cpp
index e54b7dd..391eada7 100644
--- a/tools/qdoc3/doc.cpp
+++ b/tools/qdoc3/doc.cpp
@@ -91,8 +91,8 @@ enum {
CMD_QUOTEFROMFILE, CMD_QUOTEFUNCTION, CMD_RAW, CMD_ROW,
CMD_SA, CMD_SECTION1, CMD_SECTION2, CMD_SECTION3,
CMD_SECTION4, CMD_SIDEBAR, CMD_SINCELIST, CMD_SKIPLINE,
- CMD_SKIPTO, CMD_SKIPUNTIL, CMD_SNIPPET, CMD_SUB, CMD_SUP,
- CMD_TABLE, CMD_TABLEOFCONTENTS, CMD_TARGET, CMD_TT,
+ CMD_SKIPTO, CMD_SKIPUNTIL, CMD_SNIPPET, CMD_SPAN, CMD_SUB,
+ CMD_SUP, CMD_TABLE, CMD_TABLEOFCONTENTS, CMD_TARGET, CMD_TT,
CMD_UNDERLINE, CMD_UNICODE, CMD_VALUE, CMD_WARNING,
#ifdef QDOC_QML
CMD_QML, CMD_ENDQML, CMD_CPP, CMD_ENDCPP, CMD_QMLTEXT,
@@ -184,6 +184,7 @@ static struct {
{ "skipto", CMD_SKIPTO, 0 },
{ "skipuntil", CMD_SKIPUNTIL, 0 },
{ "snippet", CMD_SNIPPET, 0 },
+ { "span", CMD_SPAN, 0 },
{ "sub", CMD_SUB, 0 },
{ "sup", CMD_SUP, 0 },
{ "table", CMD_TABLE, 0 },
@@ -368,7 +369,6 @@ class DocParser
void appendChar(QChar ch);
void appendWord(const QString &word);
void appendToCode(const QString &code);
- void startNewPara();
void enterPara(Atom::Type leftType = Atom::ParaLeft,
Atom::Type rightType = Atom::ParaRight,
const QString& string = "");
@@ -405,11 +405,10 @@ class DocParser
DocPrivate* priv;
enum ParagraphState {
- OutsidePara,
- InSingleLinePara,
- InMultiLinePara
+ OutsideParagraph,
+ InSingleLineParagraph,
+ InMultiLineParagraph
};
- QStack<ParagraphState> paragraphStateStack;
ParagraphState paraState;
bool inTableHeader;
bool inTableRow;
@@ -457,8 +456,7 @@ void DocParser::parse(const QString& source,
priv = docPrivate;
priv->text << Atom::Nop;
- paragraphStateStack.clear();
- paraState = OutsidePara;
+ paraState = OutsideParagraph;
inTableHeader = false;
inTableRow = false;
inTableItem = false;
@@ -569,7 +567,6 @@ void DocParser::parse(const QString& source,
case CMD_DIV:
leavePara();
p1 = getArgument(true);
- //enterPara(Atom::DivLeft, Atom::DivRight, p1);
append(Atom::DivLeft, p1);
openedCommands.push(cmd);
break;
@@ -657,7 +654,7 @@ void DocParser::parse(const QString& source,
if (closeCommand(cmd)) {
leavePara();
append(Atom::FootnoteRight);
- paraState = InMultiLinePara; // ###
+ paraState = InMultiLineParagraph; // ###
}
break;
case CMD_ENDIF:
@@ -744,7 +741,7 @@ void DocParser::parse(const QString& source,
if (openCommand(cmd)) {
enterPara();
append(Atom::FootnoteLeft);
- paraState = OutsidePara; // ###
+ paraState = OutsideParagraph; // ###
}
break;
case CMD_ANNOTATEDLIST:
@@ -804,7 +801,7 @@ void DocParser::parse(const QString& source,
append(Atom::String, " ");
break;
case CMD_INDEX:
- if (paraState == OutsidePara) {
+ if (paraState == OutsideParagraph) {
enterPara();
indexStartedPara = true;
}
@@ -1106,6 +1103,10 @@ void DocParser::parse(const QString& source,
append(Atom::CodeQuoteArgument, getRestOfLine());
}
break;
+ case CMD_SPAN:
+ p1 = ATOM_FORMATTING_SPAN + getArgument(true);
+ startFormat(p1, cmd);
+ break;
case CMD_SNIPPET:
leavePara();
{
@@ -1196,7 +1197,8 @@ void DocParser::parse(const QString& source,
}
break;
case CMD_WARNING:
- startNewPara();
+ leavePara();
+ enterPara();
append(Atom::FormattingLeft, ATOM_FORMATTING_BOLD);
append(Atom::String, "Warning:");
append(Atom::FormattingRight, ATOM_FORMATTING_BOLD);
@@ -1286,8 +1288,7 @@ void DocParser::parse(const QString& source,
braceDepth--;
pos++;
- QMap<int, QString>::Iterator f =
- pendingFormats.find(braceDepth);
+ QMap<int, QString>::Iterator f = pendingFormats.find(braceDepth);
if (f == pendingFormats.end()) {
enterPara();
appendChar('}');
@@ -1324,7 +1325,7 @@ void DocParser::parse(const QString& source,
newWord = false;
}
- if (paraState == OutsidePara) {
+ if (paraState == OutsideParagraph) {
if (ch.isSpace()) {
++pos;
newWord = false;
@@ -1338,7 +1339,7 @@ void DocParser::parse(const QString& source,
if (ch.isSpace()) {
++pos;
if ((ch == '\n') &&
- (paraState == InSingleLinePara ||
+ (paraState == InSingleLineParagraph ||
isBlankLine())) {
leavePara();
newWord = false;
@@ -1702,8 +1703,7 @@ bool DocParser::closeCommand(int endCmd)
}
}
else {
- location().warning(tr("Unexpected '\\%1'")
- .arg(cmdName(endCmd)));
+ location().warning(tr("Unexpected '\\%1'").arg(cmdName(endCmd)));
}
return false;
}
@@ -1882,31 +1882,27 @@ void DocParser::appendToCode(const QString& markedCode)
priv->text.lastAtom()->appendString(markedCode);
}
-void DocParser::startNewPara()
-{
- leavePara();
- enterPara();
-}
-
void DocParser::enterPara(Atom::Type leftType,
Atom::Type rightType,
const QString& string)
{
- if (paraState == OutsidePara) {
+ if (paraState == OutsideParagraph) {
+
if ((priv->text.lastAtom()->type() != Atom::ListItemLeft) &&
(priv->text.lastAtom()->type() != Atom::DivLeft)) {
leaveValueList();
}
+
append(leftType, string);
indexStartedPara = false;
pendingParaLeftType = leftType;
pendingParaRightType = rightType;
pendingParaString = string;
if (leftType == Atom::SectionHeadingLeft) {
- paraState = InSingleLinePara;
+ paraState = InSingleLineParagraph;
}
else {
- paraState = InMultiLinePara;
+ paraState = InMultiLineParagraph;
}
skipSpacesOrOneEndl();
}
@@ -1914,7 +1910,7 @@ void DocParser::enterPara(Atom::Type leftType,
void DocParser::leavePara()
{
- if (paraState != OutsidePara) {
+ if (paraState != OutsideParagraph) {
if (!pendingFormats.isEmpty()) {
location().warning(tr("Missing '}'"));
pendingFormats.clear();
@@ -1930,7 +1926,7 @@ void DocParser::leavePara()
}
append(pendingParaRightType, pendingParaString);
}
- paraState = OutsidePara;
+ paraState = OutsideParagraph;
indexStartedPara = false;
pendingParaRightType = Atom::Nop;
pendingParaString = "";
@@ -2164,10 +2160,8 @@ QString DocParser::getArgument(bool verbatim)
location().warning(tr("Missing '}'"));
}
else {
- while (pos < in.length() &&
- ((delimDepth > 0) ||
- ((delimDepth == 0) &&
- !in[pos].isSpace()))) {
+ while ((pos < in.length()) &&
+ ((delimDepth > 0) || ((delimDepth == 0) && !in[pos].isSpace()))) {
switch (in[pos].unicode()) {
case '(':
case '[':
@@ -2372,6 +2366,9 @@ bool DocParser::isLeftBraceAhead()
return numEndl < 2 && i < len && in[i] == '{';
}
+/*!
+ Skips to the next non-space character or EOL.
+ */
void DocParser::skipSpacesOnLine()
{
while ((pos < in.length()) &&
@@ -2380,6 +2377,9 @@ void DocParser::skipSpacesOnLine()
++pos;
}
+/*!
+ Skips spaces and on EOL.
+ */
void DocParser::skipSpacesOrOneEndl()
{
int firstEndl = -1;
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index e095685..1623ea8 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -548,7 +548,11 @@ int HtmlGenerator::generateAtom(const Atom *atom,
case Atom::FormatIf:
break;
case Atom::FormattingLeft:
- out() << formattingLeftMap()[atom->string()];
+ if (atom->string().startsWith("span ")) {
+ out() << "<" + atom->string() << ">";
+ }
+ else
+ out() << formattingLeftMap()[atom->string()];
if (atom->string() == ATOM_FORMATTING_PARAMETER) {
if (atom->next() != 0 && atom->next()->type() == Atom::String) {
QRegExp subscriptRegExp("([a-z]+)_([0-9n])");
@@ -564,6 +568,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
if (atom->string() == ATOM_FORMATTING_LINK) {
endLink();
}
+ else if (atom->string().startsWith("span ")) {
+ out() << "</span>";
+ }
else {
out() << formattingRightMap()[atom->string()];
}
@@ -948,10 +955,10 @@ int HtmlGenerator::generateAtom(const Atom *atom,
else { // (atom->string() == ATOM_LIST_VALUE)
// ### Trenton
- out() << "<tr><td class=\"topAlign\"><tt>"
+ out() << "<tr><td class=\"topAlign\"><tt>"
<< protectEnc(plainCode(marker->markedUpEnumValue(atom->next()->string(),
relative)))
- << "</tt></td><td class=\" topAlign\">";
+ << "</tt></td><td class=\"topAlign\">";
QString itemValue;
if (relative->type() == Node::Enum) {
@@ -977,7 +984,7 @@ int HtmlGenerator::generateAtom(const Atom *atom,
}
else if (atom->string() == ATOM_LIST_VALUE) {
if (threeColumnEnumValueTable) {
- out() << "</td><td class=\"topAlign\">";
+ out() << "</td><td class=\"topAlign\">";
if (matchAhead(atom, Atom::ListItemRight))
out() << " ";
}
@@ -2601,7 +2608,7 @@ void HtmlGenerator::generateSection(const NodeList& nl,
else {
if (twoColumn)
out() << "<table class=\"propsummary\">\n"
- << "<tr><td class=\"topAlign\">";
+ << "<tr><td class=\"topAlign\">";
out() << "<ul>\n";
}
@@ -2618,7 +2625,7 @@ void HtmlGenerator::generateSection(const NodeList& nl,
}
else {
if (twoColumn && i == (int) (nl.count() + 1) / 2)
- out() << "</ul></td><td class=\"topAlign\"><ul>\n";
+ out() << "</ul></td><td class=\"topAlign\"><ul>\n";
out() << "<li class=\"fn\">";
}
@@ -2662,7 +2669,7 @@ void HtmlGenerator::generateSectionList(const Section& section,
else {
if (twoColumn)
out() << "<table class=\"propsummary\">\n"
- << "<tr><td class=\"topAlign\">";
+ << "<tr><td class=\"topAlign\">";
out() << "<ul>\n";
}
--
cgit v0.12
From 046cf4d3de6cca9c7b3f734ad035b6cf6fcbef4f Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 28 Jan 2011 09:39:20 +0100
Subject: qdoc: Updated the qdoc manual.
Added \span and \div marked "new" and marked
\raw "avoid".
---
doc/src/template/style/style.css | 44 ++++---
tools/qdoc3/doc/qdoc-manual.qdoc | 251 +++++++++++++++++++++++++++++++++++++--
2 files changed, 266 insertions(+), 29 deletions(-)
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index b32b025..06de245 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -383,10 +383,10 @@
{
font-size: 13px;
}
- .red
- {
- color:red;
- }
+ .red
+ {
+ color:red;
+ }
/* end font style elements */
/* global settings*/
@@ -1199,10 +1199,10 @@
padding:0px;
}
- .content .alignedsummary
- {
- margin: 15px;
- }
+ .content .alignedsummary
+ {
+ margin: 15px;
+ }
.details
{
@@ -1215,6 +1215,12 @@
font-family: courier;
color: blue
}
+ .newStuff
+ {
+ text-align: left;
+ font-size: 80%;
+ color: red
+ }
.qmltype
{
@@ -1276,11 +1282,11 @@
height: 120px;
margin: 0px 25px 10px 15px;
}
- #noteHead
- {
- font-weight:bold;
- padding:10px 10px 10px 20px;
- }
+ #noteHead
+ {
+ font-weight:bold;
+ padding:10px 10px 10px 20px;
+ }
#feedsubmit
{
display: inline;
@@ -1288,12 +1294,12 @@
margin: 4px 32px 0 0;
}
- .note
- {
- font-size:7pt;
- padding-bottom:3px;
- padding-left:20px;
- }
+ .note
+ {
+ font-size:7pt;
+ padding-bottom:3px;
+ padding-left:20px;
+ }
#blurpage
{
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index b557ad9..3036af8 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -36,7 +36,7 @@
\o \l{QDoc Commands}
\list
\o \l{Markup Commands}
- \o \l{Text Formatting Commands}
+ \o \l{Text Formatting Commands} \span {class="newStuff"} {(new commands)}
\o \l{Document Structuring Commands}
\o \l{Verbatim Code Commands}
\o \l{Quoting External Code Commands}
@@ -109,7 +109,7 @@
\list
\o \l {Markup Commands}
\list
- \o \l {Text Formatting Commands}{Text Formatting}
+ \o \l {Text Formatting Commands}{Text Formatting} \span {class="newStuff"} {(new commands)}
\o \l {Document Structuring Commands}{Document Structuring}
\o \l {Verbatim Code Commands}{Verbatim Code}
\o \l {Quoting External Code Commands}{Quoting External Code}
@@ -218,6 +218,7 @@
\l {05-qdoc-commands-documentstructuring.html#chapter}{\\chapter},
\l {06-qdoc-commands-verbatimcode.html#code}{\\code},
\l {07-0-qdoc-commands-quoting.html#codeline}{\\codeline},
+ \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)},
\l {07-0-qdoc-commands-quoting.html#dots}{\\dots},
\l {12-0-qdoc-commands-miscellaneous.html#else}{\\else},
\l {12-0-qdoc-commands-miscellaneous.html#endif}{\\endif},
@@ -246,7 +247,7 @@
\l {11-qdoc-commands-documentcontents.html#quotation}{\\quotation},
\l {07-0-qdoc-commands-quoting.html#quotefile}{\\quotefile},
\l {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)},
\l {10-qdoc-commands-container.html#row}{\\row},
\l {08-qdoc-commands-linking.html#sa}{\\sa},
\l {05-qdoc-commands-documentstructuring.html#sectionOne}{\\section1},
@@ -257,6 +258,7 @@
\l {07-0-qdoc-commands-quoting.html#skipto}{\\skipto},
\l {07-0-qdoc-commands-quoting.html#skipuntil}{\\skipuntil},
\l {07-0-qdoc-commands-quoting.html#snippet}{\\snippet},
+ \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)},
\l {04-qdoc-commands-textformatting.html#sub}{\\sub},
\l {04-qdoc-commands-textformatting.html#sup}{\\sup},
\l {10-qdoc-commands-container.html#table}{\\table},
@@ -300,7 +302,9 @@
\l {04-qdoc-commands-textformatting.html#a}{\\a},
\l {04-qdoc-commands-textformatting.html#bold}{\\bold},
\l {04-qdoc-commands-textformatting.html#c}{\\c},
+ \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)},
\l {04-qdoc-commands-textformatting.html#i}{\\i},
+ \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)},
\l {04-qdoc-commands-textformatting.html#sub}{\\sub},
\l {04-qdoc-commands-textformatting.html#sup}{\\sup},
\l {04-qdoc-commands-textformatting.html#tt}{\\tt},
@@ -448,6 +452,229 @@
See also \l {tt}{\\tt} and \l {code}{\\code}.
\row
+ \o \bold \\div \span {class="newStuff"} {(new)} \target div
+ \o \bold {The \\div command and the corresponding \\enddiv
+ command delimit a large or small block of text and qdoc
+ commands for which special formatting attributes apply.}
+
+ An argument must be provided in curly braces, as in the
+ qdoc comment shown below. The argument is not interpreted
+ but is used as attribute(s) of the tag that is ultimately
+ output by qdoc.
+
+ For example, we might want to render an inline image so
+ that it floats to the right of the current block of text:
+
+ \code
+ / *!
+
+ \div {class="float-right"}
+ \inlineimage qml-column.png
+ \enddiv
+
+ * /
+ \endcode
+
+ If qdoc is generating HTML, it will translate these
+ commands to:
+
+ \code
+ <div class="float-right"><p><img src="images/qml-column.png" /></p></div>
+ \endcode
+
+ For HTML, the attribute value \e {float-right} then will
+ refer to a clause in the style.css file. which in this case
+ could be:
+
+ \code
+ div.float-right
+ {
+ float: right; margin-left: 2em
+ }
+ \endcode
+
+ If qdoc is generating DITA XML, it will translate the commands to:
+
+ \code
+ <sectiondiv outputclass="float-right">
+ <p>
+ <fig>
+ <image href="images/qml-column.png" placement="inline"/>
+ </fig>
+ </p>
+ </sectiondiv>
+ \endcode
+
+ Your DITA XML publishing program must then recognize the \e
+ outputclass attribute value.
+
+ \note The \bold {\\div} command can be nested.
+
+ Below is an example taken from the index.qdoc file used to
+ generate index.html for Qt 4.7:
+
+ \code
+ \div {class="indexbox guide"}
+ \div {class="heading"}
+ Qt Developer Guide
+ \enddiv
+ \div {class="indexboxcont indexboxbar"}
+ \div {class="section indexIcon"} \emptyspan
+ \enddiv
+ \div {class="section"}
+ Qt is a cross-platform application and UI
+ framework. Using Qt, you can write web-enabled
+ applications once and deploy them across desktop,
+ mobile and embedded operating systems without
+ rewriting the source code.
+ \enddiv
+ \div {class="section sectionlist"}
+ \list
+ \o \l{Getting Started Guides}{Getting started}
+ \o \l{Installation}{Installation}
+ \o \l{how-to-learn-qt.html}{How to learn Qt}
+ \o \l{tutorials.html}{Tutorials}
+ \o \l{Qt Examples}{Examples}
+ \o \l{qt4-7-intro.html}{What's new in Qt 4.7}
+ \endlist
+ \enddiv
+ \enddiv
+ \enddiv
+ \endcode
+
+ When all the class attribute values are defined as they are
+ in the style.css file that is used for rendering the Qt 4.7
+ documentation, the above example is rendered as:
+
+ \div {class="indexbox guide"}
+ \div {class="heading"}
+ Qt Developer Guide
+ \enddiv
+ \div {class="indexboxcont indexboxbar"}
+ \div {class="section indexIcon"} \emptyspan
+ \enddiv
+ \div {class="section"}
+ Qt is a cross-platform application and UI
+ framework. Using Qt, you can write web-enabled
+ applications once and deploy them across desktop,
+ mobile and embedded operating systems without
+ rewriting the source code.
+ \enddiv
+ \div {class="section sectionlist"}
+ \list
+ \o \l{Getting Started Guides}{Getting started}
+ \o \l{Installation}{Installation}
+ \o \l{how-to-learn-qt.html}{How to learn Qt}
+ \o \l{tutorials.html}{Tutorials}
+ \o \l{Qt Examples}{Examples}
+ \o \l{qt4-7-intro.html}{What's new in Qt 4.7}
+ \endlist
+ \enddiv
+ \enddiv
+ \enddiv
+
+ When generating DITA XML, qdoc outputs the nested \e div commands as:
+
+ \code
+ <sectiondiv outputclass="indexbox guide">
+ <sectiondiv outputclass="heading">
+ <p>Qt Developer Guide</p>
+ </sectiondiv>
+ <sectiondiv outputclass="indexboxcont indexboxbar">
+ <sectiondiv outputclass="section indexIcon"/>
+ <sectiondiv outputclass="section">
+ <p>Qt is a cross-platform application and UI
+ framework. Using Qt, you can write
+ web-enabled applications once and deploy
+ them across desktop, mobile and embedded
+ operating systems without rewriting the
+ source code.
+ </p>
+ </sectiondiv>
+ <sectiondiv outputclass="section sectionlist">
+ <ul>
+ <li>
+ <xref href="gettingstarted.xml#id-606ee7a8-219b-47b7-8f94-91bc8c76e54c">Getting started</xref>
+ </li>
+ <li>
+ <xref href="installation.xml#id-075c20e2-aa1e-4f88-a316-a46517e50443">Installation</xref>
+ </li>
+ <li>
+ <xref href="how-to-learn-qt.xml#id-49f509b5-52f9-4cd9-9921-74217b9a5182">How to learn Qt</xref>
+ </li>
+ <li>
+ <xref href="tutorials.xml#id-a737f955-a904-455f-b4aa-0dc69ed5a64f">Tutorials</xref>
+ </li>
+ <li>
+ <xref href="all-examples.xml#id-98d95159-d65b-4706-b08f-13d80080448d">Examples</xref>
+ </li>
+ <li>
+ <xref href="qt4-7-intro.xml#id-519ae0e3-4242-4c2a-b2be-e05d1e95f177">What's new in Qt 4.7</xref>
+ </li>
+ </ul>
+ </sectiondiv>
+ </sectiondiv>
+ </sectiondiv>
+ \endcode
+
+ Your DITA XML publishing program must recognize the values
+ of the \e outputclass attribute.
+
+ See also \l {span}{\\span}.
+
+ \row
+ \o \bold \\span \span {class="newStuff"} {(new)} \target span
+ \o \bold {The \\span command is for applying special formatting
+ attributes to a small block of text.}
+
+ Two arguments must be provided, each argument in curly
+ braces, as shown in the qdoc comment below. The first
+ argument is not interpreted but is used as the formatting
+ attribute(s) of the tag that is ultimately output by
+ qdoc. The second argument is the text to be rendered with
+ the special formatting attributes.
+
+ For example, we might want to render the first word of each
+ element in a numeric list in blue.
+
+ \code
+ / *!
+ Global variables with complex types:
+ \list 1
+ \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
+ \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
+ \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
+ \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
+ \endlist
+ * /
+ \endcode
+
+ Class \e variableName refers to a clause in your style.css.
+
+ \code
+ .variableName
+ {
+ font-family: courier;
+ color: blue
+ }
+ \endcode
+
+ Using the \e variableName clause shown above, the example is rendered as:
+
+ Global variables with complex types:
+ \list 1
+ \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
+ \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
+ \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
+ \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
+ \endlist
+
+ \note The \bold span command does not cause a new paragraph to
+ be started.
+
+ See also \l {div}{\\div}.
+
+ \row
\o \bold \\tt \target tt
\o \bold {The \\tt command can be used to render variables,
user-defined classes and C++ keywords like \c int, \c
@@ -3608,7 +3835,7 @@
\l {12-0-qdoc-commands-miscellaneous.html#include}{\\include},
\l {12-0-qdoc-commands-miscellaneous.html#meta}{\\meta},
\l {12-0-qdoc-commands-miscellaneous.html#omit}{\\omit},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)},
\l {12-0-qdoc-commands-miscellaneous.html#raw}{\\unicode}
\section1 Command Descriptions
@@ -4335,10 +4562,16 @@
\row
- \o \bold \\raw \target raw
+ \o \bold \\raw \span {class="newStuff"} {(avoid)} \target raw
\o \bold {The \\raw command and the corresponding
\\endraw command delimit a block of raw mark-up language code.}
+ \note Avoid using this command if possible, because it generates
+ DITA XML code that causes problems. If you are trying to generate
+ special table or list behavior, try to get the behavior you want
+ using the \l {span} {\\span} and \l {div} {\\div} commands in your
+ \l {table} {\\table} or \l {list} {\\list}.
+
The command takes an argument specifying the code's format;
currently the only supported format is HTML.
@@ -4410,10 +4643,6 @@
\unicode 0x3A3 \i{a}\sub{\i{i}}
\endquotation
-
- The \\raw command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation and use of
- braces} for the argument.
\endtable
*/
@@ -8682,6 +8911,7 @@
\o \l {07-0-qdoc-commands-quoting.html#codeline}{\\codeline},
\o \l {16-qdoc-commands-status.html#compat}{\\compat}
\o \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage}
+ \o \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)}
\o \l {07-0-qdoc-commands-quoting.html#dots}{\\dots}
\o \l {12-0-qdoc-commands-miscellaneous.html#else}{\\else}
\o \l {12-0-qdoc-commands-miscellaneous.html#endif}{\\endif}
@@ -8733,7 +8963,7 @@
\o \l {11-qdoc-commands-documentcontents.html#quotation}{\\quotation}
\o \l {07-0-qdoc-commands-quoting.html#quotefile}{\\quotefile}
\o \l {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile}
- \o \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)}
\o \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant}
\o \l {18-qdoc-commands-relating.html#reimp}{\\reimp}
\o \l {18-qdoc-commands-relating.html#relates}{\\relates}
@@ -8749,6 +8979,7 @@
\o \l {07-0-qdoc-commands-quoting.html#skipto}{\\skipto}
\o \l {07-0-qdoc-commands-quoting.html#skipuntil}{\\skipuntil}
\o \l {07-0-qdoc-commands-quoting.html#snippet}{\\snippet},
+ \o \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)}
\o \l {15-qdoc-commands-navigation.html#startpage}{\\startpage}
\o \l {04-qdoc-commands-textformatting.html#sub}{\\sub}
\o \l {20-qdoc-commands-title.html#subtitle}{\\subtitle}
--
cgit v0.12
From 71a35851a6206956846b52c264ca1e8f97e180a5 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 28 Jan 2011 10:19:07 +0100
Subject: qdoc: Updated the qdoc manual.
Modified the description of the \raw command.
IKt is to be avoided, so I showed how to do
the example of \raw ... \endraw using the
qdoc commands \tt and \span.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 42 ++++++++++++++++++++++++++++------------
1 file changed, 30 insertions(+), 12 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 3036af8..0c303c1 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4584,15 +4584,16 @@
\raw HTML
<style type="text/css" id="colorstyles">
- #blue { background-color: #0000ff; color: #ffffff }
- #darkBlue { background-color: #000080; color: #ffffff }
- #cyan { background-color: #00ffff; color: #000000 }
+ #color-blue { background-color: #0000ff; color: #ffffff }
+ #color-darkBlue { background-color: #000080; color: #ffffff }
+ #color-cyan { background-color: #00ffff; color: #000000 }
</style>
<p>
- <tt id="blue">Blue(#0000ff)</tt>,
- <tt id="darkBlue">dark blue(#000080)</tt> and
- <tt id="cyan">cyan(#00ffff)</tt>.
+ <tt id="color-blue">Blue(#0000ff)</tt>,
+ <tt id="color-darkBlue">dark blue(#000080)</tt> and
+ <tt id="color-cyan">cyan(#00ffff)</tt>.
+ </p>
\endraw
* /
\endcode
@@ -4604,18 +4605,35 @@
\raw HTML
<style type="text/css" id="colorstyles">
- #blue { background-color: #0000ff; color: #ffffff }
- #darkBlue { background-color: #000080; color: #ffffff }
- #cyan { background-color: #00ffff; color: #000000 }
+ #color-blue { background-color: #0000ff; color: #ffffff }
+ #color-darkBlue { background-color: #000080; color: #ffffff }
+ #color-cyan { background-color: #00ffff; color: #000000 }
</style>
<p>
- <tt id="blue">Blue(#0000ff)</tt>,
- <tt id="darkBlue">dark blue(#000080)</tt> and
- <tt id="cyan">cyan(#00ffff)</tt>.
+ <tt id="color-blue">Blue(#0000ff)</tt>,
+ <tt id="color-darkBlue">dark blue(#000080)</tt> and
+ <tt id="color-cyan">cyan(#00ffff)</tt>.
+ </p>
\endraw
\endquotation
+ \note But you can achieve the exact same thing using qdoc
+ commands. In this case, all you have to do is include the
+ color styles in your style.css file. Then you can write:
+
+ \code
+ \tt {\span {id="color-blue"}{Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+ \endcode
+
+ ...which is rendered again as:
+
+ \tt {\span {id="color-blue"}{Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+
\row
\o \bold \\unicode \target unicode
\o \bold {The \\unicode command allows you to insert an
--
cgit v0.12
From a7eaf9da32c788979c139a43c1076bf41107506e Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 28 Jan 2011 14:18:27 +0100
Subject: qdoc: Updated the qdoc manual and its qdocconf file.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 80 ++++++------
tools/qdoc3/doc/qdoc-manual.qdocconf | 242 ++++++++---------------------------
2 files changed, 95 insertions(+), 227 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 0c303c1..9939cce 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -27,12 +27,12 @@
/*!
\page index.html
- \nextpage QDoc Manual
+ \nextpage Introduction
- \title QDoc Manual - Table of Contents
+ \title Table of Contents
\list
- \o \l{QDoc Manual}
+ \o \l{Introduction}
\o \l{QDoc Commands}
\list
\o \l{Markup Commands}
@@ -79,11 +79,11 @@
/*!
\page 01-qdoc-manual.html
- \contentspage QDoc Manual - Table of Contents
- \previouspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
+ \previouspage Table of Contents
\nextpage QDoc Commands
- \title QDoc Manual
+ \title Introduction
QDoc is the internal tool used by Qt Development Frameworks for generating
documentation. This document is a reference for QDoc command syntax and
@@ -165,8 +165,8 @@
/*!
\page 02-qdoc-commands.html
- \previouspage QDoc Manual
- \contentspage QDoc Manual - Table of Contents
+ \previouspage Introduction
+ \contentspage Table of Contents
\nextpage Markup Commands
\title QDoc Commands
@@ -196,7 +196,7 @@
/*!
\page 03-qdoc-commands-markup.html
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\previouspage QDoc Commands
\nextpage Text Formatting Commands
@@ -287,7 +287,7 @@
/*!
\page 04-qdoc-commands-textformatting.html
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\previouspage Markup Commands
\nextpage Document Structuring Commands
@@ -928,7 +928,7 @@
/*!
\page 05-qdoc-commands-documentstructuring.html
\previouspage Text Formatting Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Verbatim Code Commands
\title Document Structuring Commands
@@ -1211,7 +1211,7 @@
/*!
\page 06-qdoc-commands-verbatimcode.html
\previouspage Document Structuring Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Quoting External Code Commands
\title Verbatim Code Commands
@@ -1425,7 +1425,7 @@
/*!
\page 07-0-qdoc-commands-quoting.html
\previouspage Verbatim Code Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Linking Commands
\title Quoting External Code Commands
@@ -2097,7 +2097,7 @@
/*!
\page 07-1-example.html
\previouspage Quoting External Code Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title Example File
@@ -2107,7 +2107,7 @@
/*!
\page 08-qdoc-commands-linking.html
\previouspage Quoting External Code Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Graphic Commands
\title Linking Commands
@@ -2404,7 +2404,7 @@
/*!
\page 09-qdoc-commands-graphic.html
\previouspage Linking Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Container Commands
\title Graphic Commands
@@ -2606,7 +2606,7 @@
/*!
\page 10-qdoc-commands-container.html
\previouspage Graphic Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Document Contents Commands
\title Container Commands
@@ -3146,7 +3146,7 @@
/*!
\page 11-qdoc-commands-documentcontents.html
\previouspage Container Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Miscellaneous Commands
\title Document Contents Commands
@@ -3816,7 +3816,7 @@
/*!
\page 12-0-qdoc-commands-miscellaneous.html
\previouspage Document Contents Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Topical Commands
\title Miscellaneous Commands
@@ -4667,7 +4667,7 @@
/*!
\page 12-1-signalandslots.html
\previouspage Miscellaneous Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title signalandslots.qdocinc
@@ -4677,7 +4677,7 @@
/*!
\page 12-2-objectmodel.html
\previouspage Miscellaneous Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title objectmodel.qdocinc
@@ -4687,7 +4687,7 @@
/*!
\page 12-3-layoutmanagement.html
\previouspage Miscellaneous Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title layoutmanagement.qdocinc
@@ -4697,7 +4697,7 @@
/*!
\page 13-qdoc-commands-topical.html
\previouspage Miscellaneous Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Contextual Commands
\title Topical Commands
@@ -6035,7 +6035,7 @@
/*!
\page 14-qdoc-commands-contextualcommands.html
\previouspage Topical Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Navigation Commands
\title Contextual Commands
@@ -6082,7 +6082,7 @@
/*!
\page 15-qdoc-commands-navigation.html
\previouspage Contextual Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Status Commands
\title Navigation Commands
@@ -6315,7 +6315,7 @@
/*!
\page 16-qdoc-commands-status.html
\previouspage Navigation Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Thread Support Commands
\title Status Commands
@@ -6622,7 +6622,7 @@
/*!
\page 17-qdoc-commands-thread.html
\previouspage Status Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Relating Commands
\title Thread Support Commands
@@ -6819,7 +6819,7 @@
/*!
\page 18-qdoc-commands-relating.html
\previouspage Thread Support Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Grouping Commands
\title Relating Commands
@@ -6978,7 +6978,7 @@
/*!
\page 19-qdoc-commands-grouping.html
\previouspage Relating Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Title Commands
\title Grouping Commands
@@ -7104,7 +7104,7 @@
/*!
\page 20-qdoc-commands-title.html
\previouspage Grouping Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage QDoc Configuration
\title Title Commands
@@ -7208,7 +7208,7 @@
/*!
\page 21-0-qdoc-configuration.html
\previouspage Title Commands
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage General Configuration Variables
\title QDoc Configuration
@@ -7345,7 +7345,7 @@
/*!
\page 21-1-minimum-qdocconf.html
\previouspage QDoc Configuration
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title minimum.qdocconf
@@ -7355,7 +7355,7 @@
/*!
\page 21-2-qt-qdocconf.html
\previouspage QDoc Configuration
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title qt.qdocconf
@@ -7365,7 +7365,7 @@
/*!
\page 22-qdoc-configuration-generalvariables.html
\previouspage QDoc Configuration
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Creating Help Project Files
\title General Configuration Variables
@@ -8279,7 +8279,7 @@
/*!
\page 22-creating-help-project-files.html
\previouspage General Configuration Variables
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage C++ Specific Configuration Variables
\title Creating Help Project Files
@@ -8348,7 +8348,7 @@
/*!
\page 23-qdoc-configuration-cppvariables.html
\previouspage Creating Help Project Files
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage HTML Specific Configuration Variables
\title C++ Specific Configuration Variables
@@ -8486,7 +8486,7 @@
/*!
\page 24-qdoc-configuration-htmlvariables.html
\previouspage C++ Specific Configuration Variables
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage Supporting Derived Projects
\title HTML Specific Configuration Variables
@@ -8616,7 +8616,7 @@
/*!
\page 25-qdoc-configuration-derivedprojects.html
\previouspage HTML Specific Configuration Variables
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage QDoc Compatibility
\title Supporting Derived Projects
@@ -8778,7 +8778,7 @@
/*!
\page 26-qdoc-commands-compatibility.html
\previouspage Supporting Derived Projects
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\nextpage QDoc Commands - Alphabetical List
\title QDoc Compatibility
@@ -8910,7 +8910,7 @@
/*!
\page 27-qdoc-commmands-alphabetical.html
\previouspage QDoc Compatibility
- \contentspage QDoc Manual - Table of Contents
+ \contentspage Table of Contents
\title QDoc Commands - Alphabetical List
diff --git a/tools/qdoc3/doc/qdoc-manual.qdocconf b/tools/qdoc3/doc/qdoc-manual.qdocconf
index 1e7ff01..84ee2ba 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdocconf
+++ b/tools/qdoc3/doc/qdoc-manual.qdocconf
@@ -1,3 +1,6 @@
+include(../test/qt-html-default-styles.qdocconf)
+include(../test/macros.qdocconf)
+
project = QDoc
description = QDoc3 Manual
@@ -13,7 +16,15 @@ exampledirs += $PWD \
imagedirs += images
-extraimages.HTML = qt-logo
+extraimages.HTML = qt-logo.png \
+ arrow_down.png \
+ breadcrumb.png \
+ bullet_gt.png \
+ bullet_dn.png \
+ bullet_sq.png \
+ bullet_up.png \
+ horBar.png \
+ sprites-combined.png
HTML.stylesheets = style/style.css \
style/OfflineStyle.css \
@@ -21,186 +32,56 @@ HTML.stylesheets = style/style.css \
style/style_ie8.css \
style/style_ie6.css
-HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
- " <div class=\"content\"> \n" \
+HTML.postheader = "<div class=\"header\" id=\"qtdocheader\">\n" \
+ " <div class=\"content\"> \n" \
" <div id=\"nav-logo\">\n" \
- " <a href=\"index.html\">Home</a></div>\n" \
- " <a href=\"index.html\" class=\"qtref\"><span>Qt Reference Documentation</span></a>\n" \
- " <div id=\"narrowsearch\"></div>\n" \
- " <div id=\"nav-topright\">\n" \
- " <ul>\n" \
- " <li class=\"nav-topright-home\"><a href=\"http://qt.nokia.com/\">Qt HOME</a></li>\n" \
- " <li class=\"nav-topright-dev\"><a href=\"http://developer.qt.nokia.com/\">DEV</a></li>\n" \
- " <li class=\"nav-topright-labs\"><a href=\"http://labs.qt.nokia.com/blogs/\">LABS</a></li>\n" \
- " <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://doc.qt.nokia.com/\">\n" \
- " DOC</a></li>\n" \
- " <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.nokia.com/\">BLOG</a></li>\n" \
- " </ul>\n" \
- " </div>\n" \
- " <div id=\"shortCut\">\n" \
+ " <a href=\"index.html\">Home</a>\n" \
+ " </div>\n" \
+ " <a href=\"index.html\" class=\"qtref\"><span>QDoc User Manual</span></a>\n" \
+ " </div>\n" \
+ "</div>\n" \
+ "<div class=\"wrap\">\n" \
+ " <div class=\"toolbar\">\n" \
+ " <div class=\"breadcrumb toolblock\">\n" \
" <ul>\n" \
- " <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt 4.7</a></span></li>\n" \
- " <li class=\"shortCut-topleft-active\"><a href=\"http://doc.qt.nokia.com\">ALL VERSIONS" \
- " </a></li>\n" \
- " </ul>\n" \
- " </div>\n" \
- " <ul class=\"sf-menu\" id=\"narrowmenu\"> \n" \
- " <li><a href=\"#\">API Lookup</a> \n" \
- " <ul> \n" \
- " <li><a href=\"classes.html\">Class index</a></li> \n" \
- " <li><a href=\"functions.html\">Function index</a></li> \n" \
- " <li><a href=\"modules.html\">Modules</a></li> \n" \
- " <li><a href=\"namespaces.html\">Namespaces</a></li> \n" \
- " <li><a href=\"qtglobal.html\">Global Declarations</a></li> \n" \
- " <li><a href=\"qdeclarativeelements.html\">QML elements</a></li> \n" \
- " </ul> \n" \
- " </li> \n" \
- " <li><a href=\"#\">Qt Topics</a> \n" \
- " <ul> \n" \
- " <li><a href=\"qt-basic-concepts.html\">Programming with Qt</a></li> \n" \
- " <li><a href=\"qtquick.html\">Device UIs & Qt Quick</a></li> \n" \
- " <li><a href=\"qt-gui-concepts.html\">UI Design with Qt</a></li> \n" \
- " <li><a href=\"developing-with-qt.html\">Cross-platform and Platform-specific</a></li> \n" \
- " <li><a href=\"platform-specific.html\">Platform-specific info</a></li> \n" \
- " <li><a href=\"technology-apis.html\">Qt and Key Technologies</a></li> \n" \
- " <li><a href=\"best-practices.html\">How-To's and Best Practices</a></li> \n" \
- " </ul> \n" \
- " </li> \n" \
- " <li><a href=\"#\">Examples</a> \n" \
- " <ul> \n" \
- " <li><a href=\"all-examples.html\">Examples</a></li> \n" \
- " <li><a href=\"tutorials.html\">Tutorials</a></li> \n" \
- " <li><a href=\"demos.html\">Demos</a></li> \n" \
- " <li><a href=\"qdeclarativeexamples.html\">QML Examples</a></li> \n" \
- " </ul> \n" \
- " </li> \n" \
- " </ul> \n" \
+ " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
+ " <!-- Bread crumbs goes here -->\n"
+
+HTML.postpostheader = " </ul>\n" \
" </div>\n" \
" </div>\n" \
- " <div class=\"wrapper\">\n" \
- " <div class=\"hd\">\n" \
- " <span></span>\n" \
- " </div>\n" \
- " <div class=\"bd group\">\n" \
- " <div class=\"sidebar\">\n" \
- " <div class=\"searchlabel\">\n" \
- " Search index:</div>\n" \
- " <div class=\"search\" id=\"sidebarsearch\">\n" \
- " <form id=\"qtdocsearch\" action=\"\" onsubmit=\"return false;\">\n" \
- " <fieldset>\n" \
- " <input type=\"text\" name=\"searchstring\" id=\"pageType\" value=\"\" />\n" \
- " <div id=\"resultdialog\"> \n" \
- " <a href=\"#\" id=\"resultclose\">Close</a> \n" \
- " <p id=\"resultlinks\" class=\"all\"><a href=\"#\" id=\"showallresults\">All</a> | <a href=\"#\" id=\"showapiresults\">API</a> | <a href=\"#\" id=\"showarticleresults\">Articles</a> | <a href=\"#\" id=\"showexampleresults\">Examples</a></p> \n" \
- " <p id=\"searchcount\" class=\"all\"><span id=\"resultcount\"></span><span id=\"apicount\"></span><span id=\"articlecount\"></span><span id=\"examplecount\"></span> results:</p> \n" \
- " <ul id=\"resultlist\" class=\"all\"> \n" \
- " </ul> \n" \
- " </div> \n" \
- " </fieldset>\n" \
- " </form>\n" \
- " </div>\n" \
- " <div class=\"box first bottombar\" id=\"lookup\">\n" \
- " <h2 title=\"API Lookup\"><span></span>\n" \
- " API Lookup</h2>\n" \
- " <div id=\"list001\" class=\"list\">\n" \
- " <ul id=\"ul001\" >\n" \
- " <li class=\"defaultLink\"><a href=\"classes.html\">Class index</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"functions.html\">Function index</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"modules.html\">Modules</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"namespaces.html\">Namespaces</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qtglobal.html\">Global Declarations</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qdeclarativeelements.html\">QML elements</a></li>\n" \
- " </ul> \n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"box bottombar\" id=\"topics\">\n" \
- " <h2 title=\"Qt Topics\"><span></span>\n" \
- " Qt Topics</h2>\n" \
- " <div id=\"list002\" class=\"list\">\n" \
- " <ul id=\"ul002\" >\n" \
- " <li class=\"defaultLink\"><a href=\"qt-basic-concepts.html\">Programming with Qt</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"qtquick.html\">Device UIs & Qt Quick</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"qt-gui-concepts.html\">UI Design with Qt</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"developing-with-qt.html\">Cross-platform and Platform-specific</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"platform-specific.html\">Platform-specific info</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"technology-apis.html\">Qt and Key Technologies</a></li> \n" \
- " <li class=\"defaultLink\"><a href=\"best-practices.html\">How-To's and Best Practices</a></li> \n" \
- " </ul> \n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"box\" id=\"examples\">\n" \
- " <h2 title=\"Examples\"><span></span>\n" \
- " Examples</h2>\n" \
- " <div id=\"list003\" class=\"list\">\n" \
- " <ul id=\"ul003\">\n" \
- " <li class=\"defaultLink\"><a href=\"all-examples.html\">Examples</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"tutorials.html\">Tutorials</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"demos.html\">Demos</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qdeclarativeexamples.html\">QML Examples</a></li>\n" \
- " </ul> \n" \
- " </div>\n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"wrap\">\n" \
- " <div class=\"toolbar\">\n" \
- " <div class=\"breadcrumb toolblock\">\n" \
- " <ul>\n" \
- " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
- " <!-- Bread crumbs goes here -->\n"
-
-HTML.postpostheader = " </ul>\n" \
- " </div>\n" \
- " <div class=\"toolbuttons toolblock\">\n" \
- " <ul>\n" \
- " <li id=\"smallA\" class=\"t_button\">A</li>\n" \
- " <li id=\"medA\" class=\"t_button active\">A</li>\n" \
- " <li id=\"bigA\" class=\"t_button\">A</li>\n" \
- " <li id=\"print\" class=\"t_button\"><a href=\"javascript:this.print();\">\n" \
- " <span>Print</span></a></li>\n" \
- " </ul>\n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"content mainContent\">\n"
+ " <div class=\"content mainContent\">\n"
HTML.footer = "" \
- " <div class=\"feedback t_button\">\n" \
- " [+] Documentation Feedback</div>\n" \
- " </div>\n" \
- " </div>\n" \
- " </div> \n" \
- " <div class=\"ft\">\n" \
- " <span></span>\n" \
- " </div>\n" \
- " </div> \n" \
- " <div class=\"footer\">\n" \
- " <p>\n" \
- " <acronym title=\"Copyright\">©</acronym> 2008-2010 Nokia Corporation and/or its\n" \
- " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
- " in Finland and/or other countries worldwide.</p>\n" \
- " <p>\n" \
- " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
- " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a></p>\n" \
- " <br />\n" \
- " <p>\n" \
- " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
- " Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
- " with the terms contained in a written agreement between you and Nokia.</p>\n" \
- " <p>\n" \
- " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
- " Free Documentation License version 1.3</a>\n" \
- " as published by the Free Software Foundation.</p>\n" \
" </div>\n" \
- " <div id=\"feedbackBox\">\n" \
- " <div id=\"feedcloseX\" class=\"feedclose t_button\">X</div>\n" \
- " <form id=\"feedform\" action=\"http://doc.qt.nokia.com/docFeedbck/feedback.php\" method=\"get\">\n" \
- " <p id=\"noteHead\">Thank you for giving your feedback.</p> <p class=\"note\">Make sure it is related to this specific page. For more general bugs and \n" \
- " requests, please use the <a href=\"http://bugreports.qt.nokia.com/secure/Dashboard.jspa\">Qt Bug Tracker</a>.</p>\n" \
- " <p><textarea id=\"feedbox\" name=\"feedText\" rows=\"5\" cols=\"40\"></textarea></p>\n" \
- " <p><input id=\"feedsubmit\" class=\"feedclose\" type=\"submit\" name=\"feedback\" /></p>\n" \
- " </form>\n" \
- " </div>\n" \
- " <div id=\"blurpage\">\n" \
- " </div>\n"
+ "</div>\n" \
+ "<div class=\"ft\">\n" \
+ " <span></span>\n" \
+ "</div>\n" \
+ "<div class=\"footer\">\n" \
+ " <p>\n" \
+ " <acronym title=\"Copyright\">©</acronym> 2008-2010 Nokia Corporation and/or its\n" \
+ " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
+ " in Finland and/or other countries worldwide.\n" \
+ " </p>\n" \
+ " <p>\n" \
+ " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
+ " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a>\n" \
+ " </p>\n" \
+ " <br />\n" \
+ " <p>\n" \
+ " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
+ " Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
+ " with the terms contained in a written agreement between you and Nokia.\n" \
+ " </p>\n" \
+ " <p>\n" \
+ " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
+ " Free Documentation License version 1.3</a>\n" \
+ " as published by the Free Software Foundation.\n" \
+ " </p>\n" \
+ "</div>\n" \
+ "<div id=\"blurpage\">\n" \
+ "</div>\n"
# This stuff is used by the Qt 4.7 doc format.
scriptdirs = ../../../doc/src/template/scripts
@@ -219,16 +100,3 @@ styles.HTML = style.css \
style_ie7.css \
style_ie8.css
-# Files not referenced in any qdoc file (last four are needed by qtdemo)
-# See also extraimages.HTML
-qhp.Qt.extraFiles = scripts/functions.js \
- scripts/jquery.js \
- scripts/narrow.js \
- scripts/superfish.js \
- style/narrow.css \
- style/superfish.css \
- style/style_ie6.css \
- style/style_ie7.css \
- style/style_ie8.css \
- style/style.css
-
--
cgit v0.12
From 4a6304e814d27e0c6588a0d6979bb1faa1603b4d Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 31 Jan 2011 14:10:59 +0100
Subject: qdoc: Fixed numerous broken links in the qdoc manual.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 1480 +++++++++++++++++++-------------------
1 file changed, 740 insertions(+), 740 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 9939cce..51ada06 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -94,7 +94,7 @@
\list I
\o \section2 \l {QDoc Commands}
- \l {QDoc Commands - Alphabetical List}{A complete alphabetical
+ \l {QDoc Commands - Alphabetical List} {A complete alphabetical
list}.
There are two main categories of commands for QDoc: markup
@@ -109,25 +109,25 @@
\list
\o \l {Markup Commands}
\list
- \o \l {Text Formatting Commands}{Text Formatting} \span {class="newStuff"} {(new commands)}
- \o \l {Document Structuring Commands}{Document Structuring}
- \o \l {Verbatim Code Commands}{Verbatim Code}
- \o \l {Quoting External Code Commands}{Quoting External Code}
- \o \l {Linking Commands}{Linking}
- \o \l {Graphic Commands}{Graphic}
- \o \l {Container Commands}{Container}
- \o \l {Document Contents Commands}{Document Contents}
- \o \l {Miscellaneous Commands}{Miscellaneous}
+ \o \l {Text Formatting Commands} {Text Formatting} \span {class="newStuff"} {(new commands)}
+ \o \l {Document Structuring Commands} {Document Structuring}
+ \o \l {Verbatim Code Commands} {Verbatim Code}
+ \o \l {Quoting External Code Commands} {Quoting External Code}
+ \o \l {Linking Commands} {Linking}
+ \o \l {Graphic Commands} {Graphic}
+ \o \l {Container Commands} {Container}
+ \o \l {Document Contents Commands} {Document Contents}
+ \o \l {Miscellaneous Commands} {Miscellaneous}
\endlist
\o \l {Topical Commands}
\o \l {Contextual Commands}
\list
- \o \l {Navigation Commands}{Navigation}
- \o \l {Status Commands}{Status}
- \o \l {Thread Support Commands}{Thread Support}
- \o \l {Relating Commands}{Relating}
- \o \l {Grouping Commands}{Grouping}
- \o \l {Title Commands}{Title}
+ \o \l {Navigation Commands} {Navigation}
+ \o \l {Status Commands} {Status}
+ \o \l {Thread Support Commands} {Thread Support}
+ \o \l {Relating Commands} {Relating}
+ \o \l {Grouping Commands} {Grouping}
+ \o \l {Title Commands} {Title}
\endlist
\endlist
\endlist
@@ -207,68 +207,68 @@
\section1 Alphabetical List
- \l {04-qdoc-commands-textformatting.html#backslash}{\\\\},
- \l {04-qdoc-commands-textformatting.html#a}{\\a},
- \l {11-qdoc-commands-documentcontents.html#abstract}{\\abstract},
- \l {06-qdoc-commands-verbatimcode.html#badcode}{\\badcode},
- \l {04-qdoc-commands-textformatting.html#bold}{\\bold},
- \l {11-qdoc-commands-documentcontents.html#brief}{\\brief},
- \l {04-qdoc-commands-textformatting.html#c}{\\c},
- \l {09-qdoc-commands-graphic.html#caption}{\\caption},
- \l {05-qdoc-commands-documentstructuring.html#chapter}{\\chapter},
- \l {06-qdoc-commands-verbatimcode.html#code}{\\code},
- \l {07-0-qdoc-commands-quoting.html#codeline}{\\codeline},
- \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)},
- \l {07-0-qdoc-commands-quoting.html#dots}{\\dots},
- \l {12-0-qdoc-commands-miscellaneous.html#else}{\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif}{\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire}{\\expire},
- \l {11-qdoc-commands-documentcontents.html#footnote}{\\footnote},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist}{\\generatelist},
- \l {10-qdoc-commands-container.html#header}{\\header},
- \l {04-qdoc-commands-textformatting.html#i}{\\i},
- \l {12-0-qdoc-commands-miscellaneous.html#if}{\\if},
- \l {09-qdoc-commands-graphic.html#image}{\\image},
- \l {12-0-qdoc-commands-miscellaneous.html#include}{\\include},
- \l {09-qdoc-commands-graphic.html#inlineimage}{\\inlineimage},
- \l {08-qdoc-commands-linking.html#keyword}{\\keyword},
- \l {08-qdoc-commands-linking.html#l}{\\l},
- \l {11-qdoc-commands-documentcontents.html#legalese}{\\legalese},
- \l {10-qdoc-commands-container.html#list}{\\list},
- \l {12-0-qdoc-commands-miscellaneous.html#meta}{\\meta},
- \l {06-qdoc-commands-verbatimcode.html#newcode}{\\newcode},
- \l {10-qdoc-commands-container.html#o}{\\o},
- \l {06-qdoc-commands-verbatimcode.html#oldcode}{\\oldcode},
- \l {12-0-qdoc-commands-miscellaneous.html#omit}{\\omit},
- \l {05-qdoc-commands-documentstructuring.html#part}{\\part},
- \l {07-0-qdoc-commands-quoting.html#printline}{\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto}{\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil}{\\printuntil},
- \l {11-qdoc-commands-documentcontents.html#quotation}{\\quotation},
- \l {07-0-qdoc-commands-quoting.html#quotefile}{\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)},
- \l {10-qdoc-commands-container.html#row}{\\row},
- \l {08-qdoc-commands-linking.html#sa}{\\sa},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne}{\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo}{\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree}{\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour}{\\section4},
- \l {07-0-qdoc-commands-quoting.html#skipline}{\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto}{\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil}{\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet}{\\snippet},
- \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub}{\\sub},
- \l {04-qdoc-commands-textformatting.html#sup}{\\sup},
- \l {10-qdoc-commands-container.html#table}{\\table},
+ \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
+ \l {04-qdoc-commands-textformatting.html#a} {\\a},
+ \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
+ \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
+ \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
+ \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
+ \l {04-qdoc-commands-textformatting.html#c} {\\c},
+ \l {09-qdoc-commands-graphic.html#caption} {\\caption},
+ \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
+ \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
+ \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
+ \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
+ \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
+ \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
+ \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
+ \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
+ \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
+ \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
+ \l {10-qdoc-commands-container.html#header} {\\header},
+ \l {04-qdoc-commands-textformatting.html#i} {\\i},
+ \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
+ \l {09-qdoc-commands-graphic.html#image} {\\image},
+ \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
+ \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage},
+ \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
+ \l {08-qdoc-commands-linking.html#l} {\\l},
+ \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
+ \l {10-qdoc-commands-container.html#list} {\\list},
+ \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
+ \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
+ \l {10-qdoc-commands-container.html#o} {\\o},
+ \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode},
+ \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
+ \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
+ \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
+ \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
+ \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
+ \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
+ \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
+ \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
+ \l {10-qdoc-commands-container.html#row} {\\row},
+ \l {08-qdoc-commands-linking.html#sa} {\\sa},
+ \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
+ \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
+ \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
+ \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4},
+ \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
+ \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
+ \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
+ \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
+ \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
+ \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
+ \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
+ \l {10-qdoc-commands-container.html#table} {\\table},
\l {11-qdoc-commands-documentcontents.html#tableofcontents}
{\\tableofcontents},
- \l {08-qdoc-commands-linking.html#target}{\\target},
- \l {04-qdoc-commands-textformatting.html#tt}{\\tt},
- \l {04-qdoc-commands-textformatting.html#underline}{\\underline},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\unicode},
- \l {11-qdoc-commands-documentcontents.html#warning}{\\warning}
+ \l {08-qdoc-commands-linking.html#target} {\\target},
+ \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
+ \l {04-qdoc-commands-textformatting.html#underline} {\\underline},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode},
+ \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
\section1 Categories
\list
@@ -298,17 +298,17 @@
\section1 Alphabetical List
- \l {04-qdoc-commands-textformatting.html#backslash}{\\\\},
- \l {04-qdoc-commands-textformatting.html#a}{\\a},
- \l {04-qdoc-commands-textformatting.html#bold}{\\bold},
- \l {04-qdoc-commands-textformatting.html#c}{\\c},
- \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#i}{\\i},
- \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub}{\\sub},
- \l {04-qdoc-commands-textformatting.html#sup}{\\sup},
- \l {04-qdoc-commands-textformatting.html#tt}{\\tt},
- \l {04-qdoc-commands-textformatting.html#underline}{\\underline}
+ \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
+ \l {04-qdoc-commands-textformatting.html#a} {\\a},
+ \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
+ \l {04-qdoc-commands-textformatting.html#c} {\\c},
+ \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
+ \l {04-qdoc-commands-textformatting.html#i} {\\i},
+ \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
+ \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
+ \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
+ \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
+ \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
\section1 Command Descriptions
@@ -344,7 +344,7 @@
\endquotation
However, if you want your text to appear in a typewriter
- font as well, you can use the \l {c}{\\c} command instead,
+ font as well, you can use the \l {c} {\\c} command instead,
which accepts and renders the backslash as any other
character. For example:
@@ -409,7 +409,7 @@
\endquotation
The \\a command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation, parentheses
+ {i} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument. However, a parameter
is always a single word, so braces are rarely
necessary. And for the same reason, parentheses seldom
@@ -441,15 +441,15 @@
\endquotation
The \\c command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation, parentheses
+ {i} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
The \\c command accepts the special character \c \ within
its argument, i.e. it renders it as a normal character. So
if you want to use nested commands, you must use the \l
- {tt}{teletype (\\tt)} command instead.
+ {tt} {teletype (\\tt)} command instead.
- See also \l {tt}{\\tt} and \l {code}{\\code}.
+ See also \l {tt} {\\tt} and \l {code-command} {\\code}.
\row
\o \bold \\div \span {class="newStuff"} {(new)} \target div
@@ -530,12 +530,12 @@
\enddiv
\div {class="section sectionlist"}
\list
- \o \l{Getting Started Guides}{Getting started}
- \o \l{Installation}{Installation}
- \o \l{how-to-learn-qt.html}{How to learn Qt}
- \o \l{tutorials.html}{Tutorials}
- \o \l{Qt Examples}{Examples}
- \o \l{qt4-7-intro.html}{What's new in Qt 4.7}
+ \o \l{Getting Started Guides} {Getting started}
+ \o \l{Installation} {Installation}
+ \o \l{how-to-learn-qt.html} {How to learn Qt}
+ \o \l{tutorials.html} {Tutorials}
+ \o \l{Qt Examples} {Examples}
+ \o \l{qt4-7-intro.html} {What's new in Qt 4.7}
\endlist
\enddiv
\enddiv
@@ -562,12 +562,12 @@
\enddiv
\div {class="section sectionlist"}
\list
- \o \l{Getting Started Guides}{Getting started}
- \o \l{Installation}{Installation}
- \o \l{how-to-learn-qt.html}{How to learn Qt}
- \o \l{tutorials.html}{Tutorials}
- \o \l{Qt Examples}{Examples}
- \o \l{qt4-7-intro.html}{What's new in Qt 4.7}
+ \o \l{Getting Started Guides} {Getting started}
+ \o \l{Installation} {Installation}
+ \o \l{how-to-learn-qt.html} {How to learn Qt}
+ \o \l{tutorials.html} {Tutorials}
+ \o \l{Qt Examples} {Examples}
+ \o \l{qt4-7-intro.html} {What's new in Qt 4.7}
\endlist
\enddiv
\enddiv
@@ -620,7 +620,7 @@
Your DITA XML publishing program must recognize the values
of the \e outputclass attribute.
- See also \l {span}{\\span}.
+ See also \l {span} {\\span}.
\row
\o \bold \\span \span {class="newStuff"} {(new)} \target span
@@ -672,7 +672,7 @@
\note The \bold span command does not cause a new paragraph to
be started.
- See also \l {div}{\\div}.
+ See also \l {div} {\\div}.
\row
\o \bold \\tt \target tt
@@ -680,9 +680,9 @@
user-defined classes and C++ keywords like \c int, \c
for, etc.}
- The \\tt command behaves just like the \l {c}{\\c} command,
- except that \\tt parses QDoc commands (like \l {i}{\\i}, \l
- {bold}{\\bold} and \l {underline}{\\underline}) contained
+ The \\tt command behaves just like the \l {c} {\\c} command,
+ except that \\tt parses QDoc commands (like \l {i} {\\i}, \l
+ {bold} {\\bold} and \l {underline} {\\underline}) contained
within its argument.
The command renders its argument using a monospace
@@ -707,10 +707,10 @@
\endquotation
The \\tt command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation, parentheses
+ {i} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- See also \l {c}{\\c}.
+ See also \l {c} {\\c}.
\row
\o \bold \\bold \target bold
@@ -733,8 +733,8 @@
the \\bold command}.
\endquotation
- The command follows the same conventions as the \l {i}{\\i}
- command for \l {argument}{punctuation, parentheses and use
+ The command follows the same conventions as the \l {i} {\\i}
+ command for \l {argument} {punctuation, parentheses and use
of braces} for the argument.
\row
@@ -743,7 +743,7 @@
\warning This is preliminary functionality. For
more information, see the \l
- {26-qdoc-commands-compatibility.html#i-versus-e}{compatibility}
+ {26-qdoc-commands-compatibility.html#i-versus-e} {compatibility}
section.
\target argument
@@ -864,7 +864,7 @@
\endquotation
The \\sub command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation, parentheses
+ {i} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
\row
@@ -895,7 +895,7 @@
\endquotation
The \\sup command follows the same conventions as the \l
- {i}{\\i} command for \l {argument}{punctuation, parentheses
+ {i} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
\row
@@ -921,7 +921,7 @@
\endquotation
The \\underline command follows the same conventions as the
- \l {i}{\\i} command for \l {argument}{punctuation,
+ \l {i} {\\i} command for \l {argument} {punctuation,
parentheses and use of braces} for the argument. \endtable
*/
@@ -942,12 +942,12 @@
\section1 Alphabetical List
- \l {05-qdoc-commands-documentstructuring.html#chapter}{\\chapter},
- \l {05-qdoc-commands-documentstructuring.html#part}{\\part},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne}{\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo}{\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree}{\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour}{\\section4}
+ \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
+ \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
+ \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
+ \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
+ \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
+ \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
\section1 Command Descriptions
@@ -1175,34 +1175,34 @@
\o \bold {The \\chapter command is intended for use in
larger documents, and divides the document into chapters.}
- See \l{part}{\\part} for an explanation of the various
+ See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
\row
\o \bold \\section1 \target sectionOne
\o \bold {The \\section1 command starts a new section.}
- See \l{part}{\\part} for an explanation of the various
+ See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
\row
\o \bold \\section2 \target sectionTwo
\o \bold {The \\section2 command starts a new section.}
- See \l{part}{\\part} for an explanation of the various
+ See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
\row
\o \bold \\section3 \target sectionThree
\o \bold {The \\section3 command starts a new section.}
- See \l{part}{\\part} for an explanation of the various
+ See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
\row
\o \bold \\section4 \target sectionFour
\o \bold {The \\section4 command starts a new section.}
- See \l{part}{\\part} for an explanation of the various
+ See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
\endtable
@@ -1221,8 +1221,8 @@
typewriter font and the standard indentation.
\bold{Note:} Although all of these commands can be used to present
- C++ code, the \l{07-0-qdoc-commands-quoting.html#snippet}{\\snippet}
- and \l{07-0-qdoc-commands-quoting.html#codeline}{\\codeline} commands
+ C++ code, the \l{07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
+ and \l{07-0-qdoc-commands-quoting.html#codeline} {\\codeline} commands
should be used in preference to
the others when presenting valid code. This allows auxilliary tools
for Qt language bindings to substitute the relevant code snippets in
@@ -1230,10 +1230,10 @@
\section1 Alphabetical List
- \l {06-qdoc-commands-verbatimcode.html#badcode}{\\badcode},
- \l {06-qdoc-commands-verbatimcode.html#code}{\\code},
- \l {06-qdoc-commands-verbatimcode.html#newcode}{\\newcode},
- \l {06-qdoc-commands-verbatimcode.html#oldcode}{\\oldcode}
+ \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
+ \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
+ \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
+ \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
\section1 Command Descriptions
@@ -1243,26 +1243,26 @@
\o Description
\row
- \o \bold \\code \target code
+ \o \bold \\code \target code-command
\o \bold {The \\code command and the corresponding
\\endcode command delimit a piece of verbatim code.}
- Whereas the \l {c}{\\c} command can be used for short code
+ Whereas the \l {c} {\\c} command can be used for short code
fragments within a sentence, the \\code command is for
longer code snippets and renders the code verbatim in a
separate paragraph using a typewriter font and the standard
indentation.
- When processing any of the \\code, \l {badcode}{\\badcode},
- \l {newcode}{\\newcode} and \l {oldcode}{\\oldcode}
+ When processing any of the \\code, \l {badcode} {\\badcode},
+ \l {newcode} {\\newcode} and \l {oldcode} {\\oldcode}
commands, QDoc basically removes all indentation that is
common for the verbatim code blocks within a \c{/}\c{*!} ...
\c{*}\c{/} comment before it adds the standard
indentation. For that reason the recommended style is to
use 8 spaces for the verbatim code contained within these
commands (note that this doesn't apply to externally
- quoted code using the \l {quotefromfile}{\\quotefromfile}
- or \l {quotefile}{\\quotefile} command).
+ quoted code using the \l {quotefromfile-command} {\\quotefromfile}
+ or \l {quotefile-command} {\\quotefile} command).
For example:
@@ -1299,13 +1299,13 @@
You need to type the code manually between the \\code and
\\endcode commands. If you want to include code snippets
from a particular file, use the \l
- {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile}
+ {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
command instead.
- See also \l {c}{\\c}, \l
- {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile},
- \l {badcode}{\\badcode}, \l {newcode}{\\newcode} and \l
- {oldcode}{\\oldcode}.
+ See also \l {c} {\\c}, \l
+ {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
+ \l {badcode} {\\badcode}, \l {newcode} {\\newcode} and \l
+ {oldcode} {\\oldcode}.
\row
\o \bold \\badcode \target badcode
@@ -1313,11 +1313,11 @@
\\endcode command delimit a piece of code that doesn't
compile or is wrong for some other reason.}
- The \\badcode command is similar the \l {code}{\\code}
+ The \\badcode command is similar the \l {code-command} {\\code}
command, but renders the code using a grey font instead of
black (the default).
- Like the \l {code}{\\code} command, it renders its code on
+ Like the \l {code-command} {\\code} command, it renders its code on
a new line in the documentation using a typewriter font and
the standard indentation. For example:
@@ -1361,8 +1361,8 @@
\\badcode... \\endcode, and the special character '\\' is
accepted and rendered like the rest of the code.
- See also \l {code}{\\code}, \l {newcode}{\\newcode} and \l
- {oldcode}{\\oldcode}.
+ See also \l {code-command} {\\code}, \l {newcode} {\\newcode} and \l
+ {oldcode} {\\oldcode}.
\row
\o \bold \\newcode \target newcode
@@ -1372,12 +1372,12 @@
The \\newcode command, and its companion the \\oldcode
command, is a convenience combination of the \l
- {code}{\\code} and \l {badcode}{\\badcode} commands: The
+ {code-command} {\\code} and \l {badcode} {\\badcode} commands: The
combination provides a text relating the two code snippets
to each other. The command requires a preceding \\oldcode
statement.
- Like the \l {code}{\\code} and \l {badcode}{\\badcode}
+ Like the \l {code-command} {\\code} and \l {badcode} {\\badcode}
commands, the \\newcode command renders its code on a new
line in the documentation using a typewriter font and the
standard indentation. For example:
@@ -1418,7 +1418,7 @@
\\newcode statement; otherwise QDoc fails to parse the command
and emits a warning.}
- See also \l {newcode}{\\newcode} and \l {badcode}{\\badcode}.
+ See also \l {newcode} {\\newcode} and \l {badcode} {\\badcode}.
\endtable
*/
@@ -1437,7 +1437,7 @@
chunk.
\bold{Note:} Although all of these commands can be used to present
- C++ code, the \l{#snippet}{\\snippet} and \l{#codeline}{\\codeline}
+ C++ code, the \l{#snippet} {\\snippet} and \l{#codeline} {\\codeline}
commands should be used in preference to
the others when presenting valid code. This allows auxilliary tools
for Qt language bindings to substitute the relevant code snippets in
@@ -1445,17 +1445,17 @@
\section1 Alphabetical List
- \l {07-0-qdoc-commands-quoting.html#codeline}{\\codeline},
- \l {07-0-qdoc-commands-quoting.html#dots}{\\dots},
- \l {07-0-qdoc-commands-quoting.html#printline}{\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto}{\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil}{\\printuntil},
- \l {07-0-qdoc-commands-quoting.html#quotefile}{\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile},
- \l {07-0-qdoc-commands-quoting.html#skipline}{\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto}{\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil}{\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet}{\\snippet}
+ \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
+ \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
+ \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
+ \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
+ \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
+ \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
+ \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
+ \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
+ \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
+ \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
+ \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
\section1 Command Descriptions
@@ -1465,7 +1465,7 @@
\o Description
\row
- \o \bold \\quotefile \target quotefile
+ \o \bold \\quotefile \target quotefile-command
\o \bold {The \\quotefile command expands to the complete
contents of the file given as argument.}
@@ -1502,14 +1502,14 @@
\endquotation
\warning If you use the \l {QDoc
- Compatibility}{compat.qdocconf} file this command is called
+ Compatibility} {compat.qdocconf} file this command is called
\\include.
- See also \l {quotefromfile}{\\quotefromfile} and \l
- {code}{\\code}.
+ See also \l {quotefromfile-command} {\\quotefromfile} and
+ \l {code-command} {\\code}.
\row
- \o \bold \\quotefromfile \target quotefromfile
+ \o \bold \\quotefromfile \target quotefromfile-command
\o \bold {The \\quotefromfile command opens the file
given as argument for quoting.}
@@ -1519,9 +1519,9 @@
The command is intended for use when quoting parts from
file with the walkthrough commands: \l
- {printline}{\\printline}, \l {printto}{\\printto}, \l
- {printuntil}{\\printuntil}, \l {skipline}{\\skipline}, \l
- {skipto}{\\skipto}, \l {skipuntil}{\\skipuntil}. This
+ {printline} {\\printline}, \l {printto} {\\printto}, \l
+ {printuntil} {\\printuntil}, \l {skipline} {\\skipline}, \l
+ {skipto} {\\skipto}, \l {skipuntil} {\\skipuntil}. This
enables you to quote specific portions of a file. For
example:
@@ -1571,10 +1571,10 @@
...
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
QDoc remembers which file it's quoting, and the current
- position within that file (see \l {file}{\\printline} for
+ position within that file (see \l {file} {\\printline} for
more information). There is no need to "close" the file.
Earlier we called this command \\quotefile. For more
@@ -1582,8 +1582,8 @@
{26-qdoc-commands-compatibility.html#quotefromfile-versus-quotefile}
{compatibility} section.
- See also \l {quotefile}{\\quotefile}, \l {code}{\\code} and
- \l {dots}{\\dots}.
+ See also \l {quotefile-command} {\\quotefile}, \l
+ {code-command} {\\code} and \l {dots} {\\dots}.
\row
\o \bold \\printline \target printline
@@ -1657,15 +1657,15 @@
The main function...
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
\target file
QDoc reads the file sequentially. To move the current
position forward you can use either of the \l
- {skipline}{\\skip...} commands. To move the current
+ {skipline} {\\skip...} commands. To move the current
position backward, you can use the \l
- {quotefromfile}{\\quotefromfile} command again.
+ {quotefromfile-command} {\\quotefromfile} command again.
\target substring
@@ -1704,7 +1704,7 @@
application.
\endquotation
- (\l {widgets/scribble}{The complete example file...})
+ (\l {widgets/scribble} {The complete example file...})
The regular expression \c /^\}/ makes QDoc print until the
first '}' character occurring at the beginning of the line
@@ -1717,8 +1717,8 @@
regular expression cannot be located, i.e. if the source
code has changed.
- See also \l {printto}{\\printto} and \l
- {printuntil}{\\printuntil}.
+ See also \l {printto} {\\printto} and \l
+ {printuntil} {\\printuntil}.
\row
\o \bold \\printto \target printto
@@ -1729,8 +1729,8 @@
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
- {file}{positioning} and \l {substring}{argument} as the \l
- {printline}{\\printline} command.
+ {file} {positioning} and \l {substring} {argument} as the \l
+ {printline} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1765,10 +1765,10 @@
and \c argv parameters...
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
- See also \l {printline}{\\printline} and \l
- {printuntil}{\\printuntil}.
+ See also \l {printline} {\\printline} and \l
+ {printuntil} {\\printuntil}.
\row
\o \bold \\printuntil \target printuntil
@@ -1779,8 +1779,8 @@
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
- {file}{positioning} and \l {substring}{argument} as the \l
- {printline}{\\printline} command.
+ {file} {positioning} and \l {substring} {argument} as the \l
+ {printline} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1814,16 +1814,16 @@
\printuntil hello
First we create a \l
- {http://qt.nokia.com/doc/4.0/qapplication}{QApplication}
+ {http://qt.nokia.com/doc/4.0/qapplication} {QApplication}
object using the \c argc and \c argv parameters, then we
create a \l
- {http://qt.nokia.com/doc/4.0/qpushbutton}{QPushButton}.
+ {http://qt.nokia.com/doc/4.0/qpushbutton} {QPushButton}.
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
- See also \l {printline}{\\printline} and \l
- {printto}{\\printto}.
+ See also \l {printline} {\\printline} and \l
+ {printto} {\\printto}.
\row
\o \bold \\skipline \target skipline
@@ -1832,15 +1832,15 @@
Doc reads the file sequentially, and the \\skipline command
is used to move the current position (omitting a line of
- the source file). See the remark about \l {file}{file
+ the source file). See the remark about \l {file} {file
positioning} above.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
- {substring}{argument} as the \l {printline}{\\printline}
+ {substring} {argument} as the \l {printline} {\\printline}
command, and it is used in conjunction with the \l
- {quotefromfile}{\\quotefromfile} command. For example:
+ {quotefromfile-command} {\\quotefromfile} command. For example:
\code
/ *!
@@ -1876,10 +1876,10 @@
that contains its definition.
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
- See also \l {skipto}{\\skipto}, \l
- {skipuntil}{\\skipuntil} and \l {dots}{\\dots}.
+ See also \l {skipto} {\\skipto}, \l
+ {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
\row
\o \bold \\skipto \target skipto
@@ -1890,16 +1890,16 @@
QDoc reads the file sequentially, and the \\skipto command
is used to move the current position (omitting one or
several lines of the source file). See the remark about \l
- {file}{file positioning} above.
+ {file} {file positioning} above.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break.
The command also follows the same conventions for \l
- {substring}{argument} as the \l {printline}{\\printline}
+ {substring} {argument} as the \l {printline} {\\printline}
command, and it is used in conjunction with the \l
- {quotefromfile}{\\quotefromfile} command. For example:
+ {quotefromfile-command} {\\quotefromfile} command. For example:
\code
/ *!
@@ -1934,10 +1934,10 @@
reasonable size ...
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
- See also \l {skipline}{\\skipline}, \l
- {skipuntil}{\\skipuntil} and \l {dots}{\\dots}.
+ See also \l {skipline} {\\skipline}, \l
+ {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
\row
\o \bold \\skipuntil \target skipuntil
@@ -1948,16 +1948,16 @@
QDoc reads the file sequentially, and the \\skipuntil
command is used to move the current position (omitting one
or several lines of the source file). See the remark about
- \l {file}{file positioning} above.
+ \l {file} {file positioning} above.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break.
The command also follows the same conventions for \l
- {substring}{argument} as the \l {printline}{\\printline}
+ {substring} {argument} as the \l {printline} {\\printline}
command, and it is used in conjunction with the \l
- {quotefromfile}{\\quotefromfile} command. For example:
+ {quotefromfile-command} {\\quotefromfile} command. For example:
\code
/ *!
@@ -1991,10 +1991,10 @@
will return when the application exits...
\endquotation
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
- See also \l {skipline}{\\skipline}, \l {skipto}{\\skipto}
- and \l {dots}{\\dots}.
+ See also \l {skipline} {\\skipline}, \l {skipto} {\\skipto}
+ and \l {dots} {\\dots}.
\row
\o \bold \\dots \target dots
@@ -2002,7 +2002,7 @@
source file have been omitted when quoting a file.}
The command is used in conjunction with the \l
- {quotefromfile}{\\quotefromfile} command, and should be
+ {quotefromfile-command} {\\quotefromfile} command, and should be
stated on its own line. The dots are rendered on a new
line, using a typewriter font. For example:
@@ -2026,7 +2026,7 @@
\skipuntil exec
\printline }
- (\l {Example File}{The complete example file...})
+ (\l {Example File} {The complete example file...})
The default indentation is 4 spaces, but this can be
adjusted using the command's optional argument. For
@@ -2050,8 +2050,8 @@
\dots 12
\dots 16
- See also \l {skipline}{\\skipline}, \l
- {skipto}{\\skipto} and \l {skipuntil}{\\skipuntil}.
+ See also \l {skipline} {\\skipline}, \l
+ {skipto} {\\skipto} and \l {skipuntil} {\\skipuntil}.
\row
\o \bold \\snippet \target snippet
@@ -2119,10 +2119,10 @@
\section1 Alphabetical List
- \l {08-qdoc-commands-linking.html#keyword}{\\keyword},
- \l {08-qdoc-commands-linking.html#l}{\\l},
- \l {08-qdoc-commands-linking.html#sa}{\\sa},
- \l {08-qdoc-commands-linking.html#target}{\\target}
+ \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
+ \l {08-qdoc-commands-linking.html#l} {\\l},
+ \l {08-qdoc-commands-linking.html#sa} {\\sa},
+ \l {08-qdoc-commands-linking.html#target} {\\target}
\section1 Command Descriptions
@@ -2138,7 +2138,7 @@
The command's general syntax is
\code
- \l {link target}{link text}
+ \l {link target} {link text}
\endcode
For example:
@@ -2173,7 +2173,7 @@
...
Regexps are built up from expressions, quantifiers, and
- \l {assertions}{assertions}.
+ \l {assertions} {assertions}.
* /
\endcode
@@ -2195,24 +2195,24 @@
\endcode
For the one-parameter version the braces can often
- be omitted. See the \l {i}{\\i} command for the \l
- {argument}{argument conventions}.
+ be omitted. See the \l {i} {\\i} command for the \l
+ {argument} {argument conventions}.
The \\l command supports several kinds of links:
\list
- \o \c {\l QWidget} - a defined \l {class}{\\class}
+ \o \c {\l QWidget} - a defined \l {class-command} {\\class}
\o \c {\l QWidget::sizeHint()} - a defined member
- function (\l {fn}{\\fn})
- \o \c {\l <QtGlobal>} - a defined \l {headerfile}{\\headerfile}
+ function (\l {fn} {\\fn})
+ \o \c {\l <QtGlobal>} - a defined \l {headerfile} {\\headerfile}
\o \c {\l widgets/wiggly} - a defined
- \l {example-command}{\\example}
- \o \c {\l {QWidget Class Reference}} - a defined \l {title}{\\title}
- \o \c {\l {Introduction}}- a defined \l{part}{\\part},
- \l{chapter}{\\chapter} or \l {sectionOne}{\\section...}
- \o \c {\l fontmatching} - a defined \l {target}{\\target}
- \o \c {\l {Shared Classes}} - a defined \l {keyword}{\\keyword}
- \o \c {\l network.html} - a defined \l {page}{\\page}
+ \l {example-command} {\\example}
+ \o \c {\l {QWidget Class Reference}} - a defined \l {title} {\\title}
+ \o \c {\l {Introduction}}- a defined \l{part} {\\part},
+ \l{chapter} {\\chapter} or \l {sectionOne} {\\section...}
+ \o \c {\l fontmatching} - a defined \l {target} {\\target}
+ \o \c {\l {Shared Classes}} - a defined \l {keyword} {\\keyword}
+ \o \c {\l network.html} - a defined \l {page} {\\page}
\o \c {\l http://www.trolltech.com/} - a URL
\endlist
@@ -2226,11 +2226,11 @@
can use the following syntax:
\list
- \o \c {\l {QWidget::}{sizeHint()}}
+ \o \c {\l {QWidget::} {sizeHint()}}
\endlist
- See also \l {sa}{\\sa}, \l {target}{\\target} and \l
- {keyword}{\\keyword}.
+ See also \l {sa} {\\sa}, \l {target} {\\target} and \l
+ {keyword} {\\keyword}.
\row
\o \bold \\sa \target sa
@@ -2264,7 +2264,7 @@
\endlist
The \\sa command supports the same kind
- of links as the \l {l}{\\l} command. For example:
+ of links as the \l {l} {\\l} command. For example:
\code
/ *!
@@ -2288,18 +2288,18 @@
Appends the actions \i actions to this widget's
list of actions.
- See also \l {QWidget::removeAction()}{removeAction()},
- \l QMenu, and \l {QWidget::addAction()}{addAction()}.
+ See also \l {QWidget::removeAction()} {removeAction()},
+ \l QMenu, and \l {QWidget::addAction()} {addAction()}.
\endquotation
- See also \l {l}{\\l}, \l {target}{\\target} and \l
- {keyword}{\\keyword}.
+ See also \l {l} {\\l}, \l {target} {\\target} and \l
+ {keyword} {\\keyword}.
\row
\o \bold \\target \target target
\o \bold {The \\target command defines an explicit point in the
- documentation that you can later link to using the \l {l}{\\l}
- and \l {sa}{\\sa} commands.}
+ documentation that you can later link to using the \l {l} {\\l}
+ and \l {sa} {\\sa} commands.}
The command considers the rest of the line as part of its
argument, make sure to follow the target name with a line
@@ -2339,21 +2339,21 @@
If the target name does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l}{\\l}, \l {sa}{\\sa} and \l
- {keyword}{\\keyword}.
+ See also \l {l} {\\l}, \l {sa} {\\sa} and \l
+ {keyword} {\\keyword}.
\row
\o \bold \\keyword \target keyword
\o \bold {The \\keyword command defines an explicit point in the
- documentation that you can later link to using the \l {l}{\\l}
- and \l {sa}{\\sa} commands.}
+ documentation that you can later link to using the \l {l} {\\l}
+ and \l {sa} {\\sa} commands.}
Keywords must be unique within the entire set of
documentation processed in on QDoc run. The command
considers the rest of the line as part of its argument,
make sure to follow the keyword with a line break.
- The \\keyword command is similar to \l {target}{\\target},
+ The \\keyword command is similar to \l {target} {\\target},
but stronger. A keyword can be referenced from anywhere
using a simple syntax. For example:
@@ -2396,8 +2396,8 @@
If the keyword does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l}{\\l}, \l {sa}{\\sa} and \l
- {target}{\\target}.
+ See also \l {l} {\\l}, \l {sa} {\\sa} and \l
+ {target} {\\target}.
\endtable
*/
@@ -2415,9 +2415,9 @@
\section1 Alphabetical List
- \l {09-qdoc-commands-graphic.html#caption}{\\caption},
- \l {09-qdoc-commands-graphic.html#image}{\\image},
- \l {09-qdoc-commands-graphic.html#inlineimage}{\\inlineimage}
+ \l {09-qdoc-commands-graphic.html#caption} {\\caption},
+ \l {09-qdoc-commands-graphic.html#image} {\\image},
+ \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
\section1 Command Descriptions
@@ -2476,11 +2476,11 @@
variants. It is also available for embedded devices.
\endquotation
- See also \l {inlineimage}{\\inlineimage} and \l
- {caption}{\\caption}.
+ See also \l {inlineimage-command} {\\inlineimage} and \l
+ {caption} {\\caption}.
\row
- \o \bold \\inlineimage \target inlineimage
+ \o \bold \\inlineimage \target inlineimage-command
\o \bold {The \\inlineimage command expands to the image
specified by its argument; the image is rendered inline
with the rest of the text.}
@@ -2585,20 +2585,20 @@
to derive maximum benefit from the course.
\endquotation
- See also \l {image}{\\image} and \l {caption}{\\caption}.
+ See also \l {image} {\\image} and \l {caption} {\\caption}.
\row
\o \bold \\caption \target caption
\o \bold {The \\caption command provides a caption for an image.}
The command follows the same conventions for parentheses and use
- of braces for its \l argument as the \l {i}{\\i} command.
+ of braces for its \l argument as the \l {i} {\\i} command.
\warning This is preliminary functionality. The
command is not fully implemented.
- See also \l {image}{\\image} and \l
- {inlineimage}{\\inlineimage}
+ See also \l {image} {\\image} and \l
+ {inlineimage-command} {\\inlineimage}
\endtable
*/
@@ -2618,13 +2618,13 @@
\section1 Alphabetical List
- \l {10-qdoc-commands-container.html#header}{\\header},
- \l {10-qdoc-commands-container.html#list}{\\list},
- \l {10-qdoc-commands-container.html#o}{\\o},
- \l {10-qdoc-commands-container.html#omitvalue}{\\omitvalue},
- \l {10-qdoc-commands-container.html#row}{\\row},
- \l {10-qdoc-commands-container.html#table}{\\table},
- \l {10-qdoc-commands-container.html#value}{\\value}
+ \l {10-qdoc-commands-container.html#header} {\\header},
+ \l {10-qdoc-commands-container.html#list} {\\list},
+ \l {10-qdoc-commands-container.html#o} {\\o},
+ \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue},
+ \l {10-qdoc-commands-container.html#row} {\\row},
+ \l {10-qdoc-commands-container.html#table} {\\table},
+ \l {10-qdoc-commands-container.html#value-command} {\\value}
\section1 Command Descriptions
@@ -2656,9 +2656,9 @@
the table will be centered in the generated documentation.
A table can contain headers, rows and columns. A row starts
- with a \l {row}{\\row} command and consists of cells, which
- starts with a \l {o}{\\o} command. There is also a \l
- {header}{\\header} command which is a special kind of row
+ with a \l {row} {\\row} command and consists of cells, which
+ starts with a \l {o} {\\o} command. There is also a \l
+ {header} {\\header} command which is a special kind of row
with a special formatting. For example:
\code
@@ -2775,7 +2775,7 @@
</table>
\endraw
- See also \l {header}{\\header}, \l {row}{\\row} and \l {o}{\\o}.
+ See also \l {header} {\\header}, \l {row} {\\row} and \l {o} {\\o}.
\row
\o \bold \\header \target header
@@ -2784,7 +2784,7 @@
The command can only be used within the \l{table}
{\\table...\\endtable} commands. A header can contain
- several cells. A cell is created with the \l {o}{\\o}
+ several cells. A cell is created with the \l {o} {\\o}
command.
A header cell's text is centered within the table cell and
@@ -2825,7 +2825,7 @@
</table>
\endraw
- See also \l {table}{\\table}, \l {row}{\\row} and \l {o}{\\o}.
+ See also \l {table} {\\table}, \l {row} {\\row} and \l {o} {\\o}.
\row
\o \bold \\row \target row
@@ -2834,7 +2834,7 @@
The command can only be used within the \l{table}
{\\table...\\endtable} commands. A row can contain
- several cells. A cell is created with the \l {o}{\\o}
+ several cells. A cell is created with the \l {o} {\\o}
command.
The background cell color of each row alternate between two
@@ -2907,11 +2907,11 @@
</table>
\endraw
- See also \l {table}{\\table}, \l {header}{\\header} and \l
- {o}{\\o}.
+ See also \l {table} {\\table}, \l {header} {\\header} and \l
+ {o} {\\o}.
\row
- \o \bold \\value \target value
+ \o \bold \\value \target value-command
\o \bold {The \\value command starts the documentation of a C++ enum
item}.
@@ -2921,21 +2921,21 @@
rendered within a table.
The documentation will be located in the associated class,
- header file or namespace documentation. See the \l
- {enum}{\\enum} documentation for an example.
+ header file or namespace documentation. See the \l {enum-command}
+ {\\enum} documentation for an example.
- See also \l {enum}{\\enum} and \l {omitvalue}{\\omitvalue}.
+ See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
\row
- \o \bold \\omitvalue \target omitvalue
+ \o \bold \\omitvalue \target omitvalue-command
\o \bold {The \\omitvalue command excludes a C++ enum item
from the documentation}.
The command's only argument is the name of the enum item
- that will be omitted. See the \l {enum}{\\enum}
+ that will be omitted. See the \l {enum-command} {\\enum}
documentation for an example.
- See also \l {enum}{\\enum} and \l {value}{\\value}.
+ See also \l {enum-command} {\\enum} and \l {value-command} {\\value}.
\row
\o \bold \\list \target list
@@ -2943,7 +2943,7 @@
command delimit a list of items.}
You need to create each list item explicitly using the \l
- {o}{\\o} command. A list can contain one or more items; it
+ {o} {\\o} command. A list can contain one or more items; it
can also be nested. For example:
\code
@@ -3064,26 +3064,26 @@
\o Tutorial and Examples
\endlist
- See also \l {o}{\\o}.
+ See also \l {o} {\\o}.
\row
\o \bold \\o \target o
\o \bold {The \\o command announce a table or list item.}
- Earlier we used the \l {i}{\\i} command for this purpose. For more
+ Earlier we used the \l {i} {\\i} command for this purpose. For more
information see the \l
- {26-qdoc-commands-compatibility.html#o-versus-i}{compatibility}
+ {26-qdoc-commands-compatibility.html#o-versus-i} {compatibility}
section.
The command can only be used within the \l{table}
- {\\table...\\endtable} or \l{list}{\\list... \\endlist}
+ {\\table...\\endtable} or \l{list} {\\list... \\endlist}
commands.
It considers everything until the next occurrence
of the \\o command, or the currently applicable \l
- {table}{\\endtable} or \l {list}{\\endlist} command, as its
- argument. For examples, see \l {table}{\\table} and \l
- {list}{\\list}.
+ {table} {\\endtable} or \l {list} {\\endlist} command, as its
+ argument. For examples, see \l {table} {\\table} and \l
+ {list} {\\list}.
If the command is used within a table, you can in addition
specify how many rows or columns the item should span. For
@@ -3138,8 +3138,8 @@
If not specified, the item will span one column and one row.
- See also \l {table}{\\table}, \l {header}{\\header},
- \l {list}{\\list} and \l {o}{\\o}.
+ See also \l {table} {\\table}, \l {header} {\\header},
+ \l {list} {\\list} and \l {o} {\\o}.
\endtable
*/
@@ -3157,14 +3157,14 @@
\section1 Alphabetical List
- \l {11-qdoc-commands-documentcontents.html#abstract}{\\abstract},
- \l {11-qdoc-commands-documentcontents.html#brief}{\\brief},
- \l {11-qdoc-commands-documentcontents.html#footnote}{\\footnote},
- \l {11-qdoc-commands-documentcontents.html#legalese}{\\legalese},
+ \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
+ \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
+ \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
+ \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
\l {11-qdoc-commands-documentcontents.html#tableofcontents}
{\\tableofcontents},
- \l {11-qdoc-commands-documentcontents.html#quotation}{\\quotation},
- \l {11-qdoc-commands-documentcontents.html#warning}{\\warning}
+ \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
+ \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
\section1 Command Descriptions
@@ -3441,18 +3441,18 @@
chapter or section.
\row
- \o \bold \\brief \target brief
+ \o \bold \\brief \target brief-command
\o \bold {The \\brief command introduces a one-sentence
description of a class, namespace, header file, property
or variable.}
The brief text is used to introduce the documentation of
the associated object, and in lists generated using the \l
- {generatelist}{\\generatelist} command.
+ {generatelist-command} {\\generatelist} command.
The \\brief command can be used in two significant
- different ways: \l {brief class}{One for classes,
- namespaces and header files}, and \l {brief property}{one
+ different ways: \l {brief class} {One for classes,
+ namespaces and header files}, and \l {brief property} {one
for properties and variables}.
\target brief property
@@ -3519,8 +3519,8 @@
\endlist
See also \l
- {QWidget::frameGeometry()}{frameGeometry()}, \l
- {QWidget::rect()}{rect()}, ...
+ {QWidget::frameGeometry()} {frameGeometry()}, \l
+ {QWidget::rect()} {rect()}, ...
\endquotation
\target brief class
@@ -3569,7 +3569,7 @@
The PreviewWindow class is a custom widget displaying
the names of its currently set window flags in a
- read-only text editor. \l {preview window}{More...}
+ read-only text editor. \l {preview window} {More...}
\raw HTML
<h3>Properties</h3>
@@ -3585,8 +3585,8 @@
\endraw
\list
- \o \l {constructor}{PreviewWindow}(QWidget *parent = 0)
- \o void \l {function}{setWindowFlags}(Qt::WindowFlags flags)
+ \o \l {constructor} {PreviewWindow}(QWidget *parent = 0)
+ \o void \l {function} {setWindowFlags}(Qt::WindowFlags flags)
\endlist
\list
@@ -3628,7 +3628,7 @@
The PreviewWindow class inherits QWidget. The widget
displays the names of its window flags set with the \l
- {function}{setWindowFlags()} function. It is also
+ {function} {setWindowFlags()} function. It is also
provided with a QPushButton that closes the window.
...
@@ -3687,8 +3687,8 @@
* /
\endcode
- See also \l{property}{\\property}, \l{class}{\\class},
- \l{namespace}{\\namespace} and \l{headerfile}{\\headerfile}.
+ See also \l{property} {\\property}, \l{class-command} {\\class},
+ \l{namespace} {\\namespace} and \l{headerfile} {\\headerfile}.
\row
\o \bold \\legalese \target legalese
@@ -3704,7 +3704,7 @@
Later the documentation identified by the \\legalese
command can be accumulated into a list using the \l
- {generatelist}{\\generatelist} command with the \c legalese
+ {generatelist-command} {\\generatelist} command with the \c legalese
argument. This is useful to generate an overview of all the
licenses associated with the source code.
@@ -3827,16 +3827,16 @@
\section1 Alphabetical List
- \l {12-0-qdoc-commands-miscellaneous.html#else}{\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif}{\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire}{\\expire},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist}{\\generatelist},
- \l {12-0-qdoc-commands-miscellaneous.html#if}{\\if},
- \l {12-0-qdoc-commands-miscellaneous.html#include}{\\include},
- \l {12-0-qdoc-commands-miscellaneous.html#meta}{\\meta},
- \l {12-0-qdoc-commands-miscellaneous.html#omit}{\\omit},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)},
- \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\unicode}
+ \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
+ \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
+ \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
+ \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
+ \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
+ \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
+ \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
+ \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
+ \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode}
\section1 Command Descriptions
@@ -3879,7 +3879,7 @@
\endquotation
\row
- \o \bold \\generatelist \target generatelist
+ \o \bold \\generatelist \target generatelist-command
\o \bold {The \\generatelist command expands to a list of
various documentation or links to documentation.}
@@ -3950,8 +3950,8 @@
\endquotation
A class is identified within the documentation by the
- the \l {class}{\\class} command, and the descriptions
- are based on the argument of the \l {brief}{\\brief}
+ the \l {class-command} {\\class} command, and the descriptions
+ are based on the argument of the \l {brief-command} {\\brief}
commands in the class documentation.
\target list example
@@ -4005,7 +4005,7 @@
\endquotation
A class is identified within the documentation by the
- the \l {class}{\\class} command.
+ the \l {class-command} {\\class} command.
\o \c classesbymodule
@@ -4035,14 +4035,14 @@
a link to the class's reference documentation.
The generated table is rendered similarily to the one
- generated when using the \l {table example}{\c
+ generated when using the \l {table example} {\c
annotatedclasses} argument.
For the basic classes in Qt, a class's module is
determined by its location, i.e. its directory. However,
for extensions, like ActiveQt and Qt Designer, a class
is related to a module with the \l
- {inmodule}{\\inmodule} command.
+ {inmodule} {\\inmodule} command.
\o \c classesbyedition
@@ -4073,10 +4073,10 @@
The \c compatclasses argument provides a complete and
alphabetical list of the support classes. A support
class is identified within the documentation by the \l
- {compat}{\\compat} command. Each class name is a link to
+ {compat} {\\compat} command. Each class name is a link to
the class's reference documentation. The list is
rendered similarily to the list generated by the \l
- {list example}{\c classes} argument.
+ {list example} {\c classes} argument.
\warning The \c classesbymodule argument will at some
point replace the this argument.
@@ -4112,7 +4112,7 @@
The \c legalese argument provides a complete list of all
the licenses. The licenses are identified within the
- documentation using the \l {legalese}{\\legalese}
+ documentation using the \l {legalese} {\\legalese}
command.
For example:
@@ -4173,10 +4173,10 @@
alphabetical list of the main classes. Each class name
is a link to the class's reference documentation. A
class is related to the group of main classes by using
- the \l {mainclass}{\\mainclass} command.
+ the \l {mainclass-command} {\\mainclass} command.
The list is rendered similarily to the list generated by
- the \l {list example}{\c classes} argument.
+ the \l {list example} {\c classes} argument.
\o \c overviews
@@ -4185,10 +4185,10 @@
entry is a link to the respective documentation page.
The list includes pages declared using commands like \l
- {page}{\\page} and \l {group}{\\group}. The list omits
+ {page} {\\page} and \l {group-command} {\\group}. The list omits
examples and classes, and only lists the first page of
documentation that contains two or more pages using
- commands like \l {nextpage}{\\nextpage}.
+ commands like \l {nextpage} {\\nextpage}.
For example:
@@ -4245,14 +4245,14 @@
\o \c related
The \c related argument is used in combination with the
- \l {group}{\\group} command to list all the overviews
+ \l {group-command} {\\group} command to list all the overviews
related to the given group. Each list entry is a link to
the respective documentation page.
\o \c relatedinline
The \c related argument is used in combination with the
- \l {group}{\\group} command to collect all documentation
+ \l {group-command} {\\group} command to collect all documentation
related to the given group. The various documentation
snippets are copied directly into the group page.
@@ -4263,13 +4263,13 @@
service's reference documentation.
A service is identified within the documentation by the
- \l {service}{\\service} command.
+ \l {service} {\\service} command.
\endlist
\row
- \o \bold \\if \target if
+ \o \bold \\if \target if-command
\o \bold {The \\if command and the corresponding \\endif command
enclose parts of a QDoc comment that only will be included if
the condition specified by the command's argument is true.}
@@ -4282,7 +4282,7 @@
\if defined(opensourceedition)
\bold{Note:} This edition is for the development of
- \l{Qt Open Source Edition}{Free and Open Source}
+ \l{Qt Open Source Edition} {Free and Open Source}
software only; see \l{Qt Commercial Editions}.
\endif
@@ -4291,7 +4291,7 @@
This QDoc comment will only be rendered if the \c
opensourceedition preprocessor symbol is defined, and
- specified in the \l {definesvariable}{defines} variable in
+ specified in the \l {definesvariable} {defines} variable in
the configuration file to make QDoc process
the code within #ifdef and #endif:
@@ -4301,31 +4301,31 @@
You can also define the preprocessor symbol manually on the
command line. For more information see the documentation of
- the \l {definesvariable}{defines} variable.
+ the \l {definesvariable} {defines} variable.
- See also \l{endif}{\\endif}, \l{else}{\\else}, \l
- {definesvariable}{defines} and \l falsehoods.
+ See also \l{endif} {\\endif}, \l{else} {\\else}, \l
+ {definesvariable} {defines} and \l falsehoods.
\row
\o \bold \\endif \target endif
\o \bold {The \\endif command and the corresponding \\if command
enclose parts of a QDoc comment that will be included if
- the condition specified by the \l {if}{\\if} command's
+ the condition specified by the \l {if-command} {\\if} command's
argument is true.}
For more information, see the documentation of the \l
- {if}{\\if} command.
+ {if-command} {\\if} command.
- See also \l{if}{\\if}, \l{else}{\\else}, \l
- {definesvariable}{defines} and \l falsehoods.
+ See also \l{if-command} {\\if}, \l{else} {\\else}, \l
+ {definesvariable} {defines} and \l falsehoods.
\row
\o \bold \\else \target else
\o \bold {The \\else command specifies an alternative if the
- condition in the \l {if}{\\if} command is false.}
+ condition in the \l {if-command} {\\if} command is false.}
The \\else command can only be used within \l
- {if}{\\if...\\endif} commands, but is useful when there is
+ {if-command} {\\if...\\endif} commands, but is useful when there is
only two alternatives. For example:
\code
@@ -4413,8 +4413,8 @@
GCC 3.2+ and MSVC 7.)
\endquotation
- See also \l{if}{\\if}, \l{endif}{\\endif}, \l
- {definesvariable}{defines} and \l falsehoods.
+ See also \l{if-command} {\\if}, \l{endif} {\\endif}, \l
+ {definesvariable} {defines} and \l falsehoods.
\row
\o \bold \\include \target include
@@ -4623,16 +4623,16 @@
color styles in your style.css file. Then you can write:
\code
- \tt {\span {id="color-blue"}{Blue(#0000ff)}},
- \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
- \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+ \tt {\span {id="color-blue"} {Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
\endcode
...which is rendered again as:
- \tt {\span {id="color-blue"}{Blue(#0000ff)}},
- \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
- \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+ \tt {\span {id="color-blue"} {Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
\row
\o \bold \\unicode \target unicode
@@ -4708,21 +4708,21 @@
\section1 Alphabetical List
- \l {13-qdoc-commands-topical.html#class}{\\class},
- \l {13-qdoc-commands-topical.html#enum}{\\enum},
- \l {13-qdoc-commands-topical.html#example-command}{\\example},
- \l {13-qdoc-commands-topical.html#externalpage}{\\externalpage},
- \l {13-qdoc-commands-topical.html#fn}{\\fn},
- \l {13-qdoc-commands-topical.html#group}{\\group},
- \l {13-qdoc-commands-topical.html#headerfile}{\\headerfile},
- \l {13-qdoc-commands-topical.html#macro}{\\macro},
- \l {13-qdoc-commands-topical.html#module}{\\module},
- \l {13-qdoc-commands-topical.html#namespace}{\\namespace},
- \l {13-qdoc-commands-topical.html#page}{\\page},
- \l {13-qdoc-commands-topical.html#property}{\\property},
- \l {13-qdoc-commands-topical.html#service}{\\service},
- \l {13-qdoc-commands-topical.html#typedef}{\\typedef},
- \l {13-qdoc-commands-topical.html#variable}{\\variable},
+ \l {13-qdoc-commands-topical.html#class-command} {\\class},
+ \l {13-qdoc-commands-topical.html#enum-command} {\\enum},
+ \l {13-qdoc-commands-topical.html#example-command} {\\example},
+ \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage},
+ \l {13-qdoc-commands-topical.html#fn} {\\fn},
+ \l {13-qdoc-commands-topical.html#group-command} {\\group},
+ \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile},
+ \l {13-qdoc-commands-topical.html#macro} {\\macro},
+ \l {13-qdoc-commands-topical.html#module} {\\module},
+ \l {13-qdoc-commands-topical.html#namespace} {\\namespace},
+ \l {13-qdoc-commands-topical.html#page} {\\page},
+ \l {13-qdoc-commands-topical.html#property} {\\property},
+ \l {13-qdoc-commands-topical.html#service} {\\service},
+ \l {13-qdoc-commands-topical.html#typedef} {\\typedef},
+ \l {13-qdoc-commands-topical.html#variable} {\\variable},
\section1 General Description
@@ -4744,7 +4744,7 @@
\endcode
Functions is a special case, the argument's naming convention for
- the \l {fn}{\\fn} command is that of the function's definition
+ the \l {fn} {\\fn} command is that of the function's definition
outside the class definition. For example:
\code
@@ -4787,12 +4787,12 @@
\o Description
\row
- \o \bold \\class \target class
+ \o \bold \\class \target class-command
\o \bold {The \\class command tells QDoc that a class is
part of the public API, and lets you enter a detailed
description.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument, and supports
nested classes, for example:
@@ -4821,9 +4821,9 @@
and slots with empty documentation.
The command is typically accompanied with a \l
- {brief}{\\brief} command, a \l {mainclass}{\\mainclass}
- command, an \l {ingroup}{\\ingroup} command and a \l
- {sa}{\\sa} command. For example:
+ {brief-command} {\\brief} command, a \l {mainclass-command} {\\mainclass}
+ command, an \l {ingroup-command} {\\ingroup} command and a \l
+ {sa} {\\sa} command. For example:
\code
/ *!
@@ -4837,7 +4837,7 @@
The PreviewWindow class inherits QWidget. The widget
displays the names of its window flags set with the \l
- {function}{setWindowFlags()} function. It is also
+ {function} {setWindowFlags()} function. It is also
provided with a QPushButton that closes the window.
...
@@ -4855,7 +4855,7 @@
The PreviewWindow class is a custom widget displaying
the names of its currently set window flags in a
- read-only text editor. \l {preview window}{More...}
+ read-only text editor. \l {preview window} {More...}
\raw HTML
<h3>Properties</h3>
@@ -4871,8 +4871,8 @@
\endraw
\list
- \o \l {constructor}{PreviewWindow}(QWidget *parent = 0)
- \o void \l {function}{setWindowFlags}(Qt::WindowFlags flags)
+ \o \l {constructor} {PreviewWindow}(QWidget *parent = 0)
+ \o void \l {function} {setWindowFlags}(Qt::WindowFlags flags)
\endlist
\list
@@ -4915,7 +4915,7 @@
The PreviewWindow class inherits QWidget. The widget
displays the names of its window flags set with the \l
- {function}{setWindowFlags()} function. It is also
+ {function} {setWindowFlags()} function. It is also
provided with a QPushButton that closes the window.
...
@@ -4949,16 +4949,16 @@
\endquotation
\row
- \o \bold \\enum \target enum
+ \o \bold \\enum \target enum-command
\o \bold {The \\enum command allows you to document a C++ enum.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
- The enum items are documented using the \l {value}{\\value}
+ The enum items are documented using the \l {value-command} {\\value}
command. If an item isn't documented, QDoc will emit a
warning. This can be avoided using the \l
- {omitvalue}{\\omitvalue} command excluding an item from the
+ {omitvalue-command} {\\omitvalue} command excluding an item from the
documentation. The enum documentation will be located in
the associated class, header file or namespace
documentation.
@@ -5049,14 +5049,14 @@
in qt.html.
- See also \l {value}{\\value} and \l {omitvalue}{\\omitvalue}.
+ See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
\row
\o \bold \\example \target example-command
\o \bold {The \\example command allows you to document an
example.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument. In particular
the command's argument is the example's path relative to
the paths listed in the \l exampledirs configuration
@@ -5111,7 +5111,7 @@
\o \bold \\fn \target fn
\o \bold {The \\fn command allows you to document a function.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument. In particular
it is important that the return type of the function,
whether it is \c const or not and the complete set of
@@ -5153,30 +5153,30 @@
\a area; otherwise returns false.
\endquotation
- See also \l {overload}{\\overload}.
+ See also \l {overload} {\\overload}.
\row
- \o \bold \\group \target group
+ \o \bold \\group \target group-command
\o \bold {The \\group command creates a separate page that
lists the classes belonging to the group specified by the
command's argument.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument. The \\group
- command is typically followed by a \l {title}{\\title}
+ command is typically followed by a \l {title} {\\title}
command and a short introduction to the group. The
generated HTML documentation for the specified group is put
in <lower-case>\i{group}.html.
A class can be related to a group by using the \l
- {ingroup}{\\ingroup} command. In addition, overviews can be
+ {ingroup-command} {\\ingroup} command. In addition, overviews can be
related to a group using the same command, but these must
be listed explicitly using the \l
- {generatelist}{\\generatelist} command (see example below).
+ {generatelist-command} {\\generatelist} command (see example below).
Each class is listed with a link to the class reference
page and a brief description based on the classes' \l
- {brief}{\\brief} texts. For example:
+ {brief-command} {\\brief} texts. For example:
\code
/ *!
@@ -5234,7 +5234,7 @@
Note that overviews related to the given group, must be
listed explicitly using the \l
- {generatelist}{\\generatelist} command with the \c related
+ {generatelist-command} {\\generatelist} command with the \c related
argument. For example:
\code
@@ -5251,21 +5251,21 @@
* /
\endcode
- See also \l {ingroup}{\\ingroup} and \l
- {generatelist}{\\generatelist}.
+ See also \l {ingroup-command} {\\ingroup} and \l
+ {generatelist-command} {\\generatelist}.
\row
\o \bold \\headerfile \target headerfile
\o \bold {The \\headerfile command allows you to document
global functions, types and macros declared in a header file.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument, and the
generated HTML documentation for the specified header file
is put in <lower-case>\i{headerfilename}.html.
A function, type or macro can be associated with a
- headerfile using the \l {relates}{\\relates} command.
+ headerfile using the \l {relates-command} {\\relates} command.
If the referenced header file doesn't exist, the
\\headerfile command will still create a documentation page
@@ -5330,7 +5330,7 @@
\o \bold \\macro \target macro
\o \bold {The \\macro command allows you to document a C++ macro.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
QDoc recognizes three different macro syntax: function-like
@@ -5338,7 +5338,7 @@
Q_PROPERTY() and macros without parentheses like Q_OBJECT.
The \\macro command must be followed by a \l
- {relates}{\\relates} command which attaches the
+ {relates-command} {\\relates} command which attaches the
documentation to that of a related class, header file. or
namespace. Otherwise the documentation will be lost.
@@ -5448,17 +5448,17 @@
classes belonging to the module specified by the command's
argument.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
A class can be related to a module using the \l
- {inmodule}{\\inmodule} command.
+ {inmodule} {\\inmodule} command.
The \\module command is typically followed by the \l
- {title}{\\title} and \l {brief}{\\brief} commands. Each
+ {title} {\\title} and \l {brief-command} {\\brief} commands. Each
class is listed with a link to the class reference page and
a brief description based on the classes' \l
- {brief}{\\brief} texts.
+ {brief-command} {\\brief} texts.
For example:
@@ -5489,7 +5489,7 @@
The QtNetwork module offers classes that allow you to
write TCP/IP clients and servers.\l {module
- details}{More...}
+ details} {More...}
\raw HTML
<p>
@@ -5545,19 +5545,19 @@
in qtnetwork.html.
- See also \l {inmodule}{\\inmodule}
+ See also \l {inmodule} {\\inmodule}
\row
\o \bold \\namespace \target namespace
\o \bold {The \\namespace command allows you to document a C++
namespace.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
QDoc will generate the same additional links and
documentation for all the members of the namespace as it
- does for \l {framework}{classes}. The documentation for
+ does for \l {framework} {classes}. The documentation for
the specified namespace is put in <lower-case>\i
{namespace}.html.
@@ -5616,10 +5616,10 @@
\o \bold {The \\page command allows you to create a stand-alone
documentation page.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
- The page's title can be set using the \l {title}{\\title}
+ The page's title can be set using the \l {title} {\\title}
command. For example:
\code
@@ -5652,7 +5652,7 @@
\o \bold {The \\externalpage command gives a title to
an external URL.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
For example:
@@ -5679,7 +5679,7 @@
\quotation
The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html}{Qtopia
+ {http://www.trolltech.com/products/embedded/index.html} {Qtopia
Core} API enables it to be used across a wide variety
of development projects.
\endquotation
@@ -5691,7 +5691,7 @@
\code
/ *!
The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html}{Qtopia
+ {http://www.trolltech.com/products/embedded/index.html} {Qtopia
Core} API enables it to be used across a wide variety
of development projects.
* /
@@ -5706,7 +5706,7 @@
\o \bold {The \\property command allows you to document a Qt
property.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
A property is defined using the Q_PROPERTY() macro. The
@@ -5725,12 +5725,12 @@
property.
The \\property command is typically accompanied with a \l
- {brief}{\\brief} command. In the case of a property, the
- \l {brief}{\\brief} command's argument is a sentence
- fragment that will be included in a one-sentence
- description of the property generated by QDoc. The command
- follows the same rules for the \l {brief
- property}{description} as the \l {variable}{\\variable}
+ {brief-command} {\\brief} command. In the case of a
+ property, the \l {brief-command} {\\brief} command's
+ argument is a sentence fragment that will be included in a
+ one-sentence description of the property generated by
+ QDoc. The command follows the same rules for the \l {brief
+ property} {description} as the \l {variable} {\\variable}
command.
For example:
@@ -5797,8 +5797,8 @@
\o \bold { int width () const}
\endlist
- See also \l{QWidget::geometry}{geometry},
- \l{QWidget::height}{height}, and \l{QWidget::size}{size}.
+ See also \l{QWidget::geometry} {geometry},
+ \l{QWidget::height} {height}, and \l{QWidget::size} {size}.
\endquotation
in qwidget.html.
@@ -5824,21 +5824,21 @@
}
\endcode
- See also \l {class}{\\class} and \l
- {generatelist}{\\generatelist}.
+ See also \l {class-command} {\\class} and \l
+ {generatelist-command} {\\generatelist}.
\row
\o \bold \\typedef \target typedef
\o \bold {The \\typedef command allows you to document a C++ type
definition.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
The documentation will be located in the associated class,
header file or namespace documentation. When documenting a
global type definition, the \\typedef command must be
- accompanied with a \l {relates}{\\relates} command. For
+ accompanied with a \l {relates-command} {\\relates} command. For
example:
\code
@@ -5926,15 +5926,15 @@
\o \bold {The \\variable command allows you to document a
member variable or a constant.}
- The command follows \l {topical argument}{the general
+ The command follows \l {topical argument} {the general
topical command convention} for the argument.
The \\variable command is typically followed by a \l
- {brief}{\\brief} command; QDoc will generate the
- documentation for the variable based on the brief
+ {brief-command} {\\brief} command; QDoc will generate the
+ documentation for the variable based on the brief-command
description. The command follows the same rules for the \l
- {brief property}{description} as the \l
- {property}{\\property} command.
+ {brief property} {description} as the \l {property}
+ {\\property} command.
The documentation will be located in the in the associated
class, header file or namespace documentation.
@@ -6011,8 +6011,8 @@
The default type for tree widget items.
- See also \l {QTreeWidgetItem::UserType}{UserType} and
- \l {QTreeWidgetItem::type()}{type()}.
+ See also \l {QTreeWidgetItem::UserType} {UserType} and
+ \l {QTreeWidgetItem::type()} {type()}.
\raw HTML
<h3>
@@ -6023,8 +6023,8 @@
The minimum value for custom types. Values below
UserType are reserved by Qt.
- See also \l {QTreeWidgetItem::Type}{Type} and
- \l{QTreeWidgetItem::type()}{type()}.
+ See also \l {QTreeWidgetItem::Type} {Type} and
+ \l{QTreeWidgetItem::type()} {type()}.
\endquotation
@@ -6048,25 +6048,25 @@
\section1 Alphabetical List
- \l {16-qdoc-commands-status.html#compat}{\\compat},
- \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage}{\\indexpage},
- \l {19-qdoc-commands-grouping.html#ingroup}{\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule}{\\inmodule},
- \l {16-qdoc-commands-status.html#internal}{\\internal},
- \l {19-qdoc-commands-grouping.html#mainclass}{\\mainclass},
- \l {15-qdoc-commands-navigation.html#nextpage}{\\nextpage},
- \l {17-qdoc-commands-thread.html#nonreentrant}{\\nonreentrant},
- \l {16-qdoc-commands-status.html#obsolete}{\\obsolete},
- \l {18-qdoc-commands-relating.html#overload}{\\overload},
- \l {16-qdoc-commands-status.html#preliminary}{\\preliminary},
- \l {15-qdoc-commands-navigation.html#previouspage}{\\previouspage},
- \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant},
- \l {18-qdoc-commands-relating.html#reimp}{\\reimp},
- \l {18-qdoc-commands-relating.html#relates}{\\relates},
- \l {15-qdoc-commands-navigation.html#startpage}{\\startpage},
- \l {17-qdoc-commands-thread.html#threadsafe}{\\threadsafe},
- \l {20-qdoc-commands-title.html#title}{\\title}
+ \l {16-qdoc-commands-status.html#compat} {\\compat},
+ \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
+ \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
+ \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
+ \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule},
+ \l {16-qdoc-commands-status.html#internal} {\\internal},
+ \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
+ \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage},
+ \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
+ \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
+ \l {18-qdoc-commands-relating.html#overload} {\\overload},
+ \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
+ \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
+ \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
+ \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
+ \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
+ \l {15-qdoc-commands-navigation.html#startpage} {\\startpage},
+ \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe},
+ \l {20-qdoc-commands-title.html#title} {\\title}
\section1 Categories
\list
@@ -6094,11 +6094,11 @@
\section1 Alphabetical List
- \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage}{\\indexpage},
- \l {15-qdoc-commands-navigation.html#nextpage}{\\nextpage},
- \l {15-qdoc-commands-navigation.html#previouspage}{\\previouspage},
- \l {15-qdoc-commands-navigation.html#startpage}{\\startpage}
+ \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
+ \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
+ \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage},
+ \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
+ \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
\section1 General Description
@@ -6108,7 +6108,7 @@
\code
/ *!
\page basicqt.html
- \contentspage {Basic Qt}{Contents}
+ \contentspage {Basic Qt} {Contents}
\nextpage Getting Started
\indexpage Index
@@ -6132,7 +6132,7 @@
/ *!
\page gettingstarted.html
\previouspage Basic Qt
- \contentspage {Basic Qt}{Contents}
+ \contentspage {Basic Qt} {Contents}
\nextpage Creating Dialogs
\indexpage Index
@@ -6148,7 +6148,7 @@
/ *!
\page creatingdialogs.html
\previouspage Getting Started
- \contentspage {Basic Qt}{Contents}
+ \contentspage {Basic Qt} {Contents}
\indexpage Index
\startpage Basic Qt
@@ -6212,8 +6212,8 @@
in creatingdialogs.html.
- In addition, the \l {indexpage}{\\indexpage} and \l
- {startpage}{\\startpage} commands specifies links to the page's
+ In addition, the \l {indexpage} {\\indexpage} and \l
+ {startpage} {\\startpage} commands specifies links to the page's
index page and start page. These links are used by browsers and
search engines.
@@ -6263,7 +6263,7 @@
page to the next page in an ordered series of documents}.
The command follows the same syntax and argument convention
- as the \l {previouspage}{\\previouspage} command.
+ as the \l {previouspage} {\\previouspage} command.
For an example, see the \l {General Description} section.
@@ -6289,7 +6289,7 @@
page to a contents page}.
The command follows the same syntax and argument convention
- as the \l {previouspage}{\\previouspage} command.
+ as the \l {previouspage} {\\previouspage} command.
For an example, see the \l {General Description} section.
@@ -6328,11 +6328,11 @@
\section1 Alphabetical List
- \l {16-qdoc-commands-status.html#compat}{\\compat},
- \l {16-qdoc-commands-status.html#internal}{\\internal},
- \l {16-qdoc-commands-status.html#obsolete}{\\obsolete},
- \l {16-qdoc-commands-status.html#preliminary}{\\preliminary},
- \l {16-qdoc-commands-status.html#since}{\\since}
+ \l {16-qdoc-commands-status.html#compat} {\\compat},
+ \l {16-qdoc-commands-status.html#internal} {\\internal},
+ \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
+ \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
+ \l {16-qdoc-commands-status.html#since} {\\since}
\section1 Command Description
@@ -6483,7 +6483,7 @@
library.} It is provided to keep old source code
working. We strongly advise against using it in new
code. See the \l
- {http://qt.nokia.com/doc/4.0/porting4.html}{Porting
+ {http://qt.nokia.com/doc/4.0/porting4.html} {Porting
Guide} for more information.
\endquotation
@@ -6602,18 +6602,18 @@
...
See also \l
- {QStyle::standardIconImplementation()}{standardIconImplementation()}
- and \l {QStyle::standardPixmap()}{standardPixmap()}.
+ {QStyle::standardIconImplementation()} {standardIconImplementation()}
+ and \l {QStyle::standardPixmap()} {standardPixmap()}.
\endquotation
QDoc generates the "Qt" reference from the \l
- {25-qdoc-configuration-derivedprojects.html#project}{\c
+ {25-qdoc-configuration-derivedprojects.html#project} {\c
project} configuration variable. For that reason this
reference will change according to the current
documentation project.
See also \l
- {25-qdoc-configuration-derivedprojects.html#project}{\c
+ {25-qdoc-configuration-derivedprojects.html#project} {\c
project}.
\endtable
@@ -6632,9 +6632,9 @@
\section1 Alphabetical List
- \l {17-qdoc-commands-thread.html#nonreentrant}{\\nonreentrant},
- \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant},
- \l {17-qdoc-commands-thread.html#threadsafe}{\\threadsafe}
+ \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
+ \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
+ \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
\section1 General Description
@@ -6654,10 +6654,10 @@
invocation references shared data.
When a class is declared \c reentrant or \c threadsafe, using the
- \l {reentrant}{\\reentrant} and \l {threadsafe}{\\threadsafe}
+ \l {reentrant} {\\reentrant} and \l {threadsafe} {\\threadsafe}
commands respectively, functions in the referenced class can be
declared \c nonreentrant, using the \l
- {nonreentrant}{\\nonreentrant} command, excluding the functions
+ {nonreentrant} {\\nonreentrant} command, excluding the functions
from the general view.
For example:
@@ -6715,8 +6715,8 @@
\endcode
\bold {Note:} All the functions in this class are \l
- {threads.html#reentrant}{reentrant}, except \l
- {QLocale::setDefault()}{setDefault()}.
+ {threads.html#reentrant} {reentrant}, except \l
+ {QLocale::setDefault()} {setDefault()}.
...
@@ -6742,8 +6742,8 @@
\warning This function is not reentrant.
- See also \l {QLocale::system()}{system()} and \l
- {QLocale::c()}{c()}.
+ See also \l {QLocale::system()} {system()} and \l
+ {QLocale::c()} {c()}.
...
\endquotation
@@ -6751,7 +6751,7 @@
As shown above, QDoc generates a notification when a class is
declared reentrant, and lists the exceptions (the declared
nonreentrant functions). A link to the general documentation on \l
- {threads.html#reentrant}{reentrancy and thread-safety} is
+ {threads.html#reentrant} {reentrancy and thread-safety} is
included. In addition a warning, "\bold Warning: This function is
not reentrant.", is generated in the nonreentrant functions'
documentation.
@@ -6760,7 +6760,7 @@
is declared threadsafe.
For more information see the general documentation on \l
- {threads.html#reentrant}{reentrancy and thread-safety}.
+ {threads.html#reentrant} {reentrancy and thread-safety}.
\section1 Command Descriptions
@@ -6780,11 +6780,11 @@
The generated documentation resulting from using the
\\threadsafe command is similar to the result of using the
- \l {reentrant}{\\reentrant} command. For an example, see
+ \l {reentrant} {\\reentrant} command. For an example, see
the \l {General Description} section.
- See also \l{reentrant}{\\reentrant} and
- \l{nonreentrant}{\\nonreentrant}.
+ See also \l{reentrant} {\\reentrant} and
+ \l{nonreentrant} {\\nonreentrant}.
\row
\o \bold \\reentrant \target reentrant
@@ -6797,8 +6797,8 @@
For an example, see the \l {General Description} section.
- See also \l{nonreentrant}{\\nonreentrant} and
- \l{threadsafe}{\\threadsafe}.
+ See also \l{nonreentrant} {\\nonreentrant} and
+ \l{threadsafe} {\\threadsafe}.
\row
\o \bold \\nonreentrant \target nonreentrant
@@ -6810,8 +6810,8 @@
For an example, see the \l {General Description} section.
- See also \l{reentrant}{\\reentrant} and
- \l{threadsafe}{\\threadsafe}.
+ See also \l{reentrant} {\\reentrant} and
+ \l{threadsafe} {\\threadsafe}.
\endtable
*/
@@ -6831,9 +6831,9 @@
\section1 Alphabetical List
- \l {18-qdoc-commands-relating.html#overload}{\\overload},
- \l {18-qdoc-commands-relating.html#reimp}{\\reimp},
- \l {18-qdoc-commands-relating.html#relates}{\\relates},
+ \l {18-qdoc-commands-relating.html#overload} {\\overload},
+ \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
+ \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
\section1 Command Descriptions
@@ -6893,7 +6893,7 @@
</h3>
\endraw
- This function overloads \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction}{addAction()}
+ This function overloads \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction} {addAction()}
This convenience function creates a new action with an
\i icon and some \i text. The function adds the newly
@@ -6946,7 +6946,7 @@
documentation.
\row
- \o \bold \\relates \target relates
+ \o \bold \\relates \target relates-command
\o \bold {The \\relates command attaches the documentation of
a global function to that of a related class or header file.}
@@ -6990,9 +6990,9 @@
\section1 Alphabetical List
- \l {19-qdoc-commands-grouping.html#ingroup}{\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule}{\\inmodule},
- \l {19-qdoc-commands-grouping.html#mainclass}{\\mainclass},
+ \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
+ \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule},
+ \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
\section1 Command Descriptions
@@ -7002,7 +7002,7 @@
\o Description
\row
- \o \bold \\mainclass \target mainclass
+ \o \bold \\mainclass \target mainclass-command
\o \bold {The \\mainclass command relates the documented class to
a group called mainclasses.}
@@ -7025,15 +7025,15 @@
will ensure that the QWidget class is included in the \c
mainclasses group, which means, for example, that the class
will appear on the list created by calling the \l
- {generatelist}{\\generatelist} command with the \c
+ {generatelist-command} {\\generatelist} command with the \c
mainclasses argument:
\l http://qt.nokia.com/doc/4.0/mainclasses.html
- See also \l {generatelist}{\\generatelist}.
+ See also \l {generatelist-command} {\\generatelist}.
\row
- \o \bold \\ingroup \target ingroup
+ \o \bold \\ingroup \target ingroup-command
\o \bold {The \\ingroup command indicates that the given
overview or documented class belongs to a certain group of
@@ -7059,15 +7059,15 @@
will ensure that the QDir class is included in the \c io
group, which means, for example, that QDir will appear on
- the list created by calling the \l {group}{\\group} command
+ the list created by calling the \l {group-command} {\\group} command
with the \c io argument.
Note that to list overviews that are related to a given
group, you must generate the list exlicitly by using the \l
- {generatelist}{\\generatelist} command with the \c related
+ {generatelist-command} {\\generatelist} command with the \c related
argument.
- See also \l {group}{\\group}.
+ See also \l {group-command} {\\group}.
\row
\o \bold \\inmodule \target inmodule
\o \bold {The \\inmodule command relates the documented class
@@ -7093,11 +7093,11 @@
will ensure that the QDesignerTaskMenuExtension class is
included in the \c QtDesigner module, which means, for
example, that the class will appear on the list created by
- calling the \l {generatelist}{\\generatelist} command with
+ calling the \l {generatelist-command} {\\generatelist} command with
the \c {{classesbymodule QtDesigner}} argument.
- See also \l {module}{\\module} and \l
- {generatelist}{\\generatelist}.
+ See also \l {module} {\\module} and \l
+ {generatelist-command} {\\generatelist}.
\endtable
*/
@@ -7116,8 +7116,8 @@
\section1 Alphabetical List
- \l {20-qdoc-commands-title.html#title}{\\title},
- \l {20-qdoc-commands-title.html#subtitle}{\\subtitle}
+ \l {20-qdoc-commands-title.html#title} {\\title},
+ \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
\section1 Command Descriptions
@@ -7162,7 +7162,7 @@
...
\endquotation
- See also \l {subtitle}{\\subtitle}.
+ See also \l {subtitle} {\\subtitle}.
\row
\o \bold \\subtitle \target subtitle
@@ -7201,7 +7201,7 @@
...
\endquotation
- See also \l {title}{\\title}.
+ See also \l {title} {\\title}.
\endtable
*/
@@ -7286,45 +7286,45 @@
\section2 Alphabetical List
- \l {22-qdoc-configuration-generalvariables.html#alias}{alias},
+ \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
{Cpp.ignoredirectives},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
{Cpp.ignoretokens},
- \l {22-qdoc-configuration-generalvariables.html#definesvariable}{defines},
- \l {22-qdoc-configuration-generalvariables.html#edition}{edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs}{exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples}{examples},
+ \l {22-qdoc-configuration-generalvariables.html#definesvariable} {defines},
+ \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
+ \l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
+ \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages}{extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods}{falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs}{headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers}{headers},
+ \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
+ \l {22-qdoc-configuration-generalvariables.html#falsehoods} {falsehoods},
+ \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
+ \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
\l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
{headers.fileextensions},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer}{HTML.footer},
+ \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
\l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
{HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style}{HTML.style},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs}{imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images}{images},
+ \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
+ \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
+ \l {22-qdoc-configuration-generalvariables.html#images} {images},
\l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
{images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language}{language},
- \l {22-qdoc-configuration-generalvariables.html#macro}{macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
+ \l {22-qdoc-configuration-generalvariables.html#language} {language},
+ \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
+ \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
\l {22-qdoc-configuration-generalvariables.html#outputformats}
{outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow}{slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources}{sources},
+ \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
+ \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
+ \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
\l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
{sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious}{spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize}{tabsize},
- \l {22-qdoc-configuration-generalvariables.html#version}{version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym}{versionsym}
+ \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
+ \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
+ \l {22-qdoc-configuration-generalvariables.html#version} {version},
+ \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
\section2 Categories
@@ -7378,40 +7378,40 @@
\section1 Alphabetical List
- \l {22-qdoc-configuration-generalvariables.html#alias}{alias},
- \l {22-qdoc-configuration-generalvariables.html#codeindent}{codeindent},
- \l {22-qdoc-configuration-generalvariables.html#definesvariable}{defines},
- \l {22-qdoc-configuration-generalvariables.html#edition}{edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs}{exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples}{examples},
+ \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
+ \l {22-qdoc-configuration-generalvariables.html#codeindent} {codeindent},
+ \l {22-qdoc-configuration-generalvariables.html#definesvariable} {defines},
+ \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
+ \l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
+ \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages}{extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods}{falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#generateindex}{generateindex},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs}{headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers}{headers},
+ \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
+ \l {22-qdoc-configuration-generalvariables.html#falsehoods} {falsehoods},
+ \l {22-qdoc-configuration-generalvariables.html#generateindex} {generateindex},
+ \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
+ \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
\l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
{headers.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs}{imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images}{images},
+ \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
+ \l {22-qdoc-configuration-generalvariables.html#images} {images},
\l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
{images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language}{language},
- \l {22-qdoc-configuration-generalvariables.html#macro}{macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
+ \l {22-qdoc-configuration-generalvariables.html#language} {language},
+ \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
+ \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
\l {22-qdoc-configuration-generalvariables.html#outputformats}
{outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow}{slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources}{sources},
+ \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
+ \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
+ \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
\l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
{sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious}{spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize}{tabsize},
- \l {22-qdoc-configuration-generalvariables.html#tagfile}{tagfile},
- \l {22-qdoc-configuration-generalvariables.html#version}{version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym}{versionsym}
+ \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
+ \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
+ \l {22-qdoc-configuration-generalvariables.html#tagfile} {tagfile},
+ \l {22-qdoc-configuration-generalvariables.html#version} {version},
+ \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
\section1 Variable Descriptions
@@ -7438,7 +7438,7 @@
The \c alias variable is often used for compatibility
reasons; for more information see the \l {QDoc
- Compatibility}{compatibility section}.
+ Compatibility} {compatibility section}.
See also \l macro.
@@ -7450,7 +7450,7 @@
QDoc originally used a hard-coded value of four spaces for
code indentation to ensure that code snippets could be easily
distinguished from surrounding text. Since we can use
- \l{HTML Specific Configuration Variables#HTML.stylesheets}{stylesheets} to
+ \l{HTML Specific Configuration Variables#HTML.stylesheets} {stylesheets} to
adjust the appearance of certain types of HTML elements, this
level of indentation is not always required.
@@ -7460,7 +7460,7 @@
symbols that QDoc will recognize and respond to.}
When a preprocessor symbol is specified using the \c
- defines variable, you can also use the \l {if}{\\if}
+ defines variable, you can also use the \l {if-command} {\\if}
command to enclose documentation that only will be included
if the preprocessor symbol is defined.
@@ -7508,7 +7508,7 @@
consoleedition preprocessor symbol is defined when QDoc
processes the source files defined in the qt.qdocconf file.
- See also \l falsehoods and \l {if}{\\if}.
+ See also \l falsehoods and \l {if-command} {\\if}.
\row
\o \bold edition \target edition
@@ -7533,7 +7533,7 @@
In the above examples, the \c Console edition only includes
the contents of four modules. Only the classes from these
modules will be used when the
- \l{Miscellaneous Commands#generatelist}{generatelist} command
+ \l{Miscellaneous Commands#generatelist-command} {generatelist} command
is used to generate a list of classes for this edition:
\code
@@ -7545,12 +7545,12 @@
\o \bold {The \c exampledirs variable specifies the directories
containing the source code of the example files.}
- The \l {examples}{\c examples} and \c exampledirs variables
- are used by the \l {quotefromfile}{\\quotefromfile}, \l
- {quotefile}{\\quotefile} and \l {example}{\\example}
- commands. If both the \l {examples}{\c examples} and \c
+ The \l {examples} {\c examples} and \c exampledirs variables
+ are used by the \l {quotefromfile-command} {\\quotefromfile}, \l
+ {quotefile-command} {\\quotefile} and \l {example} {\\example}
+ commands. If both the \l {examples} {\c examples} and \c
exampledirs variables are defined, QDoc will search in
- both, first in \l {examples}{\c examples} then in \c
+ both, first in \l {examples} {\c examples} then in \c
exampledirs.
QDoc will search through the directories in the specified
@@ -7576,7 +7576,7 @@
\endcode
QDoc will then see if there exists a file called \c
- calculator.cpp listed as a value in the \l {examples}{\c
+ calculator.cpp listed as a value in the \l {examples} {\c
examples} variable. If it doesn't, it will search in the \c
exampledirs variable, and first see if there exists a file
called
@@ -7600,22 +7600,22 @@
\o \bold examples \target examples
\o \bold {The \c examples variable allows you to specify individual
example files in addition to those located in the directories
- specified by the \l {exampledirs}{\c exampledirs} variable.}
+ specified by the \l {exampledirs} {\c exampledirs} variable.}
- The \c examples and \l {exampledirs}{\c exampledirs}
+ The \c examples and \l {exampledirs} {\c exampledirs}
variables are used by the \l
- {quotefromfile}{\\quotefromfile}, \l
- {quotefile}{\\quotefile} and \l {example}{\\example}
- commands. If both the \c examples and \l {exampledirs}{\c
+ {quotefromfile-command} {\\quotefromfile}, \l
+ {quotefile-command} {\\quotefile} and \l {example} {\\example}
+ commands. If both the \c examples and \l {exampledirs} {\c
exampledirs} variables are defined, QDoc will search in
- both, first in \c examples then in \l {exampledirs}{\c
+ both, first in \c examples then in \l {exampledirs} {\c
exampledirs}.
QDoc will search through the values listed for the \c
examples variable, in the specified order, and accept
the first one it finds.
- For an extensive example, see the \l {exampledirs}{\c
+ For an extensive example, see the \l {exampledirs} {\c
exampledirs} command. But note that if you know the file is
listed in the \c examples variable, you don't need to
specify its path:
@@ -7652,7 +7652,7 @@
QDoc will not recognize images used within HTML (or any
other markup language). If we want the images to be copied
- from the directories specified by \l {imagedirs}{\c
+ from the directories specified by \l {imagedirs} {\c
imagedirs} (the images in question must be located in these
directories) to the output directory, we must specify the
images using the \c extraimages variable.
@@ -7739,29 +7739,29 @@
\endcode
When executed, the first QDoc will do is to read through
- the headers specified in the \l {headers}{\c headers}
+ the headers specified in the \l {headers} {\c headers}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
classes and their functions.
Then it will read through the sources specified in the \l
- {sources}{\c sources}, and the ones located in the
- directories specified in the \l {sourcedirs}{\c sourcedirs}
+ {sources} {\c sources}, and the ones located in the
+ directories specified in the \l {sourcedirs} {\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
If both the \c headers and \c headerdirs variables are
- defined, QDoc will read through both, first \l {headers}{\c
+ defined, QDoc will read through both, first \l {headers} {\c
headers} then \c headerdirs.
In the specified directories, QDoc will only read the files
with the fileextensions specified in the \l
- {headers.fileextensions}{\c headers.fileextensions}
+ {headers.fileextensions} {\c headers.fileextensions}
variable. The default extensions are *.ch, *.h, *.h++,
*.hh, *.hpp and *.hxx". The files specified by \l
- {headers}{\c headers} will be read independent of their
+ {headers} {\c headers} will be read independent of their
fileextensions.
See also \l headers and \l headers.fileextensions.
@@ -7770,7 +7770,7 @@
\o \bold headers \target headers
\o \bold {The \c headers variable allows you to specify individual
header files in addition to those located in the directories
- specified by the \l {headerdirs}{\c headerdirs} variable.}
+ specified by the \l {headerdirs} {\c headerdirs} variable.}
For example:
@@ -7780,9 +7780,9 @@
\endcode
When processing the \c headers variable, QDoc behaves in the
- same way as it does when processing the \l {headerdirs}{\c
+ same way as it does when processing the \l {headerdirs} {\c
headerdirs} variable. For more information, see the \l
- {headerdirs}{\c headerdirs} variable.
+ {headerdirs} {\c headerdirs} variable.
See also \l headerdirs.
@@ -7792,7 +7792,7 @@
extension used by the headers.}
When processing the header files specified in the \l
- {headerdirs}{\c headerdirs} variable, QDoc will only read
+ {headerdirs} {\c headerdirs} variable, QDoc will only read
the files with the fileextensions specified in the \c
headers.fileextensions variable. In this way QDoc avoid
spending time reading irrelevant files.
@@ -7817,11 +7817,11 @@
\o \bold {The \c imagedirs variable specifies the directories
containing the images used in the documentation.}
- The \l {images}{\c images} and \c imagedirs variables are
- used by the \l {image}{\\image} and \l
- {inlineimage}{\\inlineimage} commands. If both the \l
- {images}{\c images} and \c imagedirs variables are defined,
- QDoc will search in both, first in \l {images}{\c images}
+ The \l {images} {\c images} and \c imagedirs variables are
+ used by the \l {image} {\\image} and \l
+ {inlineimage-command} {\\inlineimage} commands. If both the \l
+ {images} {\c images} and \c imagedirs variables are defined,
+ QDoc will search in both, first in \l {images} {\c images}
then in \c imagedirs.
QDoc will search through the directories in the specified
@@ -7860,13 +7860,13 @@
\endcode
You can filter the images in an image directory using the
- \l {images.fileextensions}{\c images.fileextensions}
+ \l {images.fileextensions} {\c images.fileextensions}
variable. The general idea behind the \l
- {images.fileextensions}{\c images.fileextensions} variable
+ {images.fileextensions} {\c images.fileextensions} variable
is to enable different image format for different output
format.
- \warning The \l {images.fileextensions}{\c
+ \warning The \l {images.fileextensions} {\c
images.fileextensions} variable's functionality is
preliminay since QDoc at this point only support HTML.
@@ -7876,7 +7876,7 @@
\o \bold images \target images
\o \bold {The \c images variable allows you to specify individual
image files in addition to those located in the directories
- specified by the \l {imagedirs}{\c imagedirs} variable.}
+ specified by the \l {imagedirs} {\c imagedirs} variable.}
For example:
@@ -7885,9 +7885,9 @@
\endcode
When processing the \c images variable, QDoc behaves in the
- same way as it does when processing the \l {imagedirs}{\c
+ same way as it does when processing the \l {imagedirs} {\c
imagedirs} variable. For more information, see the \l
- {imagedirs}{\c imagedirs} variable.
+ {imagedirs} {\c imagedirs} variable.
See also \l imagedirs and \l images.fileextensions.
@@ -7908,8 +7908,8 @@
images.fileextensions.LOUT = *.eps
\endcode
- Then, when processing the \l {image}{\\image} and \l
- {inlineimage}{\\inlineimage} commands, QDoc will only
+ Then, when processing the \l {image} {\\image} and \l
+ {inlineimage-command} {\\inlineimage} commands, QDoc will only
search for files with extensions specified in the output
format's associated image extension variable.
@@ -7982,8 +7982,8 @@
it generates, using the \c lang and \c xml:lang attributes.
See also \l sourceencoding, \l outputencoding,
- \l{http://www.w3.org/TR/xhtml1/#C_7}{C.7. The lang and xml:lang Attributes} and
- \l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290}{Best Practice 13: Using Hans and Hant codes}.
+ \l{http://www.w3.org/TR/xhtml1/#C_7} {C.7. The lang and xml:lang Attributes} and
+ \l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290} {Best Practice 13: Using Hans and Hant codes}.
\row
\o \bold outputdir \target outputdir
@@ -8085,28 +8085,28 @@
\endcode
When executed, the first QDoc will do is to read through
- the headers specified in the \l {header}{\c header}
+ the headers specified in the \l {header} {\c header}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
classes and their functions.
Then it will read through the sources specified in the \l
- {sources}{\c sources}, and the ones located in the
- directories specified in the \l {sourcedirs}{\c sourcedirs}
+ {sources} {\c sources}, and the ones located in the
+ directories specified in the \l {sourcedirs} {\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
If both the \c sources and \c sourcedirs variables are
- defined, QDoc will read through both, first \l {sources}{\c
+ defined, QDoc will read through both, first \l {sources} {\c
sources} then \c sourcedirs.
In the specified directories, QDoc will only read the files
with the fileextensions specified in the \l
- {sources.fileextensions}{\c sources.fileextensions}
+ {sources.fileextensions} {\c sources.fileextensions}
variable. The default extensions are *.c++, *.cc, *.cpp and
- *.cxx. The files specified by \l {sources}{\c sources} will
+ *.cxx. The files specified by \l {sources} {\c sources} will
be read independent of their fileextensions.
See also \l sources and \l sources.fileextensions.
@@ -8139,7 +8139,7 @@
\o \bold sources \target sources
\o \bold {The \c sources variable allows you to specify
individual source files in addition to those located in the
- directories specified by the \l {sourcedir}{\c sourcedir}
+ directories specified by the \l {sourcedir} {\c sourcedir}
variable.}
For example:
@@ -8150,9 +8150,9 @@
\endcode
When processing the \c sources variable, QDoc behaves in the
- same way as it does when processing the \l {sourcedirs}{\c
+ same way as it does when processing the \l {sourcedirs} {\c
sourcedirs} variable. For more information, see the \l
- {sourcedirs}{\c sourcedirs} variable.
+ {sourcedirs} {\c sourcedirs} variable.
See also \l sourcedirs.
@@ -8162,7 +8162,7 @@
files within a source directory.}
When processing the source files specified in the \l
- {sourcedirs}{\c sourcedirs} variable, QDoc will only read
+ {sourcedirs} {\c sourcedirs} variable, QDoc will only read
the files with the fileextensions specified in the \c
sources.fileextensions variable. In this way QDoc avoid
spending time reading irrelevant files.
@@ -8271,7 +8271,7 @@
\warning The \\version command's functionality is not fully
implemented; currently it only works within raw HTML code.
- See also \l {version}{\\version}.
+ See also \l {version} {\\version}.
\endtable
*/
@@ -8498,11 +8498,11 @@
\section1 Alphabetical List
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer}{HTML.footer},
+ \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
\l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
{HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style}{HTML.style},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.stylesheets}{HTML.stylesheets}
+ \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
+ \l {24-qdoc-configuration-htmlvariables.html#HTML.stylesheets} {HTML.stylesheets}
\section1 Variable Descriptions
@@ -8535,7 +8535,7 @@
The complete variable entry in \l qt.qdocconf provides the
standard footer of the \l
- {http://qt.nokia.com/doc/4.0/index.html}{Qt Reference
+ {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
\row
@@ -8564,7 +8564,7 @@
The complete variable entry in \l qt.qdocconf provides the
standard header of the \l
- {http://qt.nokia.com/doc/4.0/index.html}{Qt Reference
+ {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
\row
@@ -8590,7 +8590,7 @@
\endcode
provides the HTML style for the \l
- {http://qt.nokia.com/doc/4.0/index.html}{Qt Reference
+ {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
\row
@@ -8633,10 +8633,10 @@
\section2 Alphabetical List
- \l{25-qdoc-configuration-derivedprojects.html#description}{description},
- \l{25-qdoc-configuration-derivedprojects.html#indexes}{indexes},
- \l{25-qdoc-configuration-derivedprojects.html#project}{project},
- \l{25-qdoc-configuration-derivedprojects.html#url}{url}
+ \l{25-qdoc-configuration-derivedprojects.html#description} {description},
+ \l{25-qdoc-configuration-derivedprojects.html#indexes} {indexes},
+ \l{25-qdoc-configuration-derivedprojects.html#project} {project},
+ \l{25-qdoc-configuration-derivedprojects.html#url} {url}
\section2 Variable Descriptions
@@ -8803,16 +8803,16 @@
A compat.qdocconf file is a separate \c .qdocconf file which you
can include in your main configuration file. It typically contains
the mapping between old and new commands using the \l alias and \l
- {22-qdoc-configuration-generalvariables.html#macro}{macro}
+ {22-qdoc-configuration-generalvariables.html#macro} {macro}
configuration variables.
\section1 Qt Compatibility
In Qt's documentation there still exist occurrences of old
- commands, and the Qt \l {qt.qdocconf}{configuration file} needs to
+ commands, and the Qt \l {qt.qdocconf} {configuration file} needs to
include the compat.qdocconf file tailored for Qt. For more
detailed information about the commands creating compatibility
- issues, see the \l {Command Comments}{command comments}.
+ issues, see the \l {Command Comments} {command comments}.
\section2 Qt's current compat.qdocconf file
@@ -8836,7 +8836,7 @@
\\e command name.
\bold {We still need to use the \\e command to render in
- italic in new documentation for \l {reason}{compatibility
+ italic in new documentation for \l {reason} {compatibility
reasons}}.
\row
@@ -8850,7 +8850,7 @@
\bold {We still need to use the \\input command to include
plain text in new documentation for \l
- {reason}{compatibility reasons}}.
+ {reason} {compatibility reasons}}.
\row
\o \\quotefile \target quotefile-versus-include
@@ -8863,7 +8863,7 @@
\bold {We still need to use the \\include command to quote
the entire contents of a source file in new documentation
- for \l {reason}{compatibility reasons}}.
+ for \l {reason} {compatibility reasons}}.
\row
\o \\quotefromfile \target quotefromfile-versus-quotefile
@@ -8873,7 +8873,7 @@
that command to quote an entire file, we introduce the new
\\quotefromfile command to quote from file.
- \bold {Use \l {quotefromfile}{\\quotefromfile} to quote
+ \bold {Use \l {quotefromfile-command} {\\quotefromfile} to quote
parts from a source file in new documentation}.
\row
@@ -8884,7 +8884,7 @@
in italic instead, we introduce the new \\o command for
this purpose.
- \bold {Use \l {o}{\\o} to indicate list and table items in
+ \bold {Use \l {o} {\\o} to indicate list and table items in
new documentation}.
\row
@@ -8893,7 +8893,7 @@
\o These commands are equivalent, and represent a simple name
change.
- \bold {Use \l {quotation}{\\quotation} in new
+ \bold {Use \l {quotation} {\\quotation} in new
documentation}.
\row
@@ -8902,7 +8902,7 @@
\o These commands are equivalent, and represent a simple name
change.
- \bold {Use \l {image}{\\image} in new documentation}.
+ \bold {Use \l {image} {\\image} in new documentation}.
\endtable
*/
@@ -8916,104 +8916,104 @@
\list
- \o \l {04-qdoc-commands-textformatting.html#a}{\\a}
- \o \l {11-qdoc-commands-documentcontents.html#abstract}{\\abstract}
- \o \l {06-qdoc-commands-verbatimcode.html#badcode}{\\badcode}
- \o \l {04-qdoc-commands-textformatting.html#bold}{\\bold}
- \o \l {11-qdoc-commands-documentcontents.html#brief}{\\brief}
- \o \l {04-qdoc-commands-textformatting.html#c}{\\c}
- \o \l {09-qdoc-commands-graphic.html#caption}{\\caption}
- \o \l {05-qdoc-commands-documentstructuring.html#chapter}{\\chapter}
- \o \l {13-qdoc-commands-topical.html#class}{\\class}
- \o \l {06-qdoc-commands-verbatimcode.html#code}{\\code}
- \o \l {07-0-qdoc-commands-quoting.html#codeline}{\\codeline},
- \o \l {16-qdoc-commands-status.html#compat}{\\compat}
- \o \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage}
- \o \l {04-qdoc-commands-textformatting.html#div}{\\div} \span {class="newStuff"} {(new)}
- \o \l {07-0-qdoc-commands-quoting.html#dots}{\\dots}
- \o \l {12-0-qdoc-commands-miscellaneous.html#else}{\\else}
- \o \l {12-0-qdoc-commands-miscellaneous.html#endif}{\\endif}
- \o \l {13-qdoc-commands-topical.html#enum}{\\enum}
- \o \l {13-qdoc-commands-topical.html#example-command}{\\example}
- \o \l {12-0-qdoc-commands-miscellaneous.html#expire}{\\expire}
- \o \l {13-qdoc-commands-topical.html#externalpage}{\\externalpage}
- \o \l {13-qdoc-commands-topical.html#fn}{\\fn}
- \o \l {11-qdoc-commands-documentcontents.html#footnote}{\\footnote}
- \o \l {12-0-qdoc-commands-miscellaneous.html#generatelist}{\\generatelist}
- \o \l {13-qdoc-commands-topical.html#group}{\\group}
- \o \l {10-qdoc-commands-container.html#header}{\\header}
- \o \l {13-qdoc-commands-topical.html#headerfile}{\\headerfile}
- \o \l {04-qdoc-commands-textformatting.html#i}{\\i}
- \o \l {12-0-qdoc-commands-miscellaneous.html#if}{\\if}
- \o \l {09-qdoc-commands-graphic.html#image}{\\image}
- \o \l {12-0-qdoc-commands-miscellaneous.html#include}{\\include}
- \o \l {15-qdoc-commands-navigation.html#indexpage}{\\indexpage}
- \o \l {19-qdoc-commands-grouping.html#ingroup}{\\ingroup}
- \o \l {19-qdoc-commands-grouping.html#inmodule}{\\inmodule}
- \o \l {09-qdoc-commands-graphic.html#inlineimage}{\\inlineimage}
- \o \l {16-qdoc-commands-status.html#internal}{\\internal}
- \o \l {08-qdoc-commands-linking.html#keyword}{\\keyword}
- \o \l {08-qdoc-commands-linking.html#l}{\\l}
- \o \l {11-qdoc-commands-documentcontents.html#legalese}{\\legalese}
- \o \l {10-qdoc-commands-container.html#list}{\\list}
- \o \l {13-qdoc-commands-topical.html#macro}{\\macro}
- \o \l {19-qdoc-commands-grouping.html#mainclass}{\\mainclass}
- \o \l {12-0-qdoc-commands-miscellaneous.html#meta}{\\meta}
- \o \l {13-qdoc-commands-topical.html#module}{\\module}
- \o \l {13-qdoc-commands-topical.html#namespace}{\\namespace}
- \o \l {15-qdoc-commands-navigation.html#nextpage}{\\nextpage}
- \o \l {06-qdoc-commands-verbatimcode.html#newcode}{\\newcode}
- \o \l {17-qdoc-commands-thread.html#nonreentrant}{\\nonreentrant}
- \o \l {10-qdoc-commands-container.html#o}{\\o}
- \o \l {16-qdoc-commands-status.html#obsolete}{\\obsolete}
- \o \l {06-qdoc-commands-verbatimcode.html#oldcode}{\\oldcode}
- \o \l {12-0-qdoc-commands-miscellaneous.html#omit}{\\omit}
- \o \l {10-qdoc-commands-container.html#omitvalue}{\\omitvalue}
- \o \l {18-qdoc-commands-relating.html#overload}{\\overload}
- \o \l {13-qdoc-commands-topical.html#page}{\\page}
- \o \l {05-qdoc-commands-documentstructuring.html#part}{\\part}
- \o \l {16-qdoc-commands-status.html#preliminary}{\\preliminary}
- \o \l {15-qdoc-commands-navigation.html#previouspage}{\\previouspage}
- \o \l {07-0-qdoc-commands-quoting.html#printline}{\\printline}
- \o \l {07-0-qdoc-commands-quoting.html#printto}{\\printto}
- \o \l {07-0-qdoc-commands-quoting.html#printuntil}{\\printuntil}
- \o \l {13-qdoc-commands-topical.html#property}{\\property}
- \o \l {11-qdoc-commands-documentcontents.html#quotation}{\\quotation}
- \o \l {07-0-qdoc-commands-quoting.html#quotefile}{\\quotefile}
- \o \l {07-0-qdoc-commands-quoting.html#quotefromfile}{\\quotefromfile}
- \o \l {12-0-qdoc-commands-miscellaneous.html#raw}{\\raw} \span {class="newStuff"} {(avoid)}
- \o \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant}
- \o \l {18-qdoc-commands-relating.html#reimp}{\\reimp}
- \o \l {18-qdoc-commands-relating.html#relates}{\\relates}
- \o \l {10-qdoc-commands-container.html#row}{\\row}
- \o \l {08-qdoc-commands-linking.html#sa}{\\sa}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionOne}{\\section1}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionTwo}{\\section2}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionThree}{\\section3}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionFour}{\\section4}
- \o \l {13-qdoc-commands-topical.html#service}{\\service}
- \o \l {16-qdoc-commands-status.html#since}{\\since}
- \o \l {07-0-qdoc-commands-quoting.html#skipline}{\\skipline}
- \o \l {07-0-qdoc-commands-quoting.html#skipto}{\\skipto}
- \o \l {07-0-qdoc-commands-quoting.html#skipuntil}{\\skipuntil}
- \o \l {07-0-qdoc-commands-quoting.html#snippet}{\\snippet},
- \o \l {04-qdoc-commands-textformatting.html#span}{\\span} \span {class="newStuff"} {(new)}
- \o \l {15-qdoc-commands-navigation.html#startpage}{\\startpage}
- \o \l {04-qdoc-commands-textformatting.html#sub}{\\sub}
- \o \l {20-qdoc-commands-title.html#subtitle}{\\subtitle}
- \o \l {04-qdoc-commands-textformatting.html#sup}{\\sup}
- \o \l {10-qdoc-commands-container.html#table}{\\table}
+ \o \l {04-qdoc-commands-textformatting.html#a} {\\a}
+ \o \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract}
+ \o \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode}
+ \o \l {04-qdoc-commands-textformatting.html#bold} {\\bold}
+ \o \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief}
+ \o \l {04-qdoc-commands-textformatting.html#c} {\\c}
+ \o \l {09-qdoc-commands-graphic.html#caption} {\\caption}
+ \o \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter}
+ \o \l {13-qdoc-commands-topical.html#class-command} {\\class}
+ \o \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code}
+ \o \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
+ \o \l {16-qdoc-commands-status.html#compat} {\\compat}
+ \o \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage}
+ \o \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)}
+ \o \l {07-0-qdoc-commands-quoting.html#dots} {\\dots}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif}
+ \o \l {13-qdoc-commands-topical.html#enum-command} {\\enum}
+ \o \l {13-qdoc-commands-topical.html#example-command} {\\example}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire}
+ \o \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage}
+ \o \l {13-qdoc-commands-topical.html#fn} {\\fn}
+ \o \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist}
+ \o \l {13-qdoc-commands-topical.html#group-command} {\\group}
+ \o \l {10-qdoc-commands-container.html#header} {\\header}
+ \o \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile}
+ \o \l {04-qdoc-commands-textformatting.html#i} {\\i}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if}
+ \o \l {09-qdoc-commands-graphic.html#image} {\\image}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include}
+ \o \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage}
+ \o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
+ \o \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule}
+ \o \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
+ \o \l {16-qdoc-commands-status.html#internal} {\\internal}
+ \o \l {08-qdoc-commands-linking.html#keyword} {\\keyword}
+ \o \l {08-qdoc-commands-linking.html#l} {\\l}
+ \o \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese}
+ \o \l {10-qdoc-commands-container.html#list} {\\list}
+ \o \l {13-qdoc-commands-topical.html#macro} {\\macro}
+ \o \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta}
+ \o \l {13-qdoc-commands-topical.html#module} {\\module}
+ \o \l {13-qdoc-commands-topical.html#namespace} {\\namespace}
+ \o \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage}
+ \o \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode}
+ \o \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant}
+ \o \l {10-qdoc-commands-container.html#o} {\\o}
+ \o \l {16-qdoc-commands-status.html#obsolete} {\\obsolete}
+ \o \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit}
+ \o \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue}
+ \o \l {18-qdoc-commands-relating.html#overload} {\\overload}
+ \o \l {13-qdoc-commands-topical.html#page} {\\page}
+ \o \l {05-qdoc-commands-documentstructuring.html#part} {\\part}
+ \o \l {16-qdoc-commands-status.html#preliminary} {\\preliminary}
+ \o \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage}
+ \o \l {07-0-qdoc-commands-quoting.html#printline} {\\printline}
+ \o \l {07-0-qdoc-commands-quoting.html#printto} {\\printto}
+ \o \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil}
+ \o \l {13-qdoc-commands-topical.html#property} {\\property}
+ \o \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation}
+ \o \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile}
+ \o \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)}
+ \o \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant}
+ \o \l {18-qdoc-commands-relating.html#reimp} {\\reimp}
+ \o \l {18-qdoc-commands-relating.html#relates-command} {\\relates}
+ \o \l {10-qdoc-commands-container.html#row} {\\row}
+ \o \l {08-qdoc-commands-linking.html#sa} {\\sa}
+ \o \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1}
+ \o \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2}
+ \o \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3}
+ \o \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
+ \o \l {13-qdoc-commands-topical.html#service} {\\service}
+ \o \l {16-qdoc-commands-status.html#since} {\\since}
+ \o \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline}
+ \o \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto}
+ \o \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil}
+ \o \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
+ \o \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)}
+ \o \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
+ \o \l {04-qdoc-commands-textformatting.html#sub} {\\sub}
+ \o \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
+ \o \l {04-qdoc-commands-textformatting.html#sup} {\\sup}
+ \o \l {10-qdoc-commands-container.html#table} {\\table}
\o \l {11-qdoc-commands-documentcontents.html#tableofcontents}
{\\tableofcontents}
- \o \l {08-qdoc-commands-linking.html#target}{\\target}
- \o \l {17-qdoc-commands-thread.html#threadsafe}{\\threadsafe}
- \o \l {20-qdoc-commands-title.html#title}{\\title}
- \o \l {04-qdoc-commands-textformatting.html#tt}{\\tt}
- \o \l {13-qdoc-commands-topical.html#typedef}{\\typedef}
- \o \l {04-qdoc-commands-textformatting.html#underline}{\\underline}
- \o \l {13-qdoc-commands-topical.html#variable}{\\variable}
- \o \l {10-qdoc-commands-container.html#value}{\\value}
- \o \l {11-qdoc-commands-documentcontents.html#warning}{\\warning}
+ \o \l {08-qdoc-commands-linking.html#target} {\\target}
+ \o \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
+ \o \l {20-qdoc-commands-title.html#title} {\\title}
+ \o \l {04-qdoc-commands-textformatting.html#tt} {\\tt}
+ \o \l {13-qdoc-commands-topical.html#typedef} {\\typedef}
+ \o \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
+ \o \l {13-qdoc-commands-topical.html#variable} {\\variable}
+ \o \l {10-qdoc-commands-container.html#value-command} {\\value}
+ \o \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
\endlist
*/
--
cgit v0.12
From 6bb1ae3cddce24a4d69198b38040afcb44cd4cd4 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 31 Jan 2011 15:19:35 +0100
Subject: qdoc: Fixed numerous broken links in the qdoc manual.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 88 ++++++++++++++++++++--------------------
1 file changed, 45 insertions(+), 43 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 51ada06..dd65769 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -2207,7 +2207,7 @@
\o \c {\l <QtGlobal>} - a defined \l {headerfile} {\\headerfile}
\o \c {\l widgets/wiggly} - a defined
\l {example-command} {\\example}
- \o \c {\l {QWidget Class Reference}} - a defined \l {title} {\\title}
+ \o \c {\l {QWidget Class Reference}} - a defined \l {title-command} {\\title}
\o \c {\l {Introduction}}- a defined \l{part} {\\part},
\l{chapter} {\\chapter} or \l {sectionOne} {\\section...}
\o \c {\l fontmatching} - a defined \l {target} {\\target}
@@ -3452,10 +3452,10 @@
The \\brief command can be used in two significant
different ways: \l {brief class} {One for classes,
- namespaces and header files}, and \l {brief property} {one
+ namespaces and header files}, and \l {brief-property} {one
for properties and variables}.
- \target brief property
+ \target brief-property
When the \\brief command is used to describe a property or
a variable, the brief text must only be a sentence fragment
@@ -4042,7 +4042,7 @@
determined by its location, i.e. its directory. However,
for extensions, like ActiveQt and Qt Designer, a class
is related to a module with the \l
- {inmodule} {\\inmodule} command.
+ {inmodule-command} {\\inmodule} command.
\o \c classesbyedition
@@ -4291,7 +4291,7 @@
This QDoc comment will only be rendered if the \c
opensourceedition preprocessor symbol is defined, and
- specified in the \l {definesvariable} {defines} variable in
+ specified in the \l {defines-variable} {defines} variable in
the configuration file to make QDoc process
the code within #ifdef and #endif:
@@ -4301,10 +4301,11 @@
You can also define the preprocessor symbol manually on the
command line. For more information see the documentation of
- the \l {definesvariable} {defines} variable.
+ the \l {defines-variable} {defines} variable.
See also \l{endif} {\\endif}, \l{else} {\\else}, \l
- {definesvariable} {defines} and \l falsehoods.
+ {defines-variable} {defines} and \l {falsehoods-variable}
+ {falsehoods}.
\row
\o \bold \\endif \target endif
@@ -4317,7 +4318,7 @@
{if-command} {\\if} command.
See also \l{if-command} {\\if}, \l{else} {\\else}, \l
- {definesvariable} {defines} and \l falsehoods.
+ {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}.
\row
\o \bold \\else \target else
@@ -4414,7 +4415,8 @@
\endquotation
See also \l{if-command} {\\if}, \l{endif} {\\endif}, \l
- {definesvariable} {defines} and \l falsehoods.
+ {defines-variable} {defines} and \l {falsehoods-variable}
+ {falsehoods}.
\row
\o \bold \\include \target include
@@ -5163,7 +5165,7 @@
The command follows \l {topical argument} {the general
topical command convention} for the argument. The \\group
- command is typically followed by a \l {title} {\\title}
+ command is typically followed by a \l {title-command} {\\title}
command and a short introduction to the group. The
generated HTML documentation for the specified group is put
in <lower-case>\i{group}.html.
@@ -5436,7 +5438,7 @@
...
- See also \l {Meta-Object System}, \l {Signals and
+ See also \l {Meta-Object System}, \l {Signals &
Slots} and \l {Qt's Property System}.
\endquotation
@@ -5452,13 +5454,13 @@
topical command convention} for the argument.
A class can be related to a module using the \l
- {inmodule} {\\inmodule} command.
+ {inmodule-command} {\\inmodule} command.
The \\module command is typically followed by the \l
- {title} {\\title} and \l {brief-command} {\\brief} commands. Each
- class is listed with a link to the class reference page and
- a brief description based on the classes' \l
- {brief-command} {\\brief} texts.
+ {title-command} {\\title} and \l {brief-command} {\\brief}
+ commands. Each class is listed with a link to the class
+ reference page and a brief description based on the
+ classes' \l {brief-command} {\\brief} texts.
For example:
@@ -5545,7 +5547,7 @@
in qtnetwork.html.
- See also \l {inmodule} {\\inmodule}
+ See also \l {inmodule-command} {\\inmodule}
\row
\o \bold \\namespace \target namespace
@@ -5619,7 +5621,7 @@
The command follows \l {topical argument} {the general
topical command convention} for the argument.
- The page's title can be set using the \l {title} {\\title}
+ The page's title can be set using the \l {title-command} {\\title}
command. For example:
\code
@@ -5729,9 +5731,9 @@
property, the \l {brief-command} {\\brief} command's
argument is a sentence fragment that will be included in a
one-sentence description of the property generated by
- QDoc. The command follows the same rules for the \l {brief
- property} {description} as the \l {variable} {\\variable}
- command.
+ QDoc. The command follows the same rules for the
+ \l {brief-property} {description} as the \l {variable}
+ {\\variable} command.
For example:
@@ -5929,11 +5931,11 @@
The command follows \l {topical argument} {the general
topical command convention} for the argument.
- The \\variable command is typically followed by a \l
- {brief-command} {\\brief} command; QDoc will generate the
- documentation for the variable based on the brief-command
- description. The command follows the same rules for the \l
- {brief property} {description} as the \l {property}
+ The \\variable command is typically followed by a
+ \l {brief-command} {\\brief} command; QDoc will generate the
+ documentation for the variable based on the brief command
+ description. The command follows the same rules for the
+ \l {brief-property} {description} as the \l {property}
{\\property} command.
The documentation will be located in the in the associated
@@ -6052,7 +6054,7 @@
\l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
\l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
\l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule},
+ \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
\l {16-qdoc-commands-status.html#internal} {\\internal},
\l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
\l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage},
@@ -6066,7 +6068,7 @@
\l {18-qdoc-commands-relating.html#relates-command} {\\relates},
\l {15-qdoc-commands-navigation.html#startpage} {\\startpage},
\l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe},
- \l {20-qdoc-commands-title.html#title} {\\title}
+ \l {20-qdoc-commands-title.html#title-command} {\\title}
\section1 Categories
\list
@@ -6991,7 +6993,7 @@
\section1 Alphabetical List
\l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule},
+ \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
\l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
\section1 Command Descriptions
@@ -7069,7 +7071,7 @@
See also \l {group-command} {\\group}.
\row
- \o \bold \\inmodule \target inmodule
+ \o \bold \\inmodule \target inmodule-command
\o \bold {The \\inmodule command relates the documented class
to the module specified by the command's argument.}
@@ -7116,7 +7118,7 @@
\section1 Alphabetical List
- \l {20-qdoc-commands-title.html#title} {\\title},
+ \l {20-qdoc-commands-title.html#title-command} {\\title},
\l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
\section1 Command Descriptions
@@ -7127,7 +7129,7 @@
\o Description
\row
- \o \bold \\title \target title
+ \o \bold \\title \target title-command
\o \bold {The \\title command sets the title for a
documentation page, or allows you to override it.}
@@ -7137,7 +7139,7 @@
/ *!
\page signalandslots.html
- \title Signals and Slots
+ \title Signals & Slots
Signals and slots are used for communication between
objects. The signals and slots mechanism is a central
@@ -7201,7 +7203,7 @@
...
\endquotation
- See also \l {title} {\\title}.
+ See also \l {title-command} {\\title}.
\endtable
*/
@@ -7291,14 +7293,14 @@
{Cpp.ignoredirectives},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
{Cpp.ignoretokens},
- \l {22-qdoc-configuration-generalvariables.html#definesvariable} {defines},
+ \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
\l {22-qdoc-configuration-generalvariables.html#edition} {edition},
\l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods} {falsehoods},
+ \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
\l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
\l {22-qdoc-configuration-generalvariables.html#headers} {headers},
\l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
@@ -7380,14 +7382,14 @@
\l {22-qdoc-configuration-generalvariables.html#alias} {alias},
\l {22-qdoc-configuration-generalvariables.html#codeindent} {codeindent},
- \l {22-qdoc-configuration-generalvariables.html#definesvariable} {defines},
+ \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
\l {22-qdoc-configuration-generalvariables.html#edition} {edition},
\l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods} {falsehoods},
+ \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
\l {22-qdoc-configuration-generalvariables.html#generateindex} {generateindex},
\l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
\l {22-qdoc-configuration-generalvariables.html#headers} {headers},
@@ -7455,7 +7457,7 @@
level of indentation is not always required.
\row
- \o \bold defines \target definesvariable
+ \o \bold defines \target defines-variable
\o \bold {The \c defines variable specifies the C++ preprocessor
symbols that QDoc will recognize and respond to.}
@@ -7508,7 +7510,7 @@
consoleedition preprocessor symbol is defined when QDoc
processes the source files defined in the qt.qdocconf file.
- See also \l falsehoods and \l {if-command} {\\if}.
+ See also \l {falsehoods-variable} {falsehoods} and \l {if-command} {\\if}.
\row
\o \bold edition \target edition
@@ -7672,7 +7674,7 @@
See also \l images and \l imagedirs.
\row
- \o \bold falsehoods \target falsehoods
+ \o \bold falsehoods \target falsehoods-variable
\o \bold {The \c falsehoods variable defines the truth value of
specified preprocessor symbols as false.}
@@ -8949,7 +8951,7 @@
\o \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include}
\o \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage}
\o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
- \o \l {19-qdoc-commands-grouping.html#inmodule} {\\inmodule}
+ \o \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule}
\o \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
\o \l {16-qdoc-commands-status.html#internal} {\\internal}
\o \l {08-qdoc-commands-linking.html#keyword} {\\keyword}
@@ -9007,7 +9009,7 @@
{\\tableofcontents}
\o \l {08-qdoc-commands-linking.html#target} {\\target}
\o \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
- \o \l {20-qdoc-commands-title.html#title} {\\title}
+ \o \l {20-qdoc-commands-title.html#title-command} {\\title}
\o \l {04-qdoc-commands-textformatting.html#tt} {\\tt}
\o \l {13-qdoc-commands-topical.html#typedef} {\\typedef}
\o \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
--
cgit v0.12
From d543e008d7654c1642e4accafd6c670d514999f9 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 1 Feb 2011 12:03:11 +0100
Subject: qdoc: Updated the qdoc manual.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 329 ++++++---------------------------------
tools/qdoc3/htmlgenerator.cpp | 4 +
2 files changed, 48 insertions(+), 285 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index dd65769..533e730 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -1118,57 +1118,10 @@
\endquotation
Each section level is a logical unit within the
- document. Its title will appear on the table of contents
- generated by the \l
- {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents} command. For example:
-
- \code
- / *!
- Contents:
-
- \tableofcontents
-
- ...
- * /
- \endcode
-
- will expand to
-
- \quotation
- \raw HTML
- <p>Contents:</p>
-
- <ul>
- <li><a href="#Basic Qt">Basic Qt</a></li>
- <ul>
- <li><a href="#Getting Started">Getting Started</a></li>
- <ul>
- <li><a href="#Hello Qt">Hello Qt</a></li>
- <li><a href="#Making Connections">
- Making Connections</a></li>
- <li><a href="#Using the Reference Documentation">
- Using the Reference Documentation</a></li>
- </ul>
- <li><a href="#Creating Dialogs">Creating Dialogs</a></li>
- <ul>
- <li><a href="#Subclassing QDialog">
- Subclassing QDialog</a></li>
- </ul>
- </ul>
- <li><a href="#Intermediate Qt">Intermediate Qt</a></li>
- <ul>
- <li><a href="#Layout Management">
- Layout Management</a></li>
- <ul>
- <li><a href="#Basic Layouts">Basic Layouts</a></li>
- </ul>
- </ul>
- </ul>
-
- ...
- \endraw
- \endquotation
+ document. Its title will appear in the table of contents
+ automatically generated by QDoc. The automatically
+ generated table of contents appears in the upper
+ righthand corner of the page.
\row
\o \bold \\chapter \target chapter
@@ -3181,33 +3134,9 @@
The abstract section is rendered as an indented italicized
paragraph.
- \warning This is preliminary funcionality. The
- command is not fully implemented. Currently, the abstract
- section is rendered as a regular HTML paragraph. For
- example:
-
- \code
- / *!
- \abstract
- Qt by Trolltech is a C++ toolkit for cross-platform
- GUI application development. Qt provides
- single-source portability across Microsoft Windows,
- Mac OS X, Linux, and all major commercial Unix
- variants. It is also available for embedded
- devices.
- \endabstract
- * /
- \endcode
-
- will be rendered as
-
- \abstract
- Qt by Trolltech is a C++ toolkit for cross-platform GUI
- application development. Qt provides single-source
- portability across Microsoft Windows, Mac OS X, Linux,
- and all major commercial Unix variants. It is also
- available for embedded devices.
- \endabstract
+ \warning The \bold{\\abstract} and \bold{\\endabstract} commands
+ have not been implemented. The abstract section is rendered as a
+ regular HTML paragraph.
\row
\o \bold \\quotation \target quotation
@@ -3258,187 +3187,19 @@
\o \bold {The \\footnote command and the corresponding
\\endfootnote command delimit a footnote.}
- The footnote follows the standard conventions, rendered at the
- bottom of the page.
+ The footnote is rendered at the bottom of the page.
- \warning This is preliminary funcionality. The
- command is not fully implemented.
-
- For example:
-
- \code
- / *!
- In Qt 4 we have tried to simplify the constructors of
- QObject/QWidget subclasses. This makes subclassing
- easier, at the same time as it helps make the Qt
- library more efficient.
-
- \footnote
- Constructors no longer take a "const char *name"
- parameter. If you want to specify a name for a QObject,
- you must call QObject::setObjectName() after
- construction. The object name is now a QString.
- \endfootnote
-
- QWidget's WFlags data type has been split in two:
- Qt::WindowFlags specifies low-level window flags (the
- type of window and the frame style), whereas
- Qt::WidgetAttribute specifies various higher-level
- attributes about the widget (e.g.,
- WA_StaticContents).
- * /
- \endcode
-
- will be rendered as
-
- \quotation
- In Qt 4 we have tried to simplify the constructors of
- QObject/QWidget subclasses. This makes subclassing
- easier, at the same time as it helps make the Qt
- library more efficient.
-
- \footnote
- Constructors no longer take a "const char *name"
- parameter. If you want to specify a name for a QObject,
- you must call QObject::setObjectName() after
- construction. The object name is now a QString.
- \endfootnote
-
- QWidget's WFlags data type has been split in two:
- Qt::WindowFlags specifies low-level window flags (the
- type of window and the frame style), whereas
- Qt::WidgetAttribute specifies various higher-level
- attributes about the widget (e.g.,
- WA_StaticContents).
- \endquotation
+ \warning The \bold{\\footnote} and \bold{\\endfootnote}
+ commands have not been implemented. The footnote is
+ rendered as a regular HTML paragraph.
\row
\o \bold \\tableofcontents \target tableofcontents
- \o \bold {The \\tableofcontents command generates a
- table displaying the titles of the current documentation
- unit's parts, chapters, sections, etc.}
-
- The command accepts a single optional argument:
-
- \code
- \tableofcontents sectionN
- \endcode
-
- where \c sectionN is the deepest section to include (by
- default all sections are included).
-
- For example, it the documentation unit's structure looks
- something like this:
-
- \quotation
- \raw HTML
- <a name="Basic Qt">
- <h1>Basic Qt</h1>
- </a>
- <p>This is the first part.</p>
-
- <a name="Getting started">
- <h2>Getting Started</h2>
- </a>
- This is the first part's first chapter.</p>
-
- <a name="Hello Qt">
- <h3>Hello Qt</h3>
- </a>
- <p>This is the first chapter's first section.</p>
-
- <a name="Making Connections">
- <h3>Making Connections</h3>
- </a>
- <p>This is the first chapter's second section.</p>
-
- <a name="Using the Reference Documentation">
- <h3>Using the Reference Documentation</h3>
- </a>
- <p>This is the first chapter's third section.</p>
-
- <a name="Creating Dialogs">
- <h2>Creating Dialogs</h2>
- </a>
- <p>This is the first part's second chapter.</p>
-
- <a name="Subclassing QDialog">
- <h3>Subclassing QDialog</h3>
- </a>
- <p>This is the second chapter's first section.</p>
-
- ...
-
- <a name="Intermediate Qt">
- <h1>Intermediate Qt</h1>
- </a>
- <p>This is the second part.</p>
-
- <a name="Layout Management">
- <h2>Layout Management</h2>
- </a>
- <p>This is the second part's first chapter.</p>
-
- <a name="Basic Layouts">
- <h3>Basic Layouts</h3>
- </a>
- <p>This is the first chapter's first section.</p>
-
- ...
-
- \endraw
- \endquotation
-
- Then
-
- \code
- / *!
- Contents:
-
- \tableofcontents
+ \o \bold {The \\tableofcontents command has been disabled because QDoc
+ now generates a table of contents automatically.}
- ...
- * /
- \endcode
-
- will expand to
-
- \quotation
- \raw HTML
- <p>Contents:</p>
-
- <ul>
- <li><a href="#Basic Qt">Basic Qt</a></li>
- <ul>
- <li><a href="#Getting Started">Getting Started</a></li>
- <ul>
- <li><a href="#Hello Qt">Hello Qt</a></li>
- <li><a href="#Making Connections">
- Making Connections</a></li>
- <li><a href="#Using the Reference Documentation">
- Using the Reference Documentation</a></li>
- </ul>
- <li><a href="#Creating Dialogs">Creating Dialogs</a></li>
- <ul>
- <li><a href="#Subclassing QDialog">
- Subclassing QDialog</a></li>
- </ul>
- </ul>
- <li><a href="#Intermediate Qt">Intermediate Qt</a></li>
- <ul>
- <li><a href="#Layout Management">Layout Management</a></li>
- <ul>
- <li><a href="#Basic Layouts">Basic Layouts</a></li>
- </ul>
- </ul>
- </ul>
-
- ...
- \endraw
- \endquotation
-
- Each table entry becomes a link to the corresponding part,
- chapter or section.
+ The automatically generated table of contents appears in the upper
+ righthand corner of the page.
\row
\o \bold \\brief \target brief-command
@@ -3888,7 +3649,7 @@
\code
/ *!
\page classes.html
- \title All Qt Classes (main index)
+ \title All Classes
For a shorter list that only includes the most
frequently used classes, see \l{Qt's Main Classes}. For
@@ -3899,7 +3660,7 @@
* /
\endcode
- is used to generate \l {All Qt Classes (main index)}.
+ is used to generate \l {All Classes}.
The command accepts the following arguments:
@@ -4188,7 +3949,7 @@
{page} {\\page} and \l {group-command} {\\group}. The list omits
examples and classes, and only lists the first page of
documentation that contains two or more pages using
- commands like \l {nextpage} {\\nextpage}.
+ commands like \l {nextpage-command} {\\nextpage}.
For example:
@@ -5061,15 +4822,15 @@
The command follows \l {topical argument} {the general
topical command convention} for the argument. In particular
the command's argument is the example's path relative to
- the paths listed in the \l exampledirs configuration
- variable.
+ the paths listed in the \l {exampledirs-variable}
+ {exampledirs} configuration variable.
The documentation will be located in \i
{path-to-example}.html, and QDoc will add a list of all the
example files at the top of this documentation page.
- For example, if \l exampledirs contain \c
- $QTDIR/examples/widgets/imageviewer, then
+ For example, if \l {exampledirs-variable} {exampledirs}
+ contains \c $QTDIR/examples/widgets/imageviewer, then
\code
/ *!
@@ -6057,7 +5818,7 @@
\l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
\l {16-qdoc-commands-status.html#internal} {\\internal},
\l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
- \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage},
+ \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
\l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
\l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
\l {18-qdoc-commands-relating.html#overload} {\\overload},
@@ -6098,7 +5859,7 @@
\l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
\l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
- \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage},
+ \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
\l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
\l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
@@ -6260,7 +6021,7 @@
Description} section.
\row
- \o \bold \\nextpage \target nextpage
+ \o \bold \\nextpage \target nextpage-command
\o \bold {The \\nextpage command links the current
page to the next page in an ordered series of documents}.
@@ -7295,7 +7056,7 @@
{Cpp.ignoretokens},
\l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
\l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
+ \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
@@ -7384,7 +7145,7 @@
\l {22-qdoc-configuration-generalvariables.html#codeindent} {codeindent},
\l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
\l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs} {exampledirs},
+ \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples} {examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
@@ -7543,7 +7304,7 @@
\endcode
\row
- \o \bold exampledirs \target exampledirs
+ \o \bold exampledirs \target exampledirs-variable
\o \bold {The \c exampledirs variable specifies the directories
containing the source code of the example files.}
@@ -7602,31 +7363,29 @@
\o \bold examples \target examples
\o \bold {The \c examples variable allows you to specify individual
example files in addition to those located in the directories
- specified by the \l {exampledirs} {\c exampledirs} variable.}
+ specified by the \l {exampledirs-variable} {\c exampledirs} variable.}
- The \c examples and \l {exampledirs} {\c exampledirs}
- variables are used by the \l
- {quotefromfile-command} {\\quotefromfile}, \l
- {quotefile-command} {\\quotefile} and \l {example} {\\example}
- commands. If both the \c examples and \l {exampledirs} {\c
- exampledirs} variables are defined, QDoc will search in
- both, first in \c examples then in \l {exampledirs} {\c
- exampledirs}.
+ The \c examples and \l {exampledirs-variable} {\c exampledirs}
+ variables are used by the \l {quotefromfile-command} {\\quotefromfile},
+ \l {quotefile-command} {\\quotefile} and \l {example}
+ {\\example} commands. If both the \c examples and \l {exampledirs-variable}
+ {\c exampledirs} variables are defined, QDoc will search in both, first in
+ \c examples then in \l {exampledirs-variable} {\c exampledirs}.
- QDoc will search through the values listed for the \c
- examples variable, in the specified order, and accept
- the first one it finds.
+ QDoc will search through the values listed for the \c examples
+ variable, in the specified order, and accept the
+ first one it finds.
- For an extensive example, see the \l {exampledirs} {\c
- exampledirs} command. But note that if you know the file is
- listed in the \c examples variable, you don't need to
- specify its path:
+ For an extensive example, see the \l {exampledirs-variable}
+ {\c exampledirs} command. But note that if you know the file is
+ listed in the \c examples variable, you don't need to specify its
+ path:
\code
\quotefromfile calculator.cpp
\endcode
- See also \l exampledirs.
+ See also \l {exampledirs-variable} {exampledirs}.
\row
\o \bold examples.fileextensions \target examples.fileextensions
@@ -8963,7 +8722,7 @@
\o \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta}
\o \l {13-qdoc-commands-topical.html#module} {\\module}
\o \l {13-qdoc-commands-topical.html#namespace} {\\namespace}
- \o \l {15-qdoc-commands-navigation.html#nextpage} {\\nextpage}
+ \o \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage}
\o \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode}
\o \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant}
\o \l {10-qdoc-commands-container.html#o} {\\o}
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 1623ea8..63e43d2 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -410,6 +410,10 @@ int HtmlGenerator::generateAtom(const Atom *atom,
switch (atom->type()) {
case Atom::AbstractLeft:
+ if (relative)
+ relative->doc().location().warning(tr("\abstract is not implemented."));
+ else
+ Location::information(tr("\abstract is not implemented."));
break;
case Atom::AbstractRight:
break;
--
cgit v0.12
From dbcd9010be5dc92a7a9d15badf008fbdb9871007 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 16 Feb 2011 08:45:34 +0100
Subject: qdoc: Updated the qdoc manual and its config file.
---
doc/src/template/style/style.css | 2 +-
tools/qdoc3/doc/qdoc-manual.qdoc | 3812 ++++++++++++++++------------------
tools/qdoc3/doc/qdoc-manual.qdocconf | 110 +-
tools/qdoc3/htmlgenerator.cpp | 20 +-
4 files changed, 1867 insertions(+), 2077 deletions(-)
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index 06de245..58ef13b 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -7,7 +7,7 @@
color: #000000;
background: #FFFFFF;
}
- body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, code, form, fieldset, legend, input, button, textarea, p, blockquote, th, td
+ body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, code, form, fieldset, legend, input, button, textarea, p, th, td
{
margin: 0;
padding: 0;
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 533e730..12d0085 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -27,364 +27,226 @@
/*!
\page index.html
- \nextpage Introduction
+ \nextpage Introduction to QDoc
\title Table of Contents
\list
- \o \l{Introduction}
- \o \l{QDoc Commands}
- \list
- \o \l{Markup Commands}
- \o \l{Text Formatting Commands} \span {class="newStuff"} {(new commands)}
- \o \l{Document Structuring Commands}
- \o \l{Verbatim Code Commands}
- \o \l{Quoting External Code Commands}
- \list
- \o \l{Example File}
- \endlist
- \o \l{Linking Commands}
- \o \l{Graphic Commands}
- \o \l{Container Commands}
- \o \l{Document Contents Commands}
- \o \l{Miscellaneous Commands}
- \list
- \o \l{signalandslots.qdocinc}
- \o \l{objectmodel.qdocinc}
- \o \l{layoutmanagement.qdocinc}
- \endlist
- \o \l{Topical Commands}
- \o \l{Contextual Commands}
- \o \l{Navigation Commands}
- \o \l{Status Commands}
- \o \l{Thread Support Commands}
- \o \l{Relating Commands}
- \o \l{Grouping Commands}
- \o \l{Title Commands}
- \endlist
- \o \l{QDoc Configuration}
- \list
- \o \l{General Configuration Variables}
- \o \l{Creating Help Project Files}
- \o \l{C++ Specific Configuration Variables}
- \o \l{HTML Specific Configuration Variables}
- \o \l{Supporting Derived Projects}
- \o \l{QDoc Compatibility}
- \o \l{qt.qdocconf}
- \o \l{minimum.qdocconf}
- \endlist
- \o \l{QDoc Commands - Alphabetical List}
+ \o \l {Introduction to QDoc}
+ \o \l {The QDoc Commands}
+ \list
+ \o \l {Topic Commands}
+ \o \l {Context Commands}
+ \list
+ \o \l {Navigating}
+ \o \l {Reporting Status}
+ \o \l {Thread Support}
+ \o \l {Relating Things}
+ \o \l {Grouping Things}
+ \o \l {Naming Things}
+ \endlist
+ \o \l{Markup Commands}
+ \list
+ \o \l {Text Markup} \span {class="newStuff"} {(new: div & span)}
+ \o \l {Document Structure}
+ \o \l {Including Code Inline}
+ \o \l {Including External Code}
+ \o \l {Creating Links}
+ \o \l {Including Images}
+ \o \l {Tables and Lists}
+ \o \l {Special Content}
+ \o \l {Miscellaneous}
+ \endlist
+ \endlist
+ \o \l {The QDoc Configuration File}
+ \list
+ \o \l {General Configuration Variables}
+ \o \l {Creating Help Project Files}
+ \o \l {C++ Specific Configuration Variables}
+ \o \l {HTML Specific Configuration Variables}
+ \o \l {Supporting Derived Projects}
+ \o \l {Compatibility Issues}
+ \o \l {qt.qdocconf}
+ \o \l {minimum.qdocconf}
+ \endlist
\endlist
+
*/
/*!
\page 01-qdoc-manual.html
\contentspage Table of Contents
\previouspage Table of Contents
- \nextpage QDoc Commands
-
- \title Introduction
-
- QDoc is the internal tool used by Qt Development Frameworks for generating
- documentation. This document is a reference for QDoc command syntax and
- configuration.
-
- \section1 Overview
-
- \list I
- \o \section2 \l {QDoc Commands}
-
- \l {QDoc Commands - Alphabetical List} {A complete alphabetical
- list}.
-
- There are two main categories of commands for QDoc: markup
- commands and meta-commands.
-
- The markup commands indicate the generated documentation's
- appearance and logical structure. The meta-commands provide
- information about the document as well as the documented
- item. The meta-commands can be further categorized as topical
- commands and contextual commands.
-
- \list
- \o \l {Markup Commands}
- \list
- \o \l {Text Formatting Commands} {Text Formatting} \span {class="newStuff"} {(new commands)}
- \o \l {Document Structuring Commands} {Document Structuring}
- \o \l {Verbatim Code Commands} {Verbatim Code}
- \o \l {Quoting External Code Commands} {Quoting External Code}
- \o \l {Linking Commands} {Linking}
- \o \l {Graphic Commands} {Graphic}
- \o \l {Container Commands} {Container}
- \o \l {Document Contents Commands} {Document Contents}
- \o \l {Miscellaneous Commands} {Miscellaneous}
- \endlist
- \o \l {Topical Commands}
- \o \l {Contextual Commands}
- \list
- \o \l {Navigation Commands} {Navigation}
- \o \l {Status Commands} {Status}
- \o \l {Thread Support Commands} {Thread Support}
- \o \l {Relating Commands} {Relating}
- \o \l {Grouping Commands} {Grouping}
- \o \l {Title Commands} {Title}
- \endlist
- \endlist
- \endlist
-
- \list II
- \o \section2 \l {QDoc Configuration}
-
- When running QDoc to generate the documentation, you must
- specify a configuration file on the command line. The
- configuration file is a list of entries of entries of the form
- "variable = value".
-
- \list
- \o \l {Configuration Variables}
- \o \l {Configuration File Examples}
- \endlist
-
- Some particular configuration variables allow you to use QDoc
- to support Qt-based projects; i.e to make projects, such as Qt
- Solutions, contain references to the online Qt documentation.
+ \nextpage The QDoc Commands
- \list
- \o \l {Supporting Derived Projects}
- \endlist
-
- QDoc is a tool that constantly evolves to suit our needs, for
- that reason there are some compatibility issues between old and
- new practices.
-
- \list
- \o \l {QDoc Compatibility}
- \endlist
- \endlist
-*/
+ \title Introduction to QDoc
-/*!
- \page 02-qdoc-commands.html
- \previouspage Introduction
- \contentspage Table of Contents
- \nextpage Markup Commands
+ QDoc is a tool used by Qt Developers to extract \e {qdoc comments}
+ from a set of source files and format them for output as HTML
+ pages or as DITA XML files.. This manual explains how to use the
+ QDoc commands and how to create a QDoc configuration file.
- \title QDoc Commands
+ \section1 Running QDoc
- There are two main categories of commands for QDoc: markup
- commands and meta-commands.
+ QDoc is currently called \c {qdoc3}. To run qdoc3, use the command
+ line:
- The markup commands indicate the generated documentation's visual
- appearance and logical structure. The meta-commands provide
- information about the documentation unit as well as the documented
- item. The meta-commands can be further categorized as topical
- commands and contextual commands.
+ \quotation
+ \bold {/currentdirectory$ qdoc3 config.qdocconf}
+ \endquotation
- \section1 Alphabetical List
+ ...where config.qdocconf is your \l{The QDoc Configuration File}
+ {QDoc configuration file}. The main purpose of the configuration
+ file is to tell qdoc3 where to find the source files from which to
+ extract qdoc comments, what kind of output to generate (HTML, DITA
+ XML,...}, and where to put the output. The configuration file also
+ contains other information for qdoc3.
- A complete \l{QDoc Commands - Alphabetical List }
- {alphabetical list of the QDoc commands}.
+ \section1 Command Types
- \section1 Categories
+ QDoc interprets three types of commands:
\list
+ \o \l {Topic Commands}
+ \o \l {Context Commands}
\o \l {Markup Commands}
- \o \l {Topical Commands}
- \o \l {Contextual Commands}
\endlist
+
+ Topic commands identify the entity you are documenting, e.g. a C++
+ class, function, or type, an example, or an extra page of text
+ that doesn't map to any C++ entity.
+
+ Context commands tell QDoc how the entity being documented relates
+ to other documented entities, e.g. next and previous page links or
+ inclusion in page groups or library modules. They can also provide
+ information about the documented entity that QDoc can't get from
+ the source files, e.g. whether the entitity is thread-safe, an
+ overloaded or reimplemented function, or that it has been
+ deprecated.
+
+ Markup commands tell QDoc how text and image elements in the
+ document should be rendered or about the document's outline
+ structure.
*/
/*!
\page 03-qdoc-commands-markup.html
\contentspage Table of Contents
- \previouspage QDoc Commands
- \nextpage Text Formatting Commands
+ \previouspage Naming Things
+ \nextpage Text Markup
\title Markup Commands
The markup commands indicate the generated documentation's visual
appearance and logical structure.
- \section1 Alphabetical List
-
- \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
- \l {04-qdoc-commands-textformatting.html#a} {\\a},
- \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
- \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
- \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
- \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
- \l {04-qdoc-commands-textformatting.html#c} {\\c},
- \l {09-qdoc-commands-graphic.html#caption} {\\caption},
- \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
- \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
- \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
- \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
- \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
- \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
- \l {10-qdoc-commands-container.html#header} {\\header},
- \l {04-qdoc-commands-textformatting.html#i} {\\i},
- \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
- \l {09-qdoc-commands-graphic.html#image} {\\image},
- \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
- \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage},
- \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
- \l {08-qdoc-commands-linking.html#l} {\\l},
- \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
- \l {10-qdoc-commands-container.html#list} {\\list},
- \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
- \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
- \l {10-qdoc-commands-container.html#o} {\\o},
- \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode},
- \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
- \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
- \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
- \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
- \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
- \l {10-qdoc-commands-container.html#row} {\\row},
- \l {08-qdoc-commands-linking.html#sa} {\\sa},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4},
- \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
- \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
- \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
- \l {10-qdoc-commands-container.html#table} {\\table},
- \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents},
- \l {08-qdoc-commands-linking.html#target} {\\target},
- \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
- \l {04-qdoc-commands-textformatting.html#underline} {\\underline},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode},
- \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
+ \section2 Categories
+ \list
+ \o \l {Text Markup}
+ \o \l {Document Structure}
+ \o \l {Including Code Inline}
+ \o \l {Including External Code}
+ \o \l {Creating Links}
+ \o \l {Including Images}
+ \o \l {Tables and Lists}
+ \o \l {Special Content}
+ \o \l {Miscellaneous}
+ \endlist
- \section1 Categories
+ \section2 Command list
\list
- \o \l {Text Formatting Commands}
- \o \l {Document Structuring Commands}
- \o \l {Verbatim Code Commands}
- \o \l {Quoting External Code Commands}
- \o \l {Linking Commands}
- \o \l {Graphic Commands}
- \o \l {Container Commands}
- \o \l {Document Contents Commands}
- \o \l {Miscellaneous Commands}
+ \o \l {04-qdoc-commands-textmarkup.html#backslash-command} {\\\\}
+ \o \l {04-qdoc-commands-textmarkup.html#a-command} {\\a}
+ \o \l {11-qdoc-commands-specialcontent.html#abstract-command} {\\abstract}
+ \o \l {06-qdoc-commands-includecodeinline.html#badcode-command} {\\badcode}
+ \o \l {04-qdoc-commands-textmarkup.html#bold-command} {\\bold}
+ \o \l {11-qdoc-commands-specialcontent.html#brief-command} {\\brief}
+ \o \l {04-qdoc-commands-textmarkup.html#c-command} {\\c}
+ \o \l {09-qdoc-commands-includingimages.html#caption-command} {\\caption}
+ \o \l {05-qdoc-commands-documentstructure.html#chapter-command} {\\chapter}
+ \o \l {06-qdoc-commands-includecodeinline.html#code-command} {\\code}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#codeline-command} {\\codeline}
+ \o \l {04-qdoc-commands-textmarkup.html#div-command} {\\div} \span {class="newStuff"} {(new)}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#dots-command} {\\dots}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#else-command} {\\else}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#endif-command} {\\endif}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#expire-command} {\\expire}
+ \o \l {11-qdoc-commands-specialcontent.html#footnote-command} {\\footnote}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist}
+ \o \l {10-qdoc-commands-tablesandlists.html#header-command} {\\header}
+ \o \l {04-qdoc-commands-textmarkup.html#i-command} {\\i}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if}
+ \o \l {09-qdoc-commands-includingimages.html#image-command} {\\image}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#include-command} {\\include}
+ \o \l {09-qdoc-commands-includingimages.html#inlineimage-command} {\\inlineimage}
+ \o \l {08-qdoc-commands-creatinglinks.html#keyword-command} {\\keyword}
+ \o \l {08-qdoc-commands-creatinglinks.html#l-command} {\\l}
+ \o \l {11-qdoc-commands-specialcontent.html#legalese-command} {\\legalese}
+ \o \l {10-qdoc-commands-tablesandlists.html#list-command} {\\list}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#meta-command} {\\meta}
+ \o \l {06-qdoc-commands-includecodeinline.html#newcode-command} {\\newcode}
+ \o \l {10-qdoc-commands-tablesandlists.html#o-command} {\\o}
+ \o \l {06-qdoc-commands-includecodeinline.html#oldcode-command} {\\oldcode}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#omit-command} {\\omit}
+ \o \l {05-qdoc-commands-documentstructure.html#part-command} {\\part}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printline-command} {\\printline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printto-command} {\\printto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printuntil-command} {\\printuntil}
+ \o \l {11-qdoc-commands-specialcontent.html#quotation-command} {\\quotation}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefile-command} {\\quotefile}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\raw} \span {class="newStuff"} {(avoid)}
+ \o \l {10-qdoc-commands-tablesandlists.html#row-command} {\\row}
+ \o \l {08-qdoc-commands-creatinglinks.html#sa-command} {\\sa}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionOne-command} {\\section1}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionTwo-command} {\\section2}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionThree-command} {\\section3}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionFour-command} {\\section4}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipline-command} {\\skipline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipto-command} {\\skipto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipuntil-command} {\\skipuntil}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#snippet-command} {\\snippet}
+ \o \l {04-qdoc-commands-textmarkup.html#span-command} {\\span} \span {class="newStuff"} {(new)}
+ \o \l {04-qdoc-commands-textmarkup.html#sub-command} {\\sub}
+ \o \l {04-qdoc-commands-textmarkup.html#sup-command} {\\sup}
+ \o \l {10-qdoc-commands-tablesandlists.html#table-command} {\\table}
+ \o \l {11-qdoc-commands-specialcontent.html#tableofcontents-command} {\\tableofcontents}
+ \o \l {08-qdoc-commands-creatinglinks.html#target-command} {\\target}
+ \o \l {04-qdoc-commands-textmarkup.html#tt-command} {\\tt}
+ \o \l {04-qdoc-commands-textmarkup.html#underline-command} {\\underline}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\unicode}
+ \o \l {11-qdoc-commands-specialcontent.html#warning-command} {\\warning}
\endlist
*/
/*!
- \page 04-qdoc-commands-textformatting.html
+ \page 04-qdoc-commands-textmarkup.html
\contentspage Table of Contents
\previouspage Markup Commands
- \nextpage Document Structuring Commands
+ \nextpage Document Structure
- \title Text Formatting Commands
+ \title Text Markup
The text formatting commands indicate how the regular text in the
documentation is rendered.
- \section1 Alphabetical List
-
- \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
- \l {04-qdoc-commands-textformatting.html#a} {\\a},
- \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
- \l {04-qdoc-commands-textformatting.html#c} {\\c},
- \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#i} {\\i},
- \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
- \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
- \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
- \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
+ \section1 \\a (parameter marker)
+ \target a-command
- \section1 Command Descriptions
+ The \\a command indicates that the next word is a formal parameter name.
- \table
- \header
- \o Command
- \o Description
-
- \row
-
- \o \bold \\\\ \target backslash
- \o \bold {The \\\\ command expands to a single backslash.}
-
- QDoc commands always start with a backslash alone. To
- display an actual backslash in the text you need to type
- two of the kind. If you want to display two backslashes,
- you need to type four, and so forth. For example:
-
- \code
- / *!
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- * /
- \endcode
-
- will be rendered as
-
- \quotation
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- \endquotation
-
- However, if you want your text to appear in a typewriter
- font as well, you can use the \l {c} {\\c} command instead,
- which accepts and renders the backslash as any other
- character. For example:
-
- \code
- / *!
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- * /
- \endcode
-
- will be rendered as
-
- \quotation
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- \endquotation
-
- \row
- \o \bold \\a \target a
- \o \bold {The \\a command indicates that the next word
- is a parameter when documenting functions.}
-
- Warnings are emitted when function parameters are
- undocumented or misspelled, so whenever you write
- documentation for functions you should make sure you
- mention all the parameters and precede each of these by the
- \\a command. The parameter is then rendered in italic. For
- example:
+ A warning is emitted when a function parameter is not documented
+ or is misspelled, so when you document a function you should
+ mention each formal parameter name in the function description,
+ preceded by the \\a command. The parameter is then rendered in
+ italics. For example:
\code
/ *!
Constructs a line edit containing the text
- \a contents.
-
- The \a parent parameter is sent to the
- QWidget constructor.
+ \a contents. The \a parent parameter is sent
+ to the QWidget constructor.
* /
QLineEdit::QLineEdit(const QString &contents, QWidget *parent)
@@ -395,31 +257,29 @@
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {QLineEdit::QLineEdit ( const QString &
contents, QWidget *parent )}
Constructs a line edit containing the text \a contents.
-
- The \a parent parameter is sent to the QWidget
- constructor.
-
+ The \a parent parameter is sent to the QWidget constructor.
\endquotation
The \\a command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument. However, a parameter
is always a single word, so braces are rarely
necessary. And for the same reason, parentheses seldom
occur.
- \row
- \o \bold \\c \target c
- \o \bold {The \\c command can be used to render variables,
- user-defined classes and C++ keywords like \c int,
- \c for, etc.}
+ \section1 \\c (code font)
+ \target c-command
+
+ The \\c command is used for rendering variable names, user-defined
+ class names, and C++ keywords, like \c int and \c for in a
+ code font.
The command renders its argument using a typewriter font. For
example:
@@ -432,7 +292,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The \c AnalogClock class provides a clock widget with hour
@@ -441,21 +301,22 @@
\endquotation
The \\c command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
The \\c command accepts the special character \c \ within
its argument, i.e. it renders it as a normal character. So
if you want to use nested commands, you must use the \l
- {tt} {teletype (\\tt)} command instead.
+ {tt-command} {teletype (\\tt)} command instead.
- See also \l {tt} {\\tt} and \l {code-command} {\\code}.
+ See also \l {tt-command} {\\tt} and \l {code-command} {\\code}.
- \row
- \o \bold \\div \span {class="newStuff"} {(new)} \target div
- \o \bold {The \\div command and the corresponding \\enddiv
- command delimit a large or small block of text and qdoc
- commands for which special formatting attributes apply.}
+ \section1 \\div \span {class="newStuff"} {(new)}
+ \target div-command
+
+ The \\div command and the corresponding \\enddiv
+ command delimit a large or small block of text and qdoc
+ commands for which special formatting attributes apply.
An argument must be provided in curly braces, as in the
qdoc comment shown below. The argument is not interpreted
@@ -505,8 +366,8 @@
</sectiondiv>
\endcode
- Your DITA XML publishing program must then recognize the \e
- outputclass attribute value.
+ Your DITA XML publishing program must then recognize the
+ \e {outputclass} attribute value.
\note The \bold {\\div} command can be nested.
@@ -573,7 +434,7 @@
\enddiv
\enddiv
- When generating DITA XML, qdoc outputs the nested \e div commands as:
+ When generating DITA XML, qdoc outputs the nested \e {div} commands as:
\code
<sectiondiv outputclass="indexbox guide">
@@ -618,14 +479,15 @@
\endcode
Your DITA XML publishing program must recognize the values
- of the \e outputclass attribute.
+ of the \e {outputclass} attribute.
- See also \l {span} {\\span}.
+ See also \l {span-command} {\\span}.
- \row
- \o \bold \\span \span {class="newStuff"} {(new)} \target span
- \o \bold {The \\span command is for applying special formatting
- attributes to a small block of text.}
+ \section1 \\span \span {class="newStuff"} {(new)}
+ \target span -command
+
+ The \\span command is for applying special formatting
+ attributes to a small block of text.
Two arguments must be provided, each argument in curly
braces, as shown in the qdoc comment below. The first
@@ -649,7 +511,7 @@
* /
\endcode
- Class \e variableName refers to a clause in your style.css.
+ Class \e {variableName} refers to a clause in your style.css.
\code
.variableName
@@ -659,7 +521,7 @@
}
\endcode
- Using the \e variableName clause shown above, the example is rendered as:
+ Using the \e {variableName} clause shown above, the example is rendered as:
Global variables with complex types:
\list 1
@@ -672,18 +534,20 @@
\note The \bold span command does not cause a new paragraph to
be started.
- See also \l {div} {\\div}.
+ See also \l {div-command} {\\div}.
- \row
- \o \bold \\tt \target tt
- \o \bold {The \\tt command can be used to render variables,
- user-defined classes and C++ keywords like \c int, \c
- for, etc.}
+ \section1 \\tt
+ \target tt-command
+
+ The \\tt command can be used to render variables,
+ user-defined classes and C++ keywords like \c int, \c
+ for, etc.
- The \\tt command behaves just like the \l {c} {\\c} command,
- except that \\tt parses QDoc commands (like \l {i} {\\i}, \l
- {bold} {\\bold} and \l {underline} {\\underline}) contained
- within its argument.
+ The \\tt command behaves just like the \l {c-command} {\\c}
+ command, except that \\tt parses QDoc commands (like \l
+ {i-command} {\\i}, \l {bold-command} {\\bold} and \l
+ {underline-command} {\\underline}) contained within its
+ argument.
The command renders its argument using a monospace
font. For example:
@@ -693,29 +557,30 @@
After \c setupUi() populates the main container with
child widgets it scans the main container's list of
slots for names with the form
- \tt{on_\i{objectName}_\i{signalName}().}
+ \tt{on_\e{objectName}_\e{signalName}().}
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
After \c setupUi() populates the main container with
child widgets it scans the main container's list of
slots for names with the form
- \tt{on_\i{objectName}_\i{signalName}().}
+ \tt{on_\e{objectName}_\e{signalName}().}
\endquotation
The \\tt command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- See also \l {c} {\\c}.
+ See also \l {c-command} {\\c}.
- \row
- \o \bold \\bold \target bold
- \o \bold {The \\bold command renders its argument using
- a bold font.}
+ \section1 \\bold
+ \target bold-command
+
+ The \\bold command renders its argument using
+ a bold font.
For example:
@@ -726,20 +591,20 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
This is regular text; \bold {this text is rendered using
the \\bold command}.
\endquotation
- The command follows the same conventions as the \l {i} {\\i}
+ The command follows the same conventions as the \l {i-command} {\\i}
command for \l {argument} {punctuation, parentheses and use
of braces} for the argument.
- \row
- \o \bold \\i \target i
- \o \bold {The \\i command renders its argument in italic.}
+ \section1 \\i
+ \target i-command
+ The \\i command renders its argument in italic.
\warning This is preliminary functionality. For
more information, see the \l
@@ -756,10 +621,10 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
- Here, we render \i {a few words} in italic.
+ Here, we render \e {a few words} in italic.
\endquotation
If you want to use other QDoc commands within an argument
@@ -774,11 +639,11 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
An argument can sometimes contain whitespaces,
- for example: \i QPushButton(tr("A Brand New Button"))
+ for example: \e QPushButton(tr("A Brand New Button"))
\endquotation
Finally, trailing punctuation is not included in an
@@ -795,7 +660,7 @@
<tr valign="top" bgcolor="#d0d0d0">
<td>1</td>
- <td>A variation of a command button is a \i menu
+ <td>A variation of a command button is a \e menu
button.</td>
<td>A variation of a command button is a <i>menu</i>
button.</td>
@@ -804,7 +669,7 @@
<tr valign="top" bgcolor="#c0c0c0">
<td>2</td>
<td>The QPushButton widget provides a
- \i {command button}.</td>
+ \e {command button}.</td>
<td>The QPushButton widget provides a
<i>command button</i>.</td>
</tr>
@@ -812,20 +677,20 @@
<tr valign="top" bgcolor="#d0d0d0">
<td>3</td>
<td>Another class of buttons are option buttons
- \i (see QRadioButton).</td>
+ \e (see QRadioButton).</td>
<td>Another class of buttons are option buttons
<i> (see QRadioButton)</i>.</td>
</tr>
<tr valign="top" bgcolor="#c0c0c0">
<td>4</td>
- <td>A push button emits the signal \i clicked().</td>
+ <td>A push button emits the signal \e clicked().</td>
<td>A push button emits the signal <i>clicked</i>().</td>
</tr>
<tr valign="top" bgcolor="#d0d0d0">
<td>5</td>
- <td>The \i QPushButton's checked property is
+ <td>The \e QPushButton's checked property is
false by default.</td>
<td>The <i>QPushButton</i>'s checked property is
false by default.</td>
@@ -834,10 +699,11 @@
</table>
\endraw
- \row
- \o \bold \\sub \target sub
- \o \bold {The \\sub command renders its argument lower
- than the baseline of the regular text, using a smaller font.}
+ \section1 \\sub
+ \target sub-command
+
+ The \\sub command renders its argument lower
+ than the baseline of the regular text, using a smaller font.
For example:
@@ -852,7 +718,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Definition (Range): Consider the sequence
@@ -864,13 +730,14 @@
\endquotation
The \\sub command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \row
- \o \bold \\sup \target sup
- \o \bold {The \\sup command renders its argument higher than
- the baseline of the regular text, using a smaller font.}
+ \section1 \\sup
+ \target sup-command
+
+ The \\sup command renders its argument higher than
+ the baseline of the regular text, using a smaller font.
For example:
@@ -884,23 +751,24 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The series
1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
- is called the \i {geometric series}.
+ is called the \e {geometric series}.
\endquotation
The \\sup command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \row
- \o \bold \\underline \target underline
- \o \bold {The \\underline command renders its argument underlined.}
+ \section1 \\underline
+ \target underline-command
+
+ The \\underline command renders its argument underlined.
For example:
@@ -912,7 +780,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The \underline {F}ile menu gives the users the possibility
@@ -921,17 +789,67 @@
\endquotation
The \\underline command follows the same conventions as the
- \l {i} {\\i} command for \l {argument} {punctuation,
- parentheses and use of braces} for the argument. \endtable
+ \l {i-command} {\\i} command for \l {argument} {punctuation,
+ parentheses and use of braces} for the argument.
+
+ \section1 \\\\ (double backslash)
+ \target backslash-command
+
+ The \\\\ command expands to a single backslash.
+
+ QDoc commands always start with a backslash alone. To
+ display an actual backslash in the text you need to type
+ two of the kind. If you want to display two backslashes,
+ you need to type four, and so forth. For example:
+
+ \code
+ / *!
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ * /
+ \endcode
+
+ QDoc renders this as:
+
+ \quotation
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ \endquotation
+
+ However, if you want your text to appear in a typewriter
+ font as well, you can use the \l {c-command} {\\c} command instead,
+ which accepts and renders the backslash as any other
+ character. For example:
+
+ \code
+ / *!
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ * /
+ \endcode
+
+ QDoc renders this as:
+
+ \quotation
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ \endquotation
+
*/
/*!
- \page 05-qdoc-commands-documentstructuring.html
- \previouspage Text Formatting Commands
+ \page 05-qdoc-commands-documentstructure.html
+ \previouspage Text Markup
\contentspage Table of Contents
- \nextpage Verbatim Code Commands
+ \nextpage Including Code Inline
- \title Document Structuring Commands
+ \title Document Structure
The document structuring commands divide the documentation into
sections. In total, there are six levels of sections in QDoc: \c
@@ -940,26 +858,11 @@
traditional section, subsection, subsubsection and
subsubsubsection.
- \section1 Alphabetical List
-
- \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
- \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
+ \section1 \\part
+ \target part-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\part \target part
- \o \bold {The \\part command is intended for use in
- larger documents, and divides the document into parts.}
+ The \\part command is intended for use in
+ larger documents, and divides the document into parts.
In general a document structuring command considers
everything that follows it until the first line break as
@@ -995,7 +898,7 @@
section unit, for example from \c part to \c section1, is
not allowed.
- You can \i begin with either of the three: \c part, \c
+ You can \e begin with either of the three: \c part, \c
chapter or \c section1. For example:
@@ -1056,7 +959,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -1123,91 +1026,89 @@
generated table of contents appears in the upper
righthand corner of the page.
- \row
- \o \bold \\chapter \target chapter
- \o \bold {The \\chapter command is intended for use in
- larger documents, and divides the document into chapters.}
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ \section1 \\chapter
+ \target chapter-command
+
+ The \\chapter command is intended for use in
+ larger documents, and divides the document into chapters.
- \row
- \o \bold \\section1 \target sectionOne
- \o \bold {The \\section1 command starts a new section.}
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
- \row
- \o \bold \\section2 \target sectionTwo
- \o \bold {The \\section2 command starts a new section.}
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ \section1 \\section1
+ \target sectionOne-command
- \row
- \o \bold \\section3 \target sectionThree
- \o \bold {The \\section3 command starts a new section.}
+ The \\section1 command starts a new section.
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- \row
- \o \bold \\section4 \target sectionFour
- \o \bold {The \\section4 command starts a new section.}
+ \section1 \\section2
+ \target sectionTwo-command
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ The \\section2 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
+
+
+ \section1 \\section3
+ \target sectionThree-command
+
+ The \\section3 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
+
+
+ \section1 \\section4
+ \target sectionFour-command
+
+ The \\section4 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- \endtable
*/
/*!
- \page 06-qdoc-commands-verbatimcode.html
- \previouspage Document Structuring Commands
+ \page 06-qdoc-commands-includecodeinline.html
+ \previouspage Document Structure
\contentspage Table of Contents
- \nextpage Quoting External Code Commands
+ \nextpage Including External Code
- \title Verbatim Code Commands
+ \title Including Code Inline
The following commands are used to render verbatim code within the
documentation. The code is rendered on a new line, using a
typewriter font and the standard indentation.
\bold{Note:} Although all of these commands can be used to present
- C++ code, the \l{07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
- and \l{07-0-qdoc-commands-quoting.html#codeline} {\\codeline} commands
- should be used in preference to
- the others when presenting valid code. This allows auxilliary tools
- for Qt language bindings to substitute the relevant code snippets in
+ C++ code, the
+ \l{07-0-qdoc-commands-includingexternalcode.html#snippet-command}
+ {\\snippet} and
+ \l{07-0-qdoc-commands-includingexternalcode.html#codeline-command}
+ {\\codeline} commands should be used in preference to the others
+ when presenting valid code. This allows auxilliary tools for Qt
+ language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 Alphabetical List
+ \section1 \\code
+ \target code-command
- \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
- \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
- \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
- \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
+ The \\code command and the corresponding
+ \\endcode command delimit a piece of verbatim code.
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\code \target code-command
- \o \bold {The \\code command and the corresponding
- \\endcode command delimit a piece of verbatim code.}
-
- Whereas the \l {c} {\\c} command can be used for short code
+ Whereas the \l {c-command} {\\c} command can be used for short code
fragments within a sentence, the \\code command is for
longer code snippets and renders the code verbatim in a
separate paragraph using a typewriter font and the standard
indentation.
- When processing any of the \\code, \l {badcode} {\\badcode},
- \l {newcode} {\\newcode} and \l {oldcode} {\\oldcode}
+ When processing any of the \\code, \l {badcode-command} {\\badcode},
+ \l {newcode-command} {\\newcode} and \l {oldcode-command} {\\oldcode}
commands, QDoc basically removes all indentation that is
common for the verbatim code blocks within a \c{/}\c{*!} ...
\c{*}\c{/} comment before it adds the standard
@@ -1233,7 +1134,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\code
#include <QApplication>
@@ -1252,19 +1153,21 @@
You need to type the code manually between the \\code and
\\endcode commands. If you want to include code snippets
from a particular file, use the \l
- {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
+ {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
command instead.
- See also \l {c} {\\c}, \l
- {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {badcode} {\\badcode}, \l {newcode} {\\newcode} and \l
- {oldcode} {\\oldcode}.
+ See also \l {c-command} {\\c}, \l
+ {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile},
+ \l {badcode-command} {\\badcode}, \l {newcode-command} {\\newcode} and \l
+ {oldcode-command} {\\oldcode}.
- \row
- \o \bold \\badcode \target badcode
- \o \bold {The \\badcode command and the corresponding
- \\endcode command delimit a piece of code that doesn't
- compile or is wrong for some other reason.}
+
+ \section1 \\badcode
+ \target badcode-command
+
+ The \\badcode command and the corresponding
+ \\endcode command delimit a piece of code that doesn't
+ compile or is wrong for some other reason.
The \\badcode command is similar the \l {code-command} {\\code}
command, but renders the code using a grey font instead of
@@ -1292,7 +1195,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The statement below is rendered using the
@@ -1314,23 +1217,25 @@
\\badcode... \\endcode, and the special character '\\' is
accepted and rendered like the rest of the code.
- See also \l {code-command} {\\code}, \l {newcode} {\\newcode} and \l
- {oldcode} {\\oldcode}.
+ See also \l {code-command} {\\code}, \l {newcode-command} {\\newcode} and \l
+ {oldcode-command} {\\oldcode}.
- \row
- \o \bold \\newcode \target newcode
- \o \bold {The \\newcode command, and the associated \\oldcode
- and \\endcode commands, indicate how to port a piece of
- code to a new version of an API.}
+
+ \section1 \\newcode
+ \target newcode-command
+
+ The \\newcode command, and the associated \\oldcode
+ and \\endcode commands, indicate how to port a piece of
+ code to a new version of an API.
The \\newcode command, and its companion the \\oldcode
command, is a convenience combination of the \l
- {code-command} {\\code} and \l {badcode} {\\badcode} commands: The
+ {code-command} {\\code} and \l {badcode-command} {\\badcode} commands: The
combination provides a text relating the two code snippets
to each other. The command requires a preceding \\oldcode
statement.
- Like the \l {code-command} {\\code} and \l {badcode} {\\badcode}
+ Like the \l {code-command} {\\code} and \l {badcode-command} {\\badcode}
commands, the \\newcode command renders its code on a new
line in the documentation using a typewriter font and the
standard indentation. For example:
@@ -1365,23 +1270,24 @@
\\oldcode ... \\endcode, and the '\\' character doesn't need
to be escaped.
- \row
- \o \bold \\oldcode \target oldcode
- \o \bold {The \\oldcode command requires a corresponding
- \\newcode statement; otherwise QDoc fails to parse the command
- and emits a warning.}
- See also \l {newcode} {\\newcode} and \l {badcode} {\\badcode}.
- \endtable
+ \section1 \\oldcode
+ \target oldcode-command
+
+ The \\oldcode command requires a corresponding
+ \\newcode statement; otherwise QDoc fails to parse the command
+ and emits a warning.
+
+ See also \l {newcode-command} {\\newcode} and \l {badcode-command} {\\badcode}.
*/
/*!
- \page 07-0-qdoc-commands-quoting.html
- \previouspage Verbatim Code Commands
+ \page 07-0-qdoc-commands-includingexternalcode.html
+ \previouspage Including Code Inline
\contentspage Table of Contents
- \nextpage Linking Commands
+ \nextpage Creating Links
- \title Quoting External Code Commands
+ \title Including External Code
The following commands enable quoting from files in the
documentation: You can make QDoc include the complete contents of
@@ -1396,31 +1302,11 @@
for Qt language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 Alphabetical List
-
- \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
- \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
- \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
+ \section1 \\quotefile
+ \target quotefile-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\quotefile \target quotefile-command
- \o \bold {The \\quotefile command expands to the complete
- contents of the file given as argument.}
+ The \\quotefile command expands to the complete
+ contents of the file given as argument.
The command considers the rest of the line as part of its
argument, make sure to follow the file name with a line
@@ -1443,7 +1329,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
This is a simple "Hello world" example:
@@ -1454,17 +1340,18 @@
application up and running.
\endquotation
- \warning If you use the \l {QDoc
- Compatibility} {compat.qdocconf} file this command is called
- \\include.
+ \warning If you use the \l {Compatibility Issues}
+ {compat.qdocconf} file this command is called \\include.
See also \l {quotefromfile-command} {\\quotefromfile} and
\l {code-command} {\\code}.
- \row
- \o \bold \\quotefromfile \target quotefromfile-command
- \o \bold {The \\quotefromfile command opens the file
- given as argument for quoting.}
+
+ \section1 \\quotefromfile
+ \target quotefromfile-command
+
+ The \\quotefromfile command opens the file
+ given as argument for quoting.
The command considers the rest of the line as part of its
argument, make sure to follow the file name with a line
@@ -1472,9 +1359,9 @@
The command is intended for use when quoting parts from
file with the walkthrough commands: \l
- {printline} {\\printline}, \l {printto} {\\printto}, \l
- {printuntil} {\\printuntil}, \l {skipline} {\\skipline}, \l
- {skipto} {\\skipto}, \l {skipuntil} {\\skipuntil}. This
+ {printline-command} {\\printline}, \l {printto-command} {\\printto}, \l
+ {printuntil-command} {\\printuntil}, \l {skipline-command} {\\skipline}, \l
+ {skipto-command} {\\skipto}, \l {skipuntil-command} {\\skipuntil}. This
enables you to quote specific portions of a file. For
example:
@@ -1501,7 +1388,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1538,11 +1425,13 @@
See also \l {quotefile-command} {\\quotefile}, \l
{code-command} {\\code} and \l {dots} {\\dots}.
- \row
- \o \bold \\printline \target printline
- \o \bold {The \\printline command expands to the line
- from the current position to the next non-blank line of
- the current souce file.}
+
+ \section1 \\printline
+ \target printline-command
+
+ The \\printline command expands to the line
+ from the current position to the next non-blank line of
+ the current souce file.
To ensure that the documentation always is synchronized
with the source file, a substring of the line must be
@@ -1583,7 +1472,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
There has to be exactly one QApplication object
@@ -1616,7 +1505,7 @@
QDoc reads the file sequentially. To move the current
position forward you can use either of the \l
- {skipline} {\\skip...} commands. To move the current
+ {skipline-command} {\\skip...} commands. To move the current
position backward, you can use the \l
{quotefromfile-command} {\\quotefromfile} command again.
@@ -1642,7 +1531,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\quotefromfile widgets/scribble/mainwindow.cpp
@@ -1670,20 +1559,22 @@
regular expression cannot be located, i.e. if the source
code has changed.
- See also \l {printto} {\\printto} and \l
- {printuntil} {\\printuntil}.
+ See also \l {printto-command} {\\printto} and \l
+ {printuntil-command} {\\printuntil}.
- \row
- \o \bold \\printto \target printto
- \o \bold {The \\printto command expands to all the lines
- from the current position up to and \i excluding the
- next line containing a given substring.}
+
+ \section1 \\printto
+ \target printto-command
+
+ The \\printto command expands to all the lines
+ from the current position up to and \e excluding the
+ next line containing a given substring.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
{file} {positioning} and \l {substring} {argument} as the \l
- {printline} {\\printline} command.
+ {printline-command} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1704,7 +1595,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1720,20 +1611,22 @@
(\l {Example File} {The complete example file...})
- See also \l {printline} {\\printline} and \l
- {printuntil} {\\printuntil}.
+ See also \l {printline-command} {\\printline} and \l
+ {printuntil-command} {\\printuntil}.
- \row
- \o \bold \\printuntil \target printuntil
- \o \bold {The \\printuntil command expands to all the lines
- from the current position up to and \i including the next line
- containing a given substring.}
+
+ \section1 \\printuntil
+ \target printuntil-command
+
+ The \\printuntil command expands to all the lines
+ from the current position up to and \e including the next line
+ containing a given substring.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
{file} {positioning} and \l {substring} {argument} as the \l
- {printline} {\\printline} command.
+ {printline-command} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1756,7 +1649,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1775,13 +1668,15 @@
(\l {Example File} {The complete example file...})
- See also \l {printline} {\\printline} and \l
- {printto} {\\printto}.
+ See also \l {printline-command} {\\printline} and \l
+ {printto-command} {\\printto}.
- \row
- \o \bold \\skipline \target skipline
- \o \bold {The \\skipline command ignores the next non-blank
- line in the current source file.}
+
+ \section1 \\skipline
+ \target skipline-command
+
+ The \\skipline command ignores the next non-blank
+ line in the current source file.
Doc reads the file sequentially, and the \\skipline command
is used to move the current position (omitting a line of
@@ -1791,7 +1686,7 @@
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1811,7 +1706,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\l
@@ -1831,14 +1726,16 @@
(\l {Example File} {The complete example file...})
- See also \l {skipto} {\\skipto}, \l
- {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
+ See also \l {skipto-command} {\\skipto}, \l
+ {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \row
- \o \bold \\skipto \target skipto
- \o \bold {The \\skipto command ignores all the lines from the
- current position up to and \i excluding the next line
- containing a given substring.}
+
+ \section1 \\skipto
+ \target skipto-command
+
+ The \\skipto command ignores all the lines from the
+ current position up to and \e excluding the next line
+ containing a given substring.
QDoc reads the file sequentially, and the \\skipto command
is used to move the current position (omitting one or
@@ -1850,7 +1747,7 @@
break.
The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1871,7 +1768,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1889,14 +1786,16 @@
(\l {Example File} {The complete example file...})
- See also \l {skipline} {\\skipline}, \l
- {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
+ See also \l {skipline-command} {\\skipline}, \l
+ {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \row
- \o \bold \\skipuntil \target skipuntil
- \o \bold {The \\skipuntil command ignores all the lines from
- the current position up to and \i including the next line
- containing a given substring.}
+
+ \section1 \\skipuntil
+ \target skipuntil-command
+
+ The \\skipuntil command ignores all the lines from
+ the current position up to and \e including the next line
+ containing a given substring.
QDoc reads the file sequentially, and the \\skipuntil
command is used to move the current position (omitting one
@@ -1908,7 +1807,7 @@
break.
The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1928,7 +1827,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The first thing we did in the \c main() function was to
@@ -1946,13 +1845,15 @@
(\l {Example File} {The complete example file...})
- See also \l {skipline} {\\skipline}, \l {skipto} {\\skipto}
+ See also \l {skipline-command} {\\skipline}, \l {skipto-command} {\\skipto}
and \l {dots} {\\dots}.
- \row
- \o \bold \\dots \target dots
- \o \bold {The \\dots command indicates that parts of the
- source file have been omitted when quoting a file.}
+
+ \section1 \\dots
+ \target dots-command
+
+ The \\dots command indicates that parts of the
+ source file have been omitted when quoting a file.
The command is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command, and should be
@@ -1970,7 +1871,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotefromfile examples/main.cpp
\skipto main
@@ -1995,7 +1896,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\dots 0
\dots
@@ -2003,14 +1904,17 @@
\dots 12
\dots 16
- See also \l {skipline} {\\skipline}, \l
- {skipto} {\\skipto} and \l {skipuntil} {\\skipuntil}.
+ See also \l {skipline-command} {\\skipline}, \l
+ {skipto-command} {\\skipto} and \l {skipuntil-command}
+ {\\skipuntil}.
+
+
+ \section1 \\snippet
+ \target snippet-command
+
+ The \\snippet command causes a code snippet to be included
+ verbatim as preformatted text, which may be syntax highlighted.
- \row
- \o \bold \\snippet \target snippet
- \o \bold {The \\snippet command causes a code snippet to be included
- verbatim as preformatted text, which may be syntax highlighted.}
-
Each code snippet are referenced by the file that holds it and by
a unique identifier for that file. Snippet files are typically
stored in a \c{snippets} directory inside the documentation
@@ -2039,17 +1943,19 @@
//! [Adding a resource]
\endcode
\dots
- \row
- \o \bold \\codeline \target codeline
- \o \bold{The \\codeline command inserts a blank line of preformatted
- text. It is used to insert gaps between snippets without closing
- the current preformatted text area and opening a new one.}
- \endtable
+
+ \section1 \\codeline
+ \target codeline-command
+
+ The \\codeline command inserts a blank line of preformatted
+ text. It is used to insert gaps between snippets without closing
+ the current preformatted text area and opening a new one.
+
*/
/*!
\page 07-1-example.html
- \previouspage Quoting External Code Commands
+ \previouspage Including External Code
\contentspage Table of Contents
\title Example File
@@ -2058,35 +1964,22 @@
*/
/*!
- \page 08-qdoc-commands-linking.html
- \previouspage Quoting External Code Commands
+ \page 08-qdoc-commands-creatinglinks.html
+ \previouspage Including External Code
\contentspage Table of Contents
- \nextpage Graphic Commands
+ \nextpage Including Images
- \title Linking Commands
+ \title Creating Links
The linking commands make it possible to create hyperlinks to
classes, functions, header files and examples. They also make it
possible to link to targets within a document, as well as to other
documents and URLs.
- \section1 Alphabetical List
-
- \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
- \l {08-qdoc-commands-linking.html#l} {\\l},
- \l {08-qdoc-commands-linking.html#sa} {\\sa},
- \l {08-qdoc-commands-linking.html#target} {\\target}
+ \section1 \\l
+ \target l-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\l \target l
- \o \bold {The \\l command is used to create hyperlinks. }
+ The \\l command is used to create hyperlinks.
The command's general syntax is
@@ -2103,7 +1996,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Read the \l {http://qt.nokia.com/doc/4.0/}
@@ -2147,26 +2040,45 @@
* /
\endcode
- For the one-parameter version the braces can often
- be omitted. See the \l {i} {\\i} command for the \l
- {argument} {argument conventions}.
+ For the one-parameter version the braces can often
+ be omitted. See the \l {i-command} {\\i} command for the \l
+ {argument} {argument conventions}.
+
+ The \\l command supports several kinds of links:
+
+ \list
+
+ \o \c {\l QWidget} - The name of a class documented with
+ the \l {class-command} {\\class} command.
+
+ \o \c {\l QWidget::sizeHint()} - The name of a documented
+ member function (documented with or without the \l
+ {fn-command} {\\fn} command).
+
+ \o \c {\l <QtGlobal>} - The subject of a \l
+ {headerfile-command} {\\headerfile} command.
+
+ \o \c {\l widgets/wiggly} - The relative path used in an \l
+ {example-command} {\\example} command.
+
+ \o \c {\l {QWidget Class Reference}} - The title used in a
+ \l {title-command} {\\title} command.
+
+ \o \c {\l {Introduction to QDoc}}- The text from one of the
+ \l{part-command} {\\part}, \l{chapter} {\\chapter}
+ or \l {sectionOne-command} {\\section} commands.
+
+ \o \c {\l fontmatching} - The argument of a \l
+ {target-command} {\\target} command.
+
+ \o \c {\l {Shared Classes}} - A keyword used in a \l
+ {keyword-command} {\\keyword} command.
+
+ \o \c {\l network.html} - The file name used in a \l
+ {page-command} {\\page} command.
- The \\l command supports several kinds of links:
+ \o \c {\l http://www.trolltech.com/} - A URL.
- \list
- \o \c {\l QWidget} - a defined \l {class-command} {\\class}
- \o \c {\l QWidget::sizeHint()} - a defined member
- function (\l {fn} {\\fn})
- \o \c {\l <QtGlobal>} - a defined \l {headerfile} {\\headerfile}
- \o \c {\l widgets/wiggly} - a defined
- \l {example-command} {\\example}
- \o \c {\l {QWidget Class Reference}} - a defined \l {title-command} {\\title}
- \o \c {\l {Introduction}}- a defined \l{part} {\\part},
- \l{chapter} {\\chapter} or \l {sectionOne} {\\section...}
- \o \c {\l fontmatching} - a defined \l {target} {\\target}
- \o \c {\l {Shared Classes}} - a defined \l {keyword} {\\keyword}
- \o \c {\l network.html} - a defined \l {page} {\\page}
- \o \c {\l http://www.trolltech.com/} - a URL
\endlist
QDoc also tries to make a link out of any words that don't
@@ -2182,14 +2094,16 @@
\o \c {\l {QWidget::} {sizeHint()}}
\endlist
- See also \l {sa} {\\sa}, \l {target} {\\target} and \l
- {keyword} {\\keyword}.
+ See also \l {sa-command} {\\sa}, \l {target-command} {\\target}
+ and \l {keyword-command} {\\keyword}.
- \row
- \o \bold \\sa \target sa
- \o \bold {The \\sa command defines a list of links that will
- be rendered in a separate "See also" section at the bottom
- of the documentation.}
+
+ \section1 \\sa
+ \target sa-command
+
+ The \\sa command defines a list of links that will
+ be rendered in a separate "See also" section at the bottom
+ of the documentation.
The command takes a comma-separated list of links as its
argument. If the line ends with a comma, you can continue
@@ -2217,7 +2131,7 @@
\endlist
The \\sa command supports the same kind
- of links as the \l {l} {\\l} command. For example:
+ of links as the \l {l-command} {\\l} command. For example:
\code
/ *!
@@ -2232,27 +2146,29 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {void QWidget::addActions ( QList<QAction*>
- \i actions )}
+ \e actions )}
- Appends the actions \i actions to this widget's
+ Appends the actions \e actions to this widget's
list of actions.
See also \l {QWidget::removeAction()} {removeAction()},
\l QMenu, and \l {QWidget::addAction()} {addAction()}.
\endquotation
- See also \l {l} {\\l}, \l {target} {\\target} and \l
- {keyword} {\\keyword}.
+ See also \l {l-command} {\\l}, \l {target-command} {\\target} and \l
+ {keyword-command} {\\keyword}.
- \row
- \o \bold \\target \target target
- \o \bold {The \\target command defines an explicit point in the
- documentation that you can later link to using the \l {l} {\\l}
- and \l {sa} {\\sa} commands.}
+
+ \section1 \\target
+ \target target-command
+
+ The \\target command defines an explicit point in the
+ documentation that you can later link to using the \l {l-command} {\\l}
+ and \l {sa-command} {\\sa} commands.
The command considers the rest of the line as part of its
argument, make sure to follow the target name with a line
@@ -2292,21 +2208,23 @@
If the target name does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l} {\\l}, \l {sa} {\\sa} and \l
- {keyword} {\\keyword}.
+ See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
+ {keyword-command} {\\keyword}.
- \row
- \o \bold \\keyword \target keyword
- \o \bold {The \\keyword command defines an explicit point in the
- documentation that you can later link to using the \l {l} {\\l}
- and \l {sa} {\\sa} commands.}
+
+ \section1 \\keyword
+ \target keyword-command
+
+ The \\keyword command defines an explicit point in the
+ documentation that you can later link to using the \l {l-command} {\\l}
+ and \l {sa-command} {\\sa} commands.
Keywords must be unique within the entire set of
documentation processed in on QDoc run. The command
considers the rest of the line as part of its argument,
make sure to follow the keyword with a line break.
- The \\keyword command is similar to \l {target} {\\target},
+ The \\keyword command is similar to \l {target-command} {\\target},
but stronger. A keyword can be referenced from anywhere
using a simple syntax. For example:
@@ -2330,7 +2248,7 @@
* /
\endcode
- can be referenced like this
+ The location of the keyword can be linked to like this:
\code
/ *!
@@ -2339,7 +2257,7 @@
* /
\endcode
- which will be rendered as
+ QDoc renders this as:
\quotation
When a string is surrounded by slashes, it's
@@ -2349,40 +2267,28 @@
If the keyword does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l} {\\l}, \l {sa} {\\sa} and \l
- {target} {\\target}.
- \endtable
+ See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
+ {target-command} {\\target}.
+
*/
/*!
- \page 09-qdoc-commands-graphic.html
- \previouspage Linking Commands
+ \page 09-qdoc-commands-includingimages.html
+ \previouspage Creating Links
\contentspage Table of Contents
- \nextpage Container Commands
+ \nextpage Tables and Lists
- \title Graphic Commands
+ \title Including Images
The graphic commands makes it possible to include images in the
documentation. The images can be rendered as separate paragraphs,
or within running text.
- \section1 Alphabetical List
-
- \l {09-qdoc-commands-graphic.html#caption} {\\caption},
- \l {09-qdoc-commands-graphic.html#image} {\\image},
- \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
+ \section1 \\image
+ \target image-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\image \target image
- \o \bold {The \\image command expands to the image specified by its
- argument, and renders it centered as a separate paragraph.}
+ The \\image command expands to the image specified by its
+ argument, and renders it centered as a separate paragraph.
The \\image command replaces the old \\img command. For more
information, see the \l
@@ -2416,7 +2322,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt by Trolltech is a C++ toolkit for cross-platform GUI
@@ -2430,13 +2336,15 @@
\endquotation
See also \l {inlineimage-command} {\\inlineimage} and \l
- {caption} {\\caption}.
+ {caption-command} {\\caption}.
- \row
- \o \bold \\inlineimage \target inlineimage-command
- \o \bold {The \\inlineimage command expands to the image
- specified by its argument; the image is rendered inline
- with the rest of the text.}
+
+ \section1 \\inlineimage
+ \target inlineimage-command
+
+ The \\inlineimage command expands to the image
+ specified by its argument; the image is rendered inline
+ with the rest of the text.
The command takes two arguments. The first is the name of
the image file. The second argument is optional and is a
@@ -2458,7 +2366,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list 1
\o \inlineimage happy.gif Oh so happy!
@@ -2484,7 +2392,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2526,7 +2434,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\inlineimage training.jpg Training by Trolltech
@@ -2538,58 +2446,44 @@
to derive maximum benefit from the course.
\endquotation
- See also \l {image} {\\image} and \l {caption} {\\caption}.
+ See also \l {image-command} {\\image} and \l {caption-command} {\\caption}.
- \row
- \o \bold \\caption \target caption
- \o \bold {The \\caption command provides a caption for an image.}
+
+ \section1 \\caption
+ \target caption-command
+
+ The \\caption command provides a caption for an image.
The command follows the same conventions for parentheses and use
- of braces for its \l argument as the \l {i} {\\i} command.
+ of braces for its \l argument as the \l {i-command} {\\i} command.
\warning This is preliminary functionality. The
command is not fully implemented.
- See also \l {image} {\\image} and \l
+ See also \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage}
- \endtable
+
*/
/*!
- \page 10-qdoc-commands-container.html
- \previouspage Graphic Commands
+ \page 10-qdoc-commands-tablesandlists.html
+ \previouspage Including Images
\contentspage Table of Contents
- \nextpage Document Contents Commands
+ \nextpage Special Content
- \title Container Commands
+ \title Tables and Lists
The container commands create tables and lists with associated
items and contents. A list is rendered left aligned as a separate
paragraph. A table is rendered centered as a separate paragraph,
and its width depends on its content.
- \section1 Alphabetical List
-
- \l {10-qdoc-commands-container.html#header} {\\header},
- \l {10-qdoc-commands-container.html#list} {\\list},
- \l {10-qdoc-commands-container.html#o} {\\o},
- \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue},
- \l {10-qdoc-commands-container.html#row} {\\row},
- \l {10-qdoc-commands-container.html#table} {\\table},
- \l {10-qdoc-commands-container.html#value-command} {\\value}
-
- \section1 Command Descriptions
+ \section1 \\table
+ \target table-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\table \target table
- \o \bold {The \\table command and the corresponding \\endtable
- command delimit the contents of a table.}
+ The \\table command and the corresponding \\endtable
+ command delimit the contents of a table.
The command accepts a single argument specifying the
table's width in percentage:
@@ -2609,9 +2503,9 @@
the table will be centered in the generated documentation.
A table can contain headers, rows and columns. A row starts
- with a \l {row} {\\row} command and consists of cells, which
- starts with a \l {o} {\\o} command. There is also a \l
- {header} {\\header} command which is a special kind of row
+ with a \l {row-command} {\\row} command and consists of cells, which
+ starts with a \l {o-command} {\\o} command. There is also a \l
+ {header-command} {\\header} command which is a special kind of row
with a special formatting. For example:
\code
@@ -2638,7 +2532,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2699,7 +2593,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -2728,16 +2622,18 @@
</table>
\endraw
- See also \l {header} {\\header}, \l {row} {\\row} and \l {o} {\\o}.
+ See also \l {header-command} {\\header}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \row
- \o \bold \\header \target header
- \o \bold {The \\header command indicates that the following
- table cells are the current table's column headers.}
- The command can only be used within the \l{table}
+ \section1 \\header
+ \target header-command
+
+ The \\header command indicates that the following
+ table cells are the current table's column headers.
+
+ The command can only be used within the \l{table-command}
{\\table...\\endtable} commands. A header can contain
- several cells. A cell is created with the \l {o} {\\o}
+ several cells. A cell is created with the \l {o-command} {\\o}
command.
A header cell's text is centered within the table cell and
@@ -2757,7 +2653,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2778,16 +2674,18 @@
</table>
\endraw
- See also \l {table} {\\table}, \l {row} {\\row} and \l {o} {\\o}.
+ See also \l {table-command} {\\table}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \row
- \o \bold \\row \target row
- \o \bold {The \\row command indicates that the following table
- cells belong to the same row in the current table.}
- The command can only be used within the \l{table}
+ \section1 \\row
+ \target row-command
+
+ The \\row command indicates that the following table
+ cells belong to the same row in the current table.
+
+ The command can only be used within the \l{table-command}
{\\table...\\endtable} commands. A row can contain
- several cells. A cell is created with the \l {o} {\\o}
+ several cells. A cell is created with the \l {o-command} {\\o}
command.
The background cell color of each row alternate between two
@@ -2820,7 +2718,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2860,13 +2758,15 @@
</table>
\endraw
- See also \l {table} {\\table}, \l {header} {\\header} and \l
- {o} {\\o}.
+ See also \l {table-command} {\\table}, \l {header-command} {\\header} and \l
+ {o-command} {\\o}.
- \row
- \o \bold \\value \target value-command
- \o \bold {The \\value command starts the documentation of a C++ enum
- item}.
+
+ \section1 \\value
+ \target value-command
+
+ The \\value command starts the documentation of a C++ enum
+ item.
The command's first argument is the enum item. Then follows
its associated description. The description argument ends
@@ -2879,10 +2779,12 @@
See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
- \row
- \o \bold \\omitvalue \target omitvalue-command
- \o \bold {The \\omitvalue command excludes a C++ enum item
- from the documentation}.
+
+ \section1 \\omitvalue
+ \target omitvalue-command
+
+ The \\omitvalue command excludes a C++ enum item
+ from the documentation.
The command's only argument is the name of the enum item
that will be omitted. See the \l {enum-command} {\\enum}
@@ -2890,13 +2792,15 @@
See also \l {enum-command} {\\enum} and \l {value-command} {\\value}.
- \row
- \o \bold \\list \target list
- \o \bold {The \\list command and the corresponding \\endlist
- command delimit a list of items.}
+
+ \section1 \\list
+ \target list-command
+
+ The \\list command and the corresponding \\endlist
+ command delimit a list of items.
You need to create each list item explicitly using the \l
- {o} {\\o} command. A list can contain one or more items; it
+ {o-command} {\\o} command. A list can contain one or more items; it
can also be nested. For example:
\code
@@ -2918,7 +2822,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list
\o Qt Reference Documentation: Getting Started
@@ -3009,7 +2913,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list G
\o How to Learn Qt
@@ -3017,26 +2921,28 @@
\o Tutorial and Examples
\endlist
- See also \l {o} {\\o}.
+ See also \l {o-command} {\\o}.
- \row
- \o \bold \\o \target o
- \o \bold {The \\o command announce a table or list item.}
- Earlier we used the \l {i} {\\i} command for this purpose. For more
+ \section1 \\o
+ \target o-command
+
+ The \\o command announce a table or list item.
+
+ Earlier we used the \l {i-command} {\\i} command for this purpose. For more
information see the \l
{26-qdoc-commands-compatibility.html#o-versus-i} {compatibility}
section.
- The command can only be used within the \l{table}
- {\\table...\\endtable} or \l{list} {\\list... \\endlist}
+ The command can only be used within the \l{table-command}
+ {\\table...\\endtable} or \l{list-command} {\\list... \\endlist}
commands.
It considers everything until the next occurrence
of the \\o command, or the currently applicable \l
- {table} {\\endtable} or \l {list} {\\endlist} command, as its
- argument. For examples, see \l {table} {\\table} and \l
- {list} {\\list}.
+ {table-command} {\\endtable} or \l {list-command} {\\endlist} command, as its
+ argument. For examples, see \l {table-command} {\\table} and \l
+ {list-command} {\\list}.
If the command is used within a table, you can in addition
specify how many rows or columns the item should span. For
@@ -3060,7 +2966,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -3091,45 +2997,28 @@
If not specified, the item will span one column and one row.
- See also \l {table} {\\table}, \l {header} {\\header},
- \l {list} {\\list} and \l {o} {\\o}.
- \endtable
+ See also \l {table-command} {\\table}, \l {header-command} {\\header},
+ \l {list-command} {\\list} and \l {o-command} {\\o}.
+
*/
/*!
- \page 11-qdoc-commands-documentcontents.html
- \previouspage Container Commands
+ \page 11-qdoc-commands-specialcontent.html
+ \previouspage Tables and Lists
\contentspage Table of Contents
- \nextpage Miscellaneous Commands
+ \nextpage Miscellaneous
- \title Document Contents Commands
+ \title Special Content
The document contents commands identify parts of the documentation,
i.e. parts with a special rendering, conceptual meaning or
function.
- \section1 Alphabetical List
-
- \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
- \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
- \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
- \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
- \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents},
- \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
- \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\abstract
+ \target abstract-command
- \row
- \o \bold \\abstract \target abstract
- \o \bold {The \\abstract command and the corresponding \\endabstract
- command delimit a document's abstract section.}
+ The \\abstract and \\endabstract commands delimit a
+ document's abstract section.
The abstract section is rendered as an indented italicized
paragraph.
@@ -3138,54 +3027,64 @@
have not been implemented. The abstract section is rendered as a
regular HTML paragraph.
- \row
- \o \bold \\quotation \target quotation
- \o \bold { The \\quotation command and the corresponding
- \\endquotation command delimit a quotation remark.}
- This command replaces the old \\quote command. For more
- information see the \l
- {26-qdoc-commands-compatibility.html#quotation-versus-quote}
- {compatibility} section.
+ \section1 \\quotation
+ \target quotation-command
- The remark is rendered as a separate centered
- paragraph. For example:
+ The \\quotation and \\endquotation commands delimit a long quotation.
- \code
- / *!
- While the prospect of a significantly broader market is
- good news for Firstlogic, the notion also posed some
- challenges. Dave Dobson, director of technology for the La
- Crosse, Wisconsin-based company, said:
+ The text in the delimited block is surrounded by \bold{<blockquote>}
+ and \bold{</blockquote>} in the html output, e.g.:
+ \code
+ / *!
+ While the prospect of a significantly broader market is
+ good news for Firstlogic, the notion also posed some
+ challenges. Dave Dobson, director of technology for the La
+ Crosse, Wisconsin-based company, said:
+
+ \quotation
+ As our solutions were being adopted into new
+ environments, we saw an escalating need for easier
+ integration with a wider range of enterprise
+ applications.
+ \endquotation
+ * /
+ \endcode
- \quotation
- As our solutions were being adopted into new
- environments, we saw an escalating need for easier
- integration with a wider range of enterprise
- applications.
- \endquotation
- * /
- \endcode
+ The text in the \bold{\\quotation} block will appear in the generated HTML as:
- will be rendered as
+ \code
+ <blockquote>
+ <p>As our solutions were being adopted into new environments,
+ we saw an escalating need for easier integration with a wider
+ range of enterprise applications.</p>
+ </blockquote>
+ \endcode
- While the prospect of a significantly broader market is
- good news for Firstlogic, the notion also posed some
- challenges. Dave Dobson, director of technology for the La
- Crosse, Wisconsin-based company, said:
+ The built-in style sheet for most browsers will render the
+ contents of the <blockquote> tag with left and right
+ indentations. The example above would be rendered as:
- \quotation
- As our solutions were being adopted into new
- environments, we saw an escalating need for easier
- integration with a wider range of enterprise
- applications.
- \endquotation
+ \quotation
+ As our solutions were being adopted into new
+ environments, we saw an escalating need for easier
+ integration with a wider range of enterprise
+ applications.
+ \endquotation
- \row
- \o \bold \\footnote \target footnote
- \o \bold {The \\footnote command and the corresponding
- \\endfootnote command delimit a footnote.}
+ But you can redefine the \bold{<blockquote>} tag in your style.css file.
+
+ This command replaces the old \\quote command. For more information
+ see the \l {26-qdoc-commands-compatibility.html#quotation-versus-quote}
+ {compatibility} section.
+
+
+ \section1 \\footnote
+ \target footnote-command
+
+ The \\footnote command and the corresponding
+ \\endfootnote command delimit a footnote.
The footnote is rendered at the bottom of the page.
@@ -3193,19 +3092,23 @@
commands have not been implemented. The footnote is
rendered as a regular HTML paragraph.
- \row
- \o \bold \\tableofcontents \target tableofcontents
- \o \bold {The \\tableofcontents command has been disabled because QDoc
- now generates a table of contents automatically.}
+
+ \section1 \\tableofcontents
+ \target tableofcontents-command
+
+ The \\tableofcontents command has been disabled because QDoc
+ now generates a table of contents automatically.
The automatically generated table of contents appears in the upper
righthand corner of the page.
- \row
- \o \bold \\brief \target brief-command
- \o \bold {The \\brief command introduces a one-sentence
- description of a class, namespace, header file, property
- or variable.}
+
+ \section1 \\brief
+ \target brief-command
+
+ The \\brief command introduces a one-sentence
+ description of a class, namespace, header file, property
+ or variable.
The brief text is used to introduce the documentation of
the associated object, and in lists generated using the \l
@@ -3219,9 +3122,10 @@
\target brief-property
When the \\brief command is used to describe a property or
- a variable, the brief text must only be a sentence fragment
- and start with "whether" (for boolean properties and
- variables) or "the" (for any other property or variable).
+ a variable, the brief text must be a sentence fragment
+ starting with "whether" (for a boolean property or
+ variable) or starting with "the" (for any other property
+ or variable).
For example the boolean QWidget::isWindow property:
@@ -3258,7 +3162,7 @@
* /
\endcode
- The latter will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3321,7 +3225,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3406,7 +3310,7 @@
<h3>PreviewWindow(QWidget *parent = 0)</h3>
\endraw
- Constructs a preview window widget with \i parent.
+ Constructs a preview window widget with \e parent.
\target function
\raw HTML
@@ -3448,105 +3352,84 @@
* /
\endcode
- See also \l{property} {\\property}, \l{class-command} {\\class},
- \l{namespace} {\\namespace} and \l{headerfile} {\\headerfile}.
-
- \row
- \o \bold \\legalese \target legalese
- \o \bold {The \\legalese command, and the corresponding \\endlegalese
- command, delimit a licence agreement.}
-
- If the \\endlegalese command is omitted, QDoc will still
- process the \\legalese command but considers the rest of
- the documentation page as the license agreement.
-
- Ideally, the license documentation is located where the
- licensed code is used.
-
- Later the documentation identified by the \\legalese
- command can be accumulated into a list using the \l
- {generatelist-command} {\\generatelist} command with the \c legalese
- argument. This is useful to generate an overview of all the
- licenses associated with the source code.
-
- For example:
-
- \code
- \ * !
- ...
-
- On X11, Qt also supports drops via the Motif Drag \&
- Drop Protocol. The implementation incorporates some
- code that was originally written by Daniel Dardailler,
- and adapted for Qt by Matt Koss \<koss@napri.sk\> and
- Trolltech. Here is the original copyright notice:
-
- \legalese
- \code
-
- Copyright 1996 Daniel Dardailler.
-
- Permission to use, copy, modify, distribute, and sell
- this software for any purpose is hereby granted without
- fee, provided that the above copyright notice appear in
- all copies and that both that copyright notice and this
- permission notice appear in supporting documentation,
- and that the name of Daniel Dardailler not be used in
- advertising or publicity pertaining to distribution of
- the software without specific, written prior
- permission. Daniel Dardailler makes no representations
- about the suitability of this software for any
- purpose. It is provided "as is" without express or
- implied warranty.
-
- Modifications Copyright 1999 Matt Koss, under the same
- license as above.
-
- \ endcode
- \endlegalese
- * /
- \endcode
-
- will be rendered as
+ See also \l{property-command} {\\property}, \l{class-command} {\\class},
+ \l{namespace-command} {\\namespace} and \l{headerfile-command} {\\headerfile}.
- \quotation
- ...
- On X11, Qt also supports drops via the Motif Drag \&
- Drop Protocol. The implementation incorporates some
- code that was originally written by Daniel Dardailler,
- and adapted for Qt by Matt Koss \<koss@napri.sk\> and
- Trolltech. Here is the original copyright notice:
-
- \legalese
- \code
+ \section1 \\legalese
+ \target legalese-command
- Copyright 1996 Daniel Dardailler.
+ The \\legalese and \\endlegalese commands delimit a licence agreement.
- Permission to use, copy, modify, distribute, and sell
- this software for any purpose is hereby granted without
- fee, provided that the above copyright notice appear in
- all copies and that both that copyright notice and this
- permission notice appear in supporting documentation,
- and that the name of Daniel Dardailler not be used in
- advertising or publicity pertaining to distribution of
- the software without specific, written prior
- permission. Daniel Dardailler makes no representations
- about the suitability of this software for any
- purpose. It is provided "as is" without express or
- implied warranty.
+ In the generated HTML, the delimited text is surrounded by a
+ \bold {<div class="LegaleseLeft">} and \bold {</div>} tags.
- Modifications Copyright 1999 Matt Koss, under the same
- license as above.
+ For example, here is a license agreement enclosed in \\legalese and
+ \\endlegalese:
- \endcode
- \endlegalese
- \endquotation
+ \code
+ / *!
+ \legalese
+ Copyright 1996 Daniel Dardailler.
+
+ Permission to use, copy, modify, distribute, and sell this
+ software for any purpose is hereby granted without fee,
+ provided that the above copyright notice appear in all
+ copies and that both that copyright notice and this
+ permission notice appear in supporting documentation, and
+ that the name of Daniel Dardailler not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission. Daniel
+ Dardailler makes no representations about the suitability of
+ this software for any purpose. It is provided "as is"
+ without express or implied warranty.
+
+ Modifications Copyright 1999 Matt Koss, under the same
+ license as above.
+ \endlegalese
+ * /
+ \endcode
- \row
- \o \bold \\warning \target warning
- \o \bold {The \\warning command renders a "Warning:" prefix to
- the command's argument.}
+ It will appear in the generated HTML as:
+
+ \code
+ <div class="LegaleseLeft">
+ <p>Copyright 1996 Daniel Dardailler.</p>
+ <p>Permission to use, copy, modify, distribute, and sell
+ this software for any purpose is hereby granted without fee,
+ provided that the above copyright notice appear in all
+ copies and that both that copyright notice and this
+ permission notice appear in supporting documentation, and
+ that the name of Daniel Dardailler not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission. Daniel
+ Dardailler makes no representations about the suitability of
+ this software for any purpose. It is provided "as is"
+ without express or implied warranty.</p>
+
+ <p>Modifications Copyright 1999 Matt Koss, under the same
+ license as above.</p>
+ </div>
+ \endcode
+
+ If the \\endlegalese command is omitted, QDoc will still
+ process the \\legalese command but considers the rest of the
+ documentation page as the license agreement.
+
+ Ideally, the license text is located with the licensed code.
+
+ Elsewhere, the documentation identified as \e{\\legalese}
+ command can be accumulated using \l {generatelist-command}
+ {\\generatelist} with \c {legalese-command} as the argument. This is
+ useful for generating an overview of the license agreements
+ associated with the source code.
+
+
+ \section1 \\warning
+ \target warning-command
+
+ The \\warning command renders a "Warning:" prefix to
+ the command's argument.
For example:
@@ -3561,7 +3444,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt::HANDLE is a platform-specific handle type
@@ -3571,45 +3454,26 @@
\warning Using this type is not portable.
\endquotation
- \endtable
+
*/
/*!
\page 12-0-qdoc-commands-miscellaneous.html
- \previouspage Document Contents Commands
+ \previouspage Special Content
\contentspage Table of Contents
- \nextpage Topical Commands
+ \nextpage The QDoc Configuration File
- \title Miscellaneous Commands
+ \title Miscellaneous
These commands provide miscellaneous functions
connected to the visual appearance of the documentation, and to the
process of generating the documentation.
- \section1 Alphabetical List
-
- \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
- \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
- \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
- \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
- \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode}
+ \section1 \\expire
+ \target expire-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\expire \target expire
- \o \bold {The \\expire command allows you to define an expiration
- date for your documentation.}
+ The \\expire command allows you to define an expiration
+ date for your documentation.
When using the \\expire command, QDoc will emit a warning
when the current date is larger than the specified
@@ -3639,10 +3503,12 @@
porting.qdoc:6: Documentation expired 185 days ago
\endquotation
- \row
- \o \bold \\generatelist \target generatelist-command
- \o \bold {The \\generatelist command expands to a list of
- various documentation or links to documentation.}
+
+ \section1 \\generatelist
+ \target generatelist-command
+
+ The \\generatelist command expands to a list of
+ various documentation or links to documentation.
For example in the Qt Reference Documentation:
@@ -3666,8 +3532,7 @@
\target table example
- \list
- \o \c annotatedclasses
+ \section2 \c annotatedclasses
The \c annotatedclasses argument provides a table
containing the names of all the classes, and a
@@ -3676,6 +3541,18 @@
For example:
+ \table
+ \row
+ \o QDial
+ \o Rounded range control (like a speedometer or potentiometer)
+ \row
+ \o QDialog
+ \o The base class of dialog windows
+ \row
+ \o QDir
+ \o Access to directory structures and their contents
+ \endtable
+
\quotation
\raw HTML
<table align="center" cellpadding="2"
@@ -3717,7 +3594,7 @@
\target list example
- \o \c classes
+ \section2 \c classes
The \c classes argument provides a complete alphabetical
list of the classes. Each class name is a link to the
@@ -3768,7 +3645,7 @@
A class is identified within the documentation by the
the \l {class-command} {\\class} command.
- \o \c classesbymodule
+ \section2 \c classesbymodule
This particular argument requests an additional argument,
i.e. a specification of the module.
@@ -3805,7 +3682,7 @@
is related to a module with the \l
{inmodule-command} {\\inmodule} command.
- \o \c classesbyedition
+ \section2 \c classesbyedition
This particular argument requests an additional argument,
i.e. a specification of the edition.
@@ -3829,20 +3706,20 @@
The edition a given class can be found in is determined by
the module it belongs to.
- \o \c compatclasses
+ \section2 \c compatclasses
The \c compatclasses argument provides a complete and
alphabetical list of the support classes. A support
class is identified within the documentation by the \l
- {compat} {\\compat} command. Each class name is a link to
- the class's reference documentation. The list is
- rendered similarily to the list generated by the \l
+ {compat-command} {\\compat} command. Each class name is
+ a link to the class's reference documentation. The list
+ is rendered similarily to the list generated by the \l
{list example} {\c classes} argument.
\warning The \c classesbymodule argument will at some
point replace the this argument.
- \o \c functionindex
+ \section2 \c functionindex
The \c functionindex argument provides a complete
alphabetical list of all the documented member
@@ -3869,11 +3746,11 @@
...
\endquotation
- \o \c legalese
+ \section2 \c legalese
The \c legalese argument provides a complete list of all
the licenses. The licenses are identified within the
- documentation using the \l {legalese} {\\legalese}
+ documentation using the \l {legalese-command} {\\legalese}
command.
For example:
@@ -3928,7 +3805,7 @@
...
\endquotation
- \o \c mainclasses
+ \section2 \c mainclasses
The \c mainclasses argument provides a complete
alphabetical list of the main classes. Each class name
@@ -3939,17 +3816,18 @@
The list is rendered similarily to the list generated by
the \l {list example} {\c classes} argument.
- \o \c overviews
+ \section2 \c overviews
The \c overviews argument provides a complete
alphabetical overview of the documentation. Each list
entry is a link to the respective documentation page.
The list includes pages declared using commands like \l
- {page} {\\page} and \l {group-command} {\\group}. The list omits
- examples and classes, and only lists the first page of
- documentation that contains two or more pages using
- commands like \l {nextpage-command} {\\nextpage}.
+ {page-command} {\\page} and \l {group-command}
+ {\\group}. The list omits examples and classes, and only
+ lists the first page of documentation that contains two
+ or more pages using commands like \l {nextpage-command}
+ {\\nextpage}.
For example:
@@ -4003,37 +3881,36 @@
\endraw
\endquotation
- \o \c related
+ \section2 \c related
The \c related argument is used in combination with the
\l {group-command} {\\group} command to list all the overviews
related to the given group. Each list entry is a link to
the respective documentation page.
- \o \c relatedinline
+ \section2 \c relatedinline
The \c related argument is used in combination with the
\l {group-command} {\\group} command to collect all documentation
related to the given group. The various documentation
snippets are copied directly into the group page.
- \o \c service
+ \section2 \c service
The \c service argument provides a complete alphabetical
list of the services. Each service name is a link to the
service's reference documentation.
A service is identified within the documentation by the
- \l {service} {\\service} command.
+ \l {service-command} {\\service} command.
- \endlist
+ \section1 \\if
+ \target if-command
- \row
- \o \bold \\if \target if-command
- \o \bold {The \\if command and the corresponding \\endif command
- enclose parts of a QDoc comment that only will be included if
- the condition specified by the command's argument is true.}
+ The \\if command and the corresponding \\endif command
+ enclose parts of a QDoc comment that only will be included if
+ the condition specified by the command's argument is true.
The command reads the rest of the line and parses it as an
C++ #if statement. For example:
@@ -4064,27 +3941,32 @@
command line. For more information see the documentation of
the \l {defines-variable} {defines} variable.
- See also \l{endif} {\\endif}, \l{else} {\\else}, \l
- {defines-variable} {defines} and \l {falsehoods-variable}
- {falsehoods}.
+ See also \l{endif-command} {\\endif}, \l{else-command}
+ {\\else}, \l {defines-variable} {defines} and \l
+ {falsehoods-variable} {falsehoods}.
- \row
- \o \bold \\endif \target endif
- \o \bold {The \\endif command and the corresponding \\if command
- enclose parts of a QDoc comment that will be included if
- the condition specified by the \l {if-command} {\\if} command's
- argument is true.}
+
+ \section1 \\endif
+ \target endif-command
+
+ The \\endif command and the corresponding \\if command
+ enclose parts of a QDoc comment that will be included if
+ the condition specified by the \l {if-command} {\\if} command's
+ argument is true.
For more information, see the documentation of the \l
{if-command} {\\if} command.
- See also \l{if-command} {\\if}, \l{else} {\\else}, \l
- {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}.
+ See also \l{if-command} {\\if}, \l{else-command} {\\else},
+ \l {defines-variable} {defines} and \l
+ {falsehoods-variable} {falsehoods}.
- \row
- \o \bold \\else \target else
- \o \bold {The \\else command specifies an alternative if the
- condition in the \l {if-command} {\\if} command is false.}
+
+ \section1 \\else
+ \target else-command
+
+ The \\else command specifies an alternative if the
+ condition in the \l {if-command} {\\if} command is false.
The \\else command can only be used within \l
{if-command} {\\if...\\endif} commands, but is useful when there is
@@ -4136,7 +4018,7 @@
\endquotation
If \c QT3_SUPPORT isn't defined but \c QT3_SUPPORT_WARNINGS
- is, the comment will be rendered as
+ is, the comment QDoc renders this as:
\quotation
The Qt 3 support library is provided to keep old source
@@ -4175,14 +4057,16 @@
GCC 3.2+ and MSVC 7.)
\endquotation
- See also \l{if-command} {\\if}, \l{endif} {\\endif}, \l
+ See also \l{if-command} {\\if}, \l{endif-command} {\\endif}, \l
{defines-variable} {defines} and \l {falsehoods-variable}
{falsehoods}.
- \row
- \o \bold \\include \target include
- \o \bold {The \\include command expands to the contents of the
- file specified by the command's argument.}
+
+ \section1 \\include
+ \target include-command
+
+ The \\include command expands to the contents of the
+ file specified by the command's argument.
\warning This is preliminary functionality. For more
information, see the \l
@@ -4214,31 +4098,33 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
<h1>Core Features</h1>
\endraw
- \include examples/signalandslots.qdocinc
- \include examples/objectmodel.qdocinc
- \include examples/layoutmanagement.qdocinc
+ \input examples/signalandslots.qdocinc
+ \input examples/objectmodel.qdocinc
+ \input examples/layoutmanagement.qdocinc
\endquotation
Here is the actual \c .qdocinc files: \l
signalandslots.qdocinc, \l objectmodel.qdocinc, \l
layoutmanagement.qdocinc
- \row
- \o \bold \\meta \target meta
- \o \bold {The \\meta command is the QDoc equivalent to the HTML
- \c meta tag.}
+
+ \section1 \\meta
+ \target meta-command
+
+ The \\meta command is the QDoc equivalent to the HTML
+ \c meta tag.
The command accepts two arguments: The first argument (the
- following word) is equivalent to the HTML meta tag's \i
+ following word) is equivalent to the HTML meta tag's \e
name variable, and the second argument (the rest of the
- line) is equivalent to the tag's \i contents variable.
+ line) is equivalent to the tag's \e contents variable.
For example:
@@ -4274,11 +4160,13 @@
</head>
\endcode
- \row
- \o \bold \\omit \target omit
- \o \bold {The \\omit command and the correspondning \\endomit
- command delimit parts of the documentation that
- you want QDoc to skip.}
+
+ \section1 \\omit
+ \target omit-command
+
+ The \\omit command and the correspondning \\endomit
+ command delimit parts of the documentation that
+ you want QDoc to skip.
For example:
@@ -4304,7 +4192,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -4324,16 +4212,19 @@
\endraw
- \row
- \o \bold \\raw \span {class="newStuff"} {(avoid)} \target raw
- \o \bold {The \\raw command and the corresponding
- \\endraw command delimit a block of raw mark-up language code.}
+
+ \section1 \\raw \span {class="newStuff"} {(avoid)}
+ \target raw-command
+
+ The \\raw command and the corresponding
+ \\endraw command delimit a block of raw mark-up language code.
\note Avoid using this command if possible, because it generates
DITA XML code that causes problems. If you are trying to generate
special table or list behavior, try to get the behavior you want
- using the \l {span} {\\span} and \l {div} {\\div} commands in your
- \l {table} {\\table} or \l {list} {\\list}.
+ using the \l {span-command} {\\span} and \l {div-command} {\\div}
+ commands in your \l {table-command} {\\table} or \l {list-command}
+ {\\list}.
The command takes an argument specifying the code's format;
currently the only supported format is HTML.
@@ -4361,7 +4252,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt has some predefined QColor objects. For example:
@@ -4397,10 +4288,12 @@
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
- \row
- \o \bold \\unicode \target unicode
- \o \bold {The \\unicode command allows you to insert an
- arbitrary Unicode character in the document.}
+
+ \section1 \\unicode
+ \target unicode-command
+
+ The \\unicode command allows you to insert an
+ arbitrary Unicode character in the document.
The command takes an argument specifying the character as
an integer. By default, base 10 is assumed, unless a '0x'
@@ -4412,24 +4305,24 @@
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
- \unicode 0x3A3 \i{a}\sub{\i{i}}
+ \unicode 0x3A3 \e{a}\sub{\e{i}}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
O G\unicode{0xEA}nio e as Rosas
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
- \unicode 0x3A3 \i{a}\sub{\i{i}}
+ \unicode 0x3A3 \e{a}\sub{\e{i}}
\endquotation
- \endtable
+
*/
/*!
\page 12-1-signalandslots.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title signalandslots.qdocinc
@@ -4439,7 +4332,7 @@
/*!
\page 12-2-objectmodel.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title objectmodel.qdocinc
@@ -4449,7 +4342,7 @@
/*!
\page 12-3-layoutmanagement.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title layoutmanagement.qdocinc
@@ -4458,48 +4351,30 @@
*/
/*!
- \page 13-qdoc-commands-topical.html
- \previouspage Miscellaneous Commands
+ \page 13-qdoc-commands-topics.html
+ \previouspage The QDoc Commands
\contentspage Table of Contents
- \nextpage Contextual Commands
+ \nextpage Context Commands
- \title Topical Commands
+ \title Topic Commands
- The topical commands tell QDoc what is being documented
+ The topic commands tell QDoc what is being documented
(i.e. existing units like classes, functions and examples), and
some of the commands allows you to create extra pages.
- \section1 Alphabetical List
-
- \l {13-qdoc-commands-topical.html#class-command} {\\class},
- \l {13-qdoc-commands-topical.html#enum-command} {\\enum},
- \l {13-qdoc-commands-topical.html#example-command} {\\example},
- \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage},
- \l {13-qdoc-commands-topical.html#fn} {\\fn},
- \l {13-qdoc-commands-topical.html#group-command} {\\group},
- \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile},
- \l {13-qdoc-commands-topical.html#macro} {\\macro},
- \l {13-qdoc-commands-topical.html#module} {\\module},
- \l {13-qdoc-commands-topical.html#namespace} {\\namespace},
- \l {13-qdoc-commands-topical.html#page} {\\page},
- \l {13-qdoc-commands-topical.html#property} {\\property},
- \l {13-qdoc-commands-topical.html#service} {\\service},
- \l {13-qdoc-commands-topical.html#typedef} {\\typedef},
- \l {13-qdoc-commands-topical.html#variable} {\\variable},
-
\section1 General Description
When QDoc is processing a comment, it will try to connect the
documentation to the source code. For that reason it will first
- look for the topical commands. If there is no such command, it
+ look for the topic commands. If there is no such command, it
will try to tie the documentation to the immediately following
- code. If there is no topical command, and the documentation cannot
+ code. If there is no topic command, and the documentation cannot
be tied to following code, the documentation is simply lost.
- \target topical argument
+ \target topic argument
The documented unit's name is passed as the unique argument for
- all the topical commands. The argument's naming convention is the
+ all the topic commands. The argument's naming convention is the
documented unit's complete name. For example:
\code
@@ -4507,21 +4382,21 @@
\endcode
Functions is a special case, the argument's naming convention for
- the \l {fn} {\\fn} command is that of the function's definition
- outside the class definition. For example:
+ the \l {fn-command} {\\fn} command is that of the function's
+ definition outside the class definition. For example:
\code
\fn void PreviewWindow::setWindowFlags()
\endcode
- A topical command can appear anywhere in a comment, but must stand
+ A topic command can appear anywhere in a comment, but must stand
alone on its own line. If the argument spans several lines, make
sure that each line (except the last one) is ended with a
backslash. In addition QDoc counts parentheses, which means that
if it encounters a '(' it considers everything until the closing
')' as its argument.
- If a topical command is repeated with different arguments, the
+ If a topic command is repeated with different arguments, the
same documentation will appear for both the units. For example:
\code
@@ -4542,21 +4417,15 @@
ControllerWindow::setWindowFlags() functions will get the same
documentation.
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\class
+ \target class-command
- \row
- \o \bold \\class \target class-command
- \o \bold {The \\class command tells QDoc that a class is
- part of the public API, and lets you enter a detailed
- description.}
+ The \\class command tells QDoc that a class is
+ part of the public API, and lets you enter a detailed
+ description.
- The command follows \l {topical argument} {the general
- topical command convention} for the argument, and supports
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument, and supports
nested classes, for example:
\code
@@ -4586,7 +4455,7 @@
The command is typically accompanied with a \l
{brief-command} {\\brief} command, a \l {mainclass-command} {\\mainclass}
command, an \l {ingroup-command} {\\ingroup} command and a \l
- {sa} {\\sa} command. For example:
+ {sa-command} {\\sa} command. For example:
\code
/ *!
@@ -4609,7 +4478,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4695,7 +4564,7 @@
<h3>PreviewWindow(QWidget *parent = 0)</h3>
\endraw
- Constructs a preview window widget with \i parent.
+ Constructs a preview window widget with \e parent.
\target function
\raw HTML
@@ -4711,12 +4580,14 @@
the text in the widgets text editor.
\endquotation
- \row
- \o \bold \\enum \target enum-command
- \o \bold {The \\enum command allows you to document a C++ enum.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\enum
+ \target enum-command
+
+ The \\enum command allows you to document a C++ enum.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The enum items are documented using the \l {value-command} {\\value}
command. If an item isn't documented, QDoc will emit a
@@ -4767,7 +4638,7 @@
* /
\endcode
- this associated QDoc comment will be rendered as
+ this associated QDoc comment QDoc renders this as:
\quotation
\raw HTML
@@ -4814,18 +4685,19 @@
See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
- \row
- \o \bold \\example \target example-command
- \o \bold {The \\example command allows you to document an
- example.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. In particular
+ \section1 \\example
+ \target example-command
+
+ The \\example command allows you to document an example.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. In particular
the command's argument is the example's path relative to
the paths listed in the \l {exampledirs-variable}
{exampledirs} configuration variable.
- The documentation will be located in \i
+ The documentation will be located in \e
{path-to-example}.html, and QDoc will add a list of all the
example files at the top of this documentation page.
@@ -4845,7 +4717,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4870,12 +4742,14 @@
in widgets-imageviewer.html.
- \row
- \o \bold \\fn \target fn
- \o \bold {The \\fn command allows you to document a function.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. In particular
+ \section1 \\fn
+ \target fn-command
+
+ The \\fn command allows you to document a function.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. In particular
it is important that the return type of the function,
whether it is \c const or not and the complete set of
arguments with type are included in the argument. If the
@@ -4883,7 +4757,7 @@
warning.
Also, the \\fn command is QDoc's default command, i.e. when
- no topical command can be found within a QDoc comment, QDoc
+ no topic command can be found within a QDoc comment, QDoc
tries to tie the documentation to the following code as if
it was function documentation.
@@ -4904,7 +4778,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4916,20 +4790,22 @@
\a area; otherwise returns false.
\endquotation
- See also \l {overload} {\\overload}.
+ See also \l {overload-command} {\\overload}.
- \row
- \o \bold \\group \target group-command
- \o \bold {The \\group command creates a separate page that
- lists the classes belonging to the group specified by the
- command's argument.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. The \\group
+ \section1 \\group
+ \target group-command
+
+ The \\group command creates a separate page that
+ lists the classes belonging to the group specified by the
+ command's argument.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. The \\group
command is typically followed by a \l {title-command} {\\title}
command and a short introduction to the group. The
generated HTML documentation for the specified group is put
- in <lower-case>\i{group}.html.
+ in <lower-case>\e{group}.html.
A class can be related to a group by using the \l
{ingroup-command} {\\ingroup} command. In addition, overviews can be
@@ -4953,7 +4829,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5017,15 +4893,17 @@
See also \l {ingroup-command} {\\ingroup} and \l
{generatelist-command} {\\generatelist}.
- \row
- \o \bold \\headerfile \target headerfile
- \o \bold {The \\headerfile command allows you to document
- global functions, types and macros declared in a header file.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument, and the
+ \section1 \\headerfile
+ \target headerfile-command
+
+ The \\headerfile command allows you to document
+ global functions, types and macros declared in a header file.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument, and the
generated HTML documentation for the specified header file
- is put in <lower-case>\i{headerfilename}.html.
+ is put in <lower-case>\e{headerfilename}.html.
A function, type or macro can be associated with a
headerfile using the \l {relates-command} {\\relates} command.
@@ -5051,7 +4929,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5059,7 +4937,7 @@
Generic Algorithms</h1></center>
<p>The <QtAlgorithms> header file provides generic
template-based algorithms.
- <a href="13-qdoc-commands-topical.html#header">More...</a>
+ <a href="13-qdoc-commands-topics.html#header-command">More...</a>
</p>
<h3>Functions</h3>
@@ -5089,12 +4967,14 @@
in qtalgorithms.html.
- \row
- \o \bold \\macro \target macro
- \o \bold {The \\macro command allows you to document a C++ macro.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\macro
+ \target macro-command
+
+ The \\macro command allows you to document a C++ macro.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
QDoc recognizes three different macro syntax: function-like
macros like Q_ASSERT(), declaration-style macros like
@@ -5121,7 +5001,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5152,7 +5032,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5185,7 +5065,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5205,14 +5085,16 @@
in qobject.html.
- \row
- \o \bold \\module \target module
- \o \bold {The \\module creates a separate page that lists the
- classes belonging to the module specified by the command's
- argument.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\module
+ \target module-command
+
+ The \\module creates a separate page that lists the
+ classes belonging to the module specified by the command's
+ argument.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
A class can be related to a module using the \l
{inmodule-command} {\\inmodule} command.
@@ -5243,7 +5125,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5310,18 +5192,19 @@
See also \l {inmodule-command} {\\inmodule}
- \row
- \o \bold \\namespace \target namespace
- \o \bold {The \\namespace command allows you to document a C++
- namespace.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\namespace
+ \target namespace-command
+
+ The \\namespace command allows you to document a C++ namespace.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
QDoc will generate the same additional links and
documentation for all the members of the namespace as it
does for \l {framework} {classes}. The documentation for
- the specified namespace is put in <lower-case>\i
+ the specified namespace is put in <lower-case>\e
{namespace}.html.
For example:
@@ -5335,14 +5218,14 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
<center><h1>Qt Namespace Reference</h1></center>
<p>The Qt namespace contains miscellaneous
identifiers used throughout the Qt library.
- <a href="13-qdoc-commands-topical.html#name">More...</a>
+ <a href="13-qdoc-commands-topics.html#name">More...</a>
</p>
<pre>#include <Qt></pre>
@@ -5374,13 +5257,14 @@
in qt.html.
- \row
- \o \bold \\page \target page
- \o \bold {The \\page command allows you to create a stand-alone
- documentation page.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\page
+ \target page-command
+
+ The \\page command allows you to create a stand-alone documentation page.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The page's title can be set using the \l {title-command} {\\title}
command. For example:
@@ -5410,13 +5294,14 @@
will be rendered in its own HTML file: \l{About Qt}.
- \row
- \o \bold {\\externalpage} \target externalpage
- \o \bold {The \\externalpage command gives a title to
- an external URL.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\externalpage
+ \target externalpage-command
+
+ The \\externalpage command gives a title to an external URL.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
For example:
@@ -5438,7 +5323,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The broad scope of the \l
@@ -5464,13 +5349,14 @@
documentation. If the adress changes, you only need to change the
argument of the \\externalpage command.
- \row
- \o \bold \\property \target property
- \o \bold {The \\property command allows you to document a Qt
- property.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\property
+ \target property-command
+
+ The \\property command allows you to document a Qt property.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
A property is defined using the Q_PROPERTY() macro. The
macro takes as arguments the property's name and its set,
@@ -5492,9 +5378,9 @@
property, the \l {brief-command} {\\brief} command's
argument is a sentence fragment that will be included in a
one-sentence description of the property generated by
- QDoc. The command follows the same rules for the
- \l {brief-property} {description} as the \l {variable}
- {\\variable} command.
+ QDoc. The command follows the same rules for the \l
+ {brief-property} {description} as the \l {variable-command}
+ {\\variable} command.
For example:
@@ -5507,7 +5393,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5541,7 +5427,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5566,12 +5452,13 @@
in qwidget.html.
- \row
- \o \bold \\service \target service
- \o \bold {The \\service command tells QDoc that a class is a
- service class and specifies its alias, i.e. the associated
- service's name.}
+ \section1 \\service
+ \target service-command
+
+ The \\service command tells QDoc that a class is a
+ service class and specifies its alias, i.e. the associated
+ service's name.
The command takes two arguments, the service class's name
and the associated alias. For example:
@@ -5590,13 +5477,14 @@
See also \l {class-command} {\\class} and \l
{generatelist-command} {\\generatelist}.
- \row
- \o \bold \\typedef \target typedef
- \o \bold {The \\typedef command allows you to document a C++ type
- definition.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\typedef
+ \target typedef-command
+
+ The \\typedef command allows you to document a C++ type definition.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The documentation will be located in the associated class,
header file or namespace documentation. When documenting a
@@ -5613,7 +5501,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5641,7 +5529,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5672,7 +5560,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5684,19 +5572,21 @@
in qlinkedlist.html.
- \row
- \o \bold \\variable \target variable
- \o \bold {The \\variable command allows you to document a
- member variable or a constant.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\variable
+ \target variable-command
+
+ The \\variable command allows you to document a
+ member variable or a constant.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The \\variable command is typically followed by a
\l {brief-command} {\\brief} command; QDoc will generate the
documentation for the variable based on the brief command
description. The command follows the same rules for the
- \l {brief-property} {description} as the \l {property}
+ \l {brief-property} {description} as the \l {property-command}
{\\property} command.
The documentation will be located in the in the associated
@@ -5712,7 +5602,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5763,7 +5653,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5792,77 +5682,71 @@
\endquotation
in qtreewidget.html.
- \endtable
+
*/
/*!
- \page 14-qdoc-commands-contextualcommands.html
- \previouspage Topical Commands
+ \page 14-qdoc-commands-contextcommands.html
+ \previouspage Topic Commands
\contentspage Table of Contents
- \nextpage Navigation Commands
+ \nextpage Navigating
- \title Contextual Commands
+ \title Context Commands
- The contextual commands provide QDoc with information, that it
+ The context commands provide QDoc with information, that it
wouldn't figure out otherwise, about the documented object. For
example whether a class is thread-safe or not.
These commands can appear anywhere within a QDoc comment.
- \section1 Alphabetical List
-
- \l {16-qdoc-commands-status.html#compat} {\\compat},
- \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
- \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
- \l {16-qdoc-commands-status.html#internal} {\\internal},
- \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
- \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
- \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
- \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
- \l {18-qdoc-commands-relating.html#overload} {\\overload},
- \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
- \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
- \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
- \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
- \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
- \l {15-qdoc-commands-navigation.html#startpage} {\\startpage},
- \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe},
- \l {20-qdoc-commands-title.html#title-command} {\\title}
-
\section1 Categories
\list
- \o \l {Navigation Commands}
- \o \l {Status Commands}
- \o \l {Thread Support Commands}
- \o \l {Relating Commands}
- \o \l {Grouping Commands}
- \o \l {Title Commands}
+ \o \l {Navigating}
+ \o \l {Reporting Status}
+ \o \l {Thread Support}
+ \o \l {Relating Things}
+ \o \l {Grouping Things}
+ \o \l {Naming Things}
+ \endlist
+
+ \section1 Command List
+
+ \list
+ \o \l {16-qdoc-commands-status.html#compat-command} {\\compat}
+ \o \l {15-qdoc-commands-navigation.html#contentspage-command} {\\contentspage}
+ \o \l {15-qdoc-commands-navigation.html#indexpage-command} {\\indexpage}
+ \o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
+ \o \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule}
+ \o \l {16-qdoc-commands-status.html#internal-command} {\\internal}
+ \o \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass}
+ \o \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage}
+ \o \l {17-qdoc-commands-thread.html#nonreentrant-command} {\\nonreentrant}
+ \o \l {16-qdoc-commands-status.html#obsolete-command} {\\obsolete}
+ \o \l {18-qdoc-commands-relating.html#overload-command} {\\overload}
+ \o \l {16-qdoc-commands-status.html#preliminary-command} {\\preliminary}
+ \o \l {15-qdoc-commands-navigation.html#previouspage-command} {\\previouspage}
+ \o \l {17-qdoc-commands-thread.html#reentrant-command} {\\reentrant}
+ \o \l {18-qdoc-commands-relating.html#reimp-command} {\\reimp}
+ \o \l {18-qdoc-commands-relating.html#relates-command} {\\relates}
+ \o \l {15-qdoc-commands-navigation.html#startpage-command} {\\startpage}
+ \o \l {17-qdoc-commands-thread.html#threadsafe-command} {\\threadsafe}
+ \o \l {20-qdoc-commands-namingthings.html#title-command} {\\title}
\endlist
*/
/*!
\page 15-qdoc-commands-navigation.html
- \previouspage Contextual Commands
+ \previouspage Context Commands
\contentspage Table of Contents
- \nextpage Status Commands
+ \nextpage Reporting Status
- \title Navigation Commands
+ \title Navigating
The navigation commands allow you to link the pages of a multipage
document together. They provide the components of a navigation bar
at the top and bottom of the document. They also provide browser
and search engine support.
- \section1 Alphabetical List
-
- \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
- \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
- \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
- \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
-
\section1 General Description
The QDoc comments below shows a typical example using the
@@ -5938,7 +5822,7 @@
\endcode
The second page of this multipage document, "Getting Started",
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5975,8 +5859,8 @@
in creatingdialogs.html.
- In addition, the \l {indexpage} {\\indexpage} and \l
- {startpage} {\\startpage} commands specifies links to the page's
+ In addition, the \l {indexpage-command} {\\indexpage} and \l
+ {startpage-command} {\\startpage} commands specifies links to the page's
index page and start page. These links are used by browsers and
search engines.
@@ -5996,17 +5880,11 @@
</head>
\endcode
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\previouspage
+ \target previouspage-command
- \row
- \o \bold \\previouspage \target previouspage
- \o \bold {The \\previouspage command links the current page
- to the previous one in an ordered series of documents}.
+ The \\previouspage command links the current page
+ to the previous one in an ordered series of documents.
The command has two arguments, each enclosed by curly
braces: The first is the link target, i.e. the title of the
@@ -6020,20 +5898,24 @@
the current page. For an example, see the \l {General
Description} section.
- \row
- \o \bold \\nextpage \target nextpage-command
- \o \bold {The \\nextpage command links the current
- page to the next page in an ordered series of documents}.
+
+ \section1 \\nextpage
+ \target nextpage-command
+
+ The \\nextpage command links the current
+ page to the next page in an ordered series of documents.
The command follows the same syntax and argument convention
- as the \l {previouspage} {\\previouspage} command.
+ as the \l {previouspage-command} {\\previouspage} command.
For an example, see the \l {General Description} section.
- \row
- \o \bold \\startpage \target startpage
- \o \bold {The \\startpage command specifies the first document
- in a collection of documents.}
+
+ \section1 \\startpage
+ \target startpage-command
+
+ The \\startpage command specifies the first document
+ in a collection of documents.
The command must stand alone on its own line, and its
unique argument is the title of the first document.
@@ -6046,20 +5928,24 @@
For an example, see the \l {General Description} section.
- \row
- \o \bold \\contentspage \target contentspage
- \o \bold {The \\contentspage command links the current
- page to a contents page}.
+
+ \section1 \\contentspage
+ \target contentspage-command
+
+ The \\contentspage command links the current
+ page to a contents page.
The command follows the same syntax and argument convention
- as the \l {previouspage} {\\previouspage} command.
+ as the \l {previouspage-command} {\\previouspage} command.
For an example, see the \l {General Description} section.
- \row
- \o \bold \\indexpage \target indexpage
- \o \bold {The \\indexpage command specifies a document providing
- an index for the current document}.
+
+ \section1 \\indexpage
+ \target indexpage-command
+
+ The \\indexpage command specifies a document providing
+ an index for the current document.
The command must stand alone on its own line, and its
unique argument is the title of the index document.
@@ -6072,16 +5958,16 @@
For an example, see the \l {General Description} section.
- \endtable
+
*/
/*!
\page 16-qdoc-commands-status.html
- \previouspage Navigation Commands
+ \previouspage Navigating
\contentspage Table of Contents
- \nextpage Thread Support Commands
+ \nextpage Thread Support
- \title Status Commands
+ \title Reporting Status
The usage commands can indicate whether a documented object is
under development, becoming obsolete, provided for compatibility
@@ -6089,25 +5975,11 @@
describe the history of minor versions. And they can also describe
a documented object's ability to handle multithreaded programming.
- \section1 Alphabetical List
-
- \l {16-qdoc-commands-status.html#compat} {\\compat},
- \l {16-qdoc-commands-status.html#internal} {\\internal},
- \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
- \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
- \l {16-qdoc-commands-status.html#since} {\\since}
-
- \section1 Command Description
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\preliminary
+ \target preliminary-command
- \row
- \o \bold \\preliminary \target preliminary
- \o \bold {The \\preliminary command indicates that the
- referenced function is under development.}
+ The \\preliminary command indicates that the
+ referenced function is under development.
The command must stand on its own line.
@@ -6129,7 +6001,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6160,12 +6032,14 @@
\endlist
\endquotation
- \row
- \o \bold \\obsolete \target obsolete
- \o \bold {The \\obsolete command indicates that the referenced
- function no longer should be used in new code;
- there is no guarantee for how long it will remain in
- the library.}
+
+ \section1 \\obsolete
+ \target obsolete-command
+
+ The \\obsolete command indicates that the referenced
+ function no longer should be used in new code;
+ there is no guarantee for how long it will remain in
+ the library.
The command must stand on its own line.
@@ -6185,7 +6059,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6216,11 +6090,13 @@
in myclass-obsolete.html
- \row
- \o \bold \\compat \target compat
- \o \bold {The \\compat command indicates that the referenced class
- or function is part of the support library provided to keep
- old source code working.}
+
+ \section1 \\compat
+ \target compat-command
+
+ The \\compat command indicates that the referenced class
+ or function is part of the support library provided to keep
+ old source code working.
The command must stand on its own line.
@@ -6239,7 +6115,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {This class is part of the Qt 3 support
@@ -6266,7 +6142,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6298,10 +6174,12 @@
in myclass-qt3.html
- \row
- \o \bold \\internal \target internal
- \o \bold {The \\internal command indicates that the referenced
- function is not part of the public interface.}
+
+ \section1 \\internal
+ \target internal-command
+
+ The \\internal command indicates that the referenced
+ function is not part of the public interface.
The command must stand on its own line.
@@ -6329,10 +6207,12 @@
in qspinbox.cpp, will not be rendered at all.
- \row
- \o \bold \\since \target since
- \o \bold {The \\since command tells in which minor release
- the associated functionality was added.}
+
+ \section1 \\since
+ \target since-command
+
+ The \\since command tells in which minor release
+ the associated functionality was added.
For example:
@@ -6351,7 +6231,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6379,26 +6259,20 @@
{25-qdoc-configuration-derivedprojects.html#project} {\c
project}.
- \endtable
+
*/
/*!
\page 17-qdoc-commands-thread.html
- \previouspage Status Commands
+ \previouspage Reporting Status
\contentspage Table of Contents
- \nextpage Relating Commands
+ \nextpage Relating Things
- \title Thread Support Commands
+ \title Thread Support
The thread support commands specify the level of support for
multithreaded programming of a class or function.
- \section1 Alphabetical List
-
- \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
- \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
- \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
-
\section1 General Description
There are three levels of support for multithreaded programming of
@@ -6417,10 +6291,10 @@
invocation references shared data.
When a class is declared \c reentrant or \c threadsafe, using the
- \l {reentrant} {\\reentrant} and \l {threadsafe} {\\threadsafe}
+ \l {reentrant-command} {\\reentrant} and \l {threadsafe-command} {\\threadsafe}
commands respectively, functions in the referenced class can be
declared \c nonreentrant, using the \l
- {nonreentrant} {\\nonreentrant} command, excluding the functions
+ {nonreentrant-command} {\\nonreentrant} command, excluding the functions
from the general view.
For example:
@@ -6463,7 +6337,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6525,90 +6399,76 @@
For more information see the general documentation on \l
{threads.html#reentrant} {reentrancy and thread-safety}.
- \section1 Command Descriptions
+ \section1 \\threadsafe
+ \target threadsafe-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\threadsafe \target threadsafe
- \o \bold {The \\threadsafe command indicates that the
- associated class or function can be called simultaneously by
- multiple threads even when each invocation references
- shared data.}
+ The \\threadsafe command indicates that the
+ associated class or function can be called simultaneously by
+ multiple threads even when each invocation references
+ shared data.
The command must stand on its own line.
The generated documentation resulting from using the
\\threadsafe command is similar to the result of using the
- \l {reentrant} {\\reentrant} command. For an example, see
+ \l {reentrant-command} {\\reentrant} command. For an example, see
the \l {General Description} section.
- See also \l{reentrant} {\\reentrant} and
- \l{nonreentrant} {\\nonreentrant}.
+ See also \l{reentrant-command} {\\reentrant} and
+ \l{nonreentrant-command} {\\nonreentrant}.
- \row
- \o \bold \\reentrant \target reentrant
- \o \bold {The \\reentrant command indicates that the associated
- class or function can be called simultaneously
- by multiple threads, provided that each invocation of the
- functions reference unique data.}
+
+ \section1 \\reentrant
+ \target reentrant-command
+
+ The \\reentrant command indicates that the associated
+ class or function can be called simultaneously
+ by multiple threads, provided that each invocation of the
+ functions reference unique data.
The command must stand on its own line.
For an example, see the \l {General Description} section.
- See also \l{nonreentrant} {\\nonreentrant} and
- \l{threadsafe} {\\threadsafe}.
+ See also \l{nonreentrant-command} {\\nonreentrant} and
+ \l{threadsafe-command} {\\threadsafe}.
- \row
- \o \bold \\nonreentrant \target nonreentrant
- \o \bold {The \\nonreentrant command indicates that the
- associated class or function cannot be called by
- multiple threads.}
+
+ \section1 \\nonreentrant
+ \target nonreentrant-command
+
+ The \\nonreentrant command indicates that the
+ associated class or function cannot be called by
+ multiple threads.
The command must stand on its own line.
For an example, see the \l {General Description} section.
- See also \l{reentrant} {\\reentrant} and
- \l{threadsafe} {\\threadsafe}.
+ See also \l{reentrant-command} {\\reentrant} and
+ \l{threadsafe-command} {\\threadsafe}.
+
- \endtable
*/
/*!
\page 18-qdoc-commands-relating.html
- \previouspage Thread Support Commands
+ \previouspage Thread Support
\contentspage Table of Contents
- \nextpage Grouping Commands
+ \nextpage Grouping Things
- \title Relating Commands
+ \title Relating Things
The relation commands discribe how the documented object relates
to its context: Whether it is an overloaded function, a
reimplemented function or a global function related to a specified
class or header file.
- \section1 Alphabetical List
-
- \l {18-qdoc-commands-relating.html#overload} {\\overload},
- \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
- \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\overload
+ \target overload-command
- \row
- \o \bold \\overload \target overload
- \o \bold {The \\overload command indicates that the
- function is a secondary overload of its name.}
+ The \\overload command indicates that the
+ function is a secondary overload of its name.
The command must stand on its own line.
@@ -6621,7 +6481,7 @@
From Qt 4.5, you can include the function name plus '()'
as a parameter to the \bold{\\overload} command, which
- will include a standard \i{This function overloads...}
+ will include a standard \e{This function overloads...}
line of text with a link to the documentation for the
primary version of the function.
@@ -6646,7 +6506,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6659,7 +6519,7 @@
This function overloads \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction} {addAction()}
This convenience function creates a new action with an
- \i icon and some \i text. The function adds the newly
+ \e icon and some \e text. The function adds the newly
created action to the menu's list of actions, and
returns it.
@@ -6679,11 +6539,13 @@
convenience.
\endquotation.
- \row
- \o \bold \\reimp \target reimp
- \o \bold {The \\reimp command indicates that the
- referenced function is a reimplementation of a virtual function,
- where the reimplementation has no effect on the interface.}
+
+ \section1 \\reimp
+ \target reimp-command
+
+ The \\reimp command indicates that the
+ referenced function is a reimplementation of a virtual function,
+ where the reimplementation has no effect on the interface.
The command must stand on its own line.
@@ -6708,10 +6570,12 @@
QAbstractButton::nextCheckState() will appear in the
documentation.
- \row
- \o \bold \\relates \target relates-command
- \o \bold {The \\relates command attaches the documentation of
- a global function to that of a related class or header file.}
+
+ \section1 \\relates
+ \target relates-command
+
+ The \\relates command attaches the documentation of
+ a global function to that of a related class or header file.
The command's argument is a class name, an the command (and
its argument) must stand on its own line.
@@ -6735,39 +6599,27 @@
will be rendered with the QChar documentation.
- \endtable
+
*/
/*!
\page 19-qdoc-commands-grouping.html
- \previouspage Relating Commands
+ \previouspage Relating Things
\contentspage Table of Contents
- \nextpage Title Commands
+ \nextpage Naming Things
- \title Grouping Commands
+ \title Grouping Things
The grouping commands relate classes to defined groups and
modules. The groups are used when generating lists of related
classes in the documentation, while the modules are elements of
Qt's structure.
- \section1 Alphabetical List
-
- \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
- \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\mainclass
+ \target mainclass-command
- \row
- \o \bold \\mainclass \target mainclass-command
- \o \bold {The \\mainclass command relates the documented class to
- a group called mainclasses.}
+ The \\mainclass command relates the documented class to
+ a group called mainclasses.
The command must stand on its own line.
@@ -6795,12 +6647,13 @@
See also \l {generatelist-command} {\\generatelist}.
- \row
- \o \bold \\ingroup \target ingroup-command
- \o \bold {The \\ingroup command indicates that the given
- overview or documented class belongs to a certain group of
- related docmentation.}
+ \section1 \\ingroup
+ \target ingroup-command
+
+ The \\ingroup command indicates that the given
+ overview or documented class belongs to a certain group of
+ related docmentation.
A class or overview may belong to many groups.
@@ -6831,10 +6684,12 @@
argument.
See also \l {group-command} {\\group}.
- \row
- \o \bold \\inmodule \target inmodule-command
- \o \bold {The \\inmodule command relates the documented class
- to the module specified by the command's argument.}
+
+ \section1 \\inmodule
+ \target inmodule-command
+
+ The \\inmodule command relates the documented class
+ to the module specified by the command's argument.
For the basic classes in Qt, a class's module is determined
by its location, i.e. its directory. However, for
@@ -6859,40 +6714,29 @@
calling the \l {generatelist-command} {\\generatelist} command with
the \c {{classesbymodule QtDesigner}} argument.
- See also \l {module} {\\module} and \l
+ See also \l {module-command} {\\module} and \l
{generatelist-command} {\\generatelist}.
- \endtable
+
*/
/*!
- \page 20-qdoc-commands-title.html
- \previouspage Grouping Commands
+ \page 20-qdoc-commands-namingthings.html
+ \previouspage Grouping Things
\contentspage Table of Contents
- \nextpage QDoc Configuration
+ \nextpage Markup Commands
- \title Title Commands
+ \title Naming Things
In general a title command considers everything that follows it
until the first line break as its argument. If the title needs to
be spanned over several lines, make sure to end each line (except
the last one) with a backslash.
- \section1 Alphabetical List
-
- \l {20-qdoc-commands-title.html#title-command} {\\title},
- \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\title
+ \target title-command
- \row
- \o \bold \\title \target title-command
- \o \bold {The \\title command sets the title for a
- documentation page, or allows you to override it.}
+ The \\title command sets the title for a
+ documentation page, or allows you to override it.
For example:
@@ -6911,7 +6755,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6925,12 +6769,14 @@
...
\endquotation
- See also \l {subtitle} {\\subtitle}.
+ See also \l {subtitle-command} {\\subtitle}.
- \row
- \o \bold \\subtitle \target subtitle
- \o \bold {The \\subtitle command sets a subtitle for a
- documentation page.}
+
+ \section1 \\subtitle
+ \target subtitle-command
+
+ The \\subtitle command sets a subtitle for a
+ documentation page.
For example:
@@ -6949,7 +6795,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6965,35 +6811,64 @@
\endquotation
See also \l {title-command} {\\title}.
- \endtable
+
*/
+
+ \list II
+ \o \section2 \l {The QDoc Configuration File}
+
+ The configuration file is a list of entries of entries of the
+ form "variable = value".
+
+ \list
+ \o \l {Configuration Variables}
+ \o \l {Configuration File Examples}
+ \endlist
+
+ Some particular configuration variables allow you to use QDoc
+ to support Qt-based projects; i.e to make projects, such as Qt
+ Solutions, contain references to the online Qt documentation.
+
+ \list
+ \o \l {Supporting Derived Projects}
+ \endlist
+
+ QDoc is a tool that constantly evolves to suit our needs, for
+ that reason there are some compatibility issues between old and
+ new practices.
+
+ \list
+ \o \l {Compatibility Issues}
+ \endlist
+ \endlist
+
+
+
/*!
\page 21-0-qdoc-configuration.html
- \previouspage Title Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\nextpage General Configuration Variables
- \title QDoc Configuration
+ \title The QDoc Configuration File
- \tableofcontents
+ Before running QDoc to to extract and format your QDOC comments,
+ you must create a QDoc configuration file to tell QDoc where to find
+ them.
\list
\o \l {Supporting Derived Projects}
- \o \l {QDoc Compatibility}
+ \o \l {Compatibility Issues}
\endlist
When running QDoc to generate the documentation, you must specify
a configuration file on the command line:
- \quotation
- \bold {/currentdirectory$ qdoc3 my-documentation.qdocconf}
- \endquotation
-
\section1 General Description
The configuration file is a list of entries of entries of the form
- \i {"variable = value"}. Using the configuration variables, you
+ \e {"variable = value"}. Using the configuration variables, you
can define where QDoc should find the various source files, images
and examples, where to put generated documentation etc. The
configuration file can also contain directives like \c
@@ -7047,49 +6922,43 @@
\section1 Configuration Variables
- \section2 Alphabetical List
-
- \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
- {Cpp.ignoredirectives},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
- {Cpp.ignoretokens},
- \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
- \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
- \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
- {examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
- \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
- {headers.fileextensions},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
- {HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images} {images},
- \l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
- {images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language} {language},
- \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
- \l {22-qdoc-configuration-generalvariables.html#outputformats}
- {outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
- \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
- {sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
- \l {22-qdoc-configuration-generalvariables.html#version} {version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
+ \section1 Variable List
- \section2 Categories
+ \list
+ \o \l {22-qdoc-configuration-generalvariables.html#alias-variable} {alias}
+ \o \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives-variable} {Cpp.ignoredirectives}
+ \o \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretokens-variable} {Cpp.ignoretokens}
+ \o \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines}
+ \o \l {22-qdoc-configuration-generalvariables.html#edition-variable} {edition}
+ \o \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#examples-variable} {examples}
+ \o \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions-variable} {examples.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#extraimages-variable} {extraimages}
+ \o \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods}
+ \o \l {22-qdoc-configuration-generalvariables.html#headerdirs-variable} {headerdirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#headers-variable} {headers}
+ \o \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions-variable} {headers.fileextensions}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.footer-variable} {HTML.footer}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader-variable} {HTML.postheader}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.style-variable} {HTML.style}
+ \o \l {22-qdoc-configuration-generalvariables.html#imagedirs-variable} {imagedirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#images-variable} {images}
+ \o \l {22-qdoc-configuration-generalvariables.html#images.fileextensions-variable} {images.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#language-variable} {language}
+ \o \l {22-qdoc-configuration-generalvariables.html#macro-variable} {macro}
+ \o \l {22-qdoc-configuration-generalvariables.html#outputdir-variable} {outputdir}
+ \o \l {22-qdoc-configuration-generalvariables.html#outputformats-variable} {outputformats}
+ \o \l {22-qdoc-configuration-generalvariables.html#slow-variable} {slow}
+ \o \l {22-qdoc-configuration-generalvariables.html#sourcedirs-variable} {sourcedirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#sources-variable} {sources}
+ \o \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions-variable} {sources.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#spurious-variable} {spurious}
+ \o \l {22-qdoc-configuration-generalvariables.html#tabsize-variable} {tabsize}
+ \o \l {22-qdoc-configuration-generalvariables.html#version-variable} {version}
+ \o \l {22-qdoc-configuration-generalvariables.html#versionsym-variable} {versionsym}
+ \endlist
+
+ \section1 Categories
\list
\o \l {General Configuration Variables}
@@ -7107,8 +6976,9 @@
/*!
\page 21-1-minimum-qdocconf.html
- \previouspage QDoc Configuration
+ \previouspage qt.qdocconf
\contentspage Table of Contents
+ \nextpage Table of Contents
\title minimum.qdocconf
@@ -7117,8 +6987,9 @@
/*!
\page 21-2-qt-qdocconf.html
- \previouspage QDoc Configuration
+ \previouspage Compatibility Issues
\contentspage Table of Contents
+ \nextpage minimum.qdocconf
\title qt.qdocconf
@@ -7127,7 +6998,7 @@
/*!
\page 22-qdoc-configuration-generalvariables.html
- \previouspage QDoc Configuration
+ \previouspage The QDoc Configuration File
\contentspage Table of Contents
\nextpage Creating Help Project Files
@@ -7139,57 +7010,13 @@
documentation. You can also do some minor manipulation of QDoc
itself, controlling its output and processing behavior.
- \section1 Alphabetical List
-
- \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
- \l {22-qdoc-configuration-generalvariables.html#codeindent} {codeindent},
- \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
- \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
- \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
- {examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#generateindex} {generateindex},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
- \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
- {headers.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images} {images},
- \l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
- {images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language} {language},
- \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
- \l {22-qdoc-configuration-generalvariables.html#outputformats}
- {outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
- \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
- {sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
- \l {22-qdoc-configuration-generalvariables.html#tagfile} {tagfile},
- \l {22-qdoc-configuration-generalvariables.html#version} {version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
-
- \section1 Variable Descriptions
-
- \table
-
- \header
- \o Variable
- \o Description
+ \section1 alias
+ \target alias-variable
- \row
- \o \bold alias \target alias
- \o \bold {The \c alias variable renames a QDoc command.}
+ The \c alias variable renames a QDoc command.
- The general syntax is \tt {alias.\i{original-command-name}
- = \i temporary-command-name}.
+ The general syntax is \tt {alias.\e{original-command-name}
+ = \e temporary-command-name}.
For example:
@@ -7200,15 +7027,17 @@
renames the built-in command \\i (italics) to \\e.
The \c alias variable is often used for compatibility
- reasons; for more information see the \l {QDoc
- Compatibility} {compatibility section}.
+ reasons; for more information see the
+ \l {Compatibility Issues} {compatibility section}.
- See also \l macro.
+ See also \l {macro-command} {macro}.
- \row
- \o \bold codeindent \target codeindent
- \o \bold {The \c codeindent variable specifies the level of
- indentation that QDoc uses when writing code snippets.}
+
+ \section1 codeindent
+ \target codeindent-variable
+
+ The \c codeindent variable specifies the level of
+ indentation that QDoc uses when writing code snippets.
QDoc originally used a hard-coded value of four spaces for
code indentation to ensure that code snippets could be easily
@@ -7217,10 +7046,12 @@
adjust the appearance of certain types of HTML elements, this
level of indentation is not always required.
- \row
- \o \bold defines \target defines-variable
- \o \bold {The \c defines variable specifies the C++ preprocessor
- symbols that QDoc will recognize and respond to.}
+
+ \section1 defines
+ \target defines-variable
+
+ The \c defines variable specifies the C++ preprocessor
+ symbols that QDoc will recognize and respond to.
When a preprocessor symbol is specified using the \c
defines variable, you can also use the \l {if-command} {\\if}
@@ -7273,11 +7104,13 @@
See also \l {falsehoods-variable} {falsehoods} and \l {if-command} {\\if}.
- \row
- \o \bold edition \target edition
- \o \bold {The \c edition variable specifies which modules are
- included in each edition of a package, and provides QDoc
- with information to provide class lists for each edition.}
+
+ \section1 edition
+ \target edition-variable
+
+ The \c edition variable specifies which modules are
+ included in each edition of a package, and provides QDoc
+ with information to provide class lists for each edition.
This feature is mostly used when providing documentation
for Qt packages.
@@ -7296,29 +7129,33 @@
In the above examples, the \c Console edition only includes
the contents of four modules. Only the classes from these
modules will be used when the
- \l{Miscellaneous Commands#generatelist-command} {generatelist} command
+ \l{Miscellaneous#generatelist-command} {generatelist} command
is used to generate a list of classes for this edition:
\code
\generatelist{classesbyedition Console}
\endcode
- \row
- \o \bold exampledirs \target exampledirs-variable
- \o \bold {The \c exampledirs variable specifies the directories
- containing the source code of the example files.}
-
- The \l {examples} {\c examples} and \c exampledirs variables
- are used by the \l {quotefromfile-command} {\\quotefromfile}, \l
- {quotefile-command} {\\quotefile} and \l {example} {\\example}
- commands. If both the \l {examples} {\c examples} and \c
- exampledirs variables are defined, QDoc will search in
- both, first in \l {examples} {\c examples} then in \c
- exampledirs.
+
+ \section1 exampledirs
+ \target exampledirs-variable
+
+ The \c exampledirs variable specifies the directories
+ containing the source code of the example files.
+
+ The \l {examples-variable} {examples} {examples} and \l
+ {exampledirs-variable} {exampledirs} variables are used by
+ the \l {quotefromfile-command} {\\quotefromfile}, \l
+ {quotefile-command} {\\quotefile} and \l {example-command}
+ {\\example} commands. If both the \l {examples-variable}
+ {examples} and \l {exampledirs-variable} {exampledirs}
+ variables are defined, QDoc will search in both, first in
+ \l {examples-variable} {examples} then in \l
+ {exampledirs-variable} {exampledirs}.
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
- only search in the specified directories, \i not in
+ only search in the specified directories, \e not in
subdirectories.
For example:
@@ -7359,11 +7196,13 @@
See also \l examples.
- \row
- \o \bold examples \target examples
- \o \bold {The \c examples variable allows you to specify individual
- example files in addition to those located in the directories
- specified by the \l {exampledirs-variable} {\c exampledirs} variable.}
+
+ \section1 examples
+ \target examples-variable
+
+ The \c examples variable allows you to specify individual
+ example files in addition to those located in the directories
+ specified by the \l {exampledirs-variable} {\c exampledirs} variable.
The \c examples and \l {exampledirs-variable} {\c exampledirs}
variables are used by the \l {quotefromfile-command} {\\quotefromfile},
@@ -7387,11 +7226,13 @@
See also \l {exampledirs-variable} {exampledirs}.
- \row
- \o \bold examples.fileextensions \target examples.fileextensions
- \o \bold {The \c examples.fileextensions variable specifies the
- file extensions that qdoc will look for when collecting example
- files for display in the documentation.}
+
+ \section1 examples.fileextensions
+ \target examples.fileextensions-variable
+
+ The \c examples.fileextensions variable specifies the
+ file extensions that qdoc will look for when collecting example
+ files for display in the documentation.
The default extensions are *.cpp, *.h, *.js, *.xq, *.svg, *.xml
and *.ui. However, if
@@ -7406,10 +7247,12 @@
See also \l{headers.fileextensions}.
- \row
- \o \bold extraimages \target extraimages
- \o \bold {The \c extraimages variable tells QDoc to incorporate
- specific images in the generated documentation.}
+
+ \section1 extraimages
+ \target extraimages-variable
+
+ The \c extraimages variable tells QDoc to incorporate
+ specific images in the generated documentation.
QDoc will not recognize images used within HTML (or any
other markup language). If we want the images to be copied
@@ -7418,7 +7261,7 @@
directories) to the output directory, we must specify the
images using the \c extraimages variable.
- The general syntax is \tt {extraimages.\i{format} = \i
+ The general syntax is \tt {extraimages.\e{format} = \e
image}. The file extension is optional.
For example, in \l qt.qdocconf we use a couple of images
@@ -7432,10 +7275,12 @@
See also \l images and \l imagedirs.
- \row
- \o \bold falsehoods \target falsehoods-variable
- \o \bold {The \c falsehoods variable defines the truth value of
- specified preprocessor symbols as false.}
+
+ \section1 falsehoods
+ \target falsehoods-variable
+
+ The \c falsehoods variable defines the truth value of
+ specified preprocessor symbols as false.
If this variable is not set for a preprocessor symbol, QDoc
assumes its truth value is true. The exception is '0',
@@ -7462,7 +7307,7 @@
#endif
\endcode
- QDoc will evaluate it as true by default, \i unless the
+ QDoc will evaluate it as true by default, \e unless the
preprocessor symbol is specified within the \c falsehoods
variable entry:
@@ -7472,21 +7317,25 @@
See also \l defines.
- \row
- \o \bold generateindex \target generateindex
- \o \bold{The \c generateindex variable contains a boolean value that
- specifies whether to generate an index file when HTML documentation
- is generated.}
+
+ \section1 generateindex
+ \target generateindex-variable
+
+ The \c generateindex variable contains a boolean value that
+ specifies whether to generate an index file when HTML documentation
+ is generated.
By default, an index file is always generated with HTML documentation,
so this variable is typically only used when disabling this feature
(by setting the value to \c false) or when enabling index generation
for the WebXML output (by setting the value to \c true).
- \row
- \o \bold headerdirs \target headerdirs
- \o \bold {The \c headerdirs variable specifies the directories
- containing the header files associated with the \c .cpp source
- files used in the documentation.}
+
+ \section1 headerdirs
+ \target headerdirs-variable
+
+ The \c headerdirs variable specifies the directories
+ containing the header files associated with the \c .cpp source
+ files used in the documentation.
For example:
@@ -7507,8 +7356,9 @@
classes and their functions.
Then it will read through the sources specified in the \l
- {sources} {\c sources}, and the ones located in the
- directories specified in the \l {sourcedirs} {\c sourcedirs}
+ {sources-variable} {\c sources}, and the ones located in the
+ directories specified in the \l {sourcedirs-variable}
+ {\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
@@ -7527,11 +7377,13 @@
See also \l headers and \l headers.fileextensions.
- \row
- \o \bold headers \target headers
- \o \bold {The \c headers variable allows you to specify individual
- header files in addition to those located in the directories
- specified by the \l {headerdirs} {\c headerdirs} variable.}
+
+ \section1 headers
+ \target headers-variable
+
+ The \c headers variable allows you to specify individual
+ header files in addition to those located in the directories
+ specified by the \l {headerdirs} {\c headerdirs} variable.
For example:
@@ -7547,10 +7399,12 @@
See also \l headerdirs.
- \row
- \o \bold headers.fileextensions \target headers.fileextensions
- \o \bold {The \c headers.fileextensions variable specify the
- extension used by the headers.}
+
+ \section1 headers.fileextensions
+ \target headers.fileextensions-variable
+
+ The \c headers.fileextensions variable specify the
+ extension used by the headers.
When processing the header files specified in the \l
{headerdirs} {\c headerdirs} variable, QDoc will only read
@@ -7573,13 +7427,15 @@
See also \l headerdirs.
- \row
- \o \bold imagedirs \target imagedirs
- \o \bold {The \c imagedirs variable specifies the directories
- containing the images used in the documentation.}
+
+ \section1 imagedirs
+ \target imagedirs-variable
+
+ The \c imagedirs variable specifies the directories
+ containing the images used in the documentation.
The \l {images} {\c images} and \c imagedirs variables are
- used by the \l {image} {\\image} and \l
+ used by the \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage} commands. If both the \l
{images} {\c images} and \c imagedirs variables are defined,
QDoc will search in both, first in \l {images} {\c images}
@@ -7587,7 +7443,7 @@
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
- only search in the specified directories, \i not in
+ only search in the specified directories, \e not in
subdirectories.
For example:
@@ -7633,11 +7489,13 @@
See also \l images and \l images.fileextensions.
- \row
- \o \bold images \target images
- \o \bold {The \c images variable allows you to specify individual
- image files in addition to those located in the directories
- specified by the \l {imagedirs} {\c imagedirs} variable.}
+
+ \section1 images
+ \target images-variable
+
+ The \c images variable allows you to specify individual
+ image files in addition to those located in the directories
+ specified by the \l {imagedirs} {\c imagedirs} variable.
For example:
@@ -7652,14 +7510,16 @@
See also \l imagedirs and \l images.fileextensions.
- \row
- \o \bold images.fileextensions \target images.fileextensions
- \o \bold {The images.fileextensions variable filters the files within
- an image directory.}
+
+ \section1 images.fileextensions
+ \target images.fileextensions-variable
+
+ The images.fileextensions variable filters the files within
+ an image directory.
The variable's values (the extensions) are given as
standard wildcard expressions. The general syntax is: \tt
- {images.fileextensions.\i{format} = *.\i{extension}}.
+ {images.fileextensions.\e{format} = *.\e{extension}}.
The idea is to enable different image format for different
output format. For example:
@@ -7669,7 +7529,7 @@
images.fileextensions.LOUT = *.eps
\endcode
- Then, when processing the \l {image} {\\image} and \l
+ Then, when processing the \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage} commands, QDoc will only
search for files with extensions specified in the output
format's associated image extension variable.
@@ -7689,10 +7549,12 @@
See also \l imagedirs and \l images.
- \row
- \o \bold language \target language
- \o \bold {The \c language variable specifies the language of the
- source code that is used in the documentation.}
+
+ \section1 language
+ \target language-variable
+
+ The \c language variable specifies the language of the
+ source code that is used in the documentation.
Currently, C++ is the only language that QDoc
understands. It is also the default language, and doesn't
@@ -7705,13 +7567,15 @@
identifies the language of the Qt source code as C++.
- \row
- \o \bold macro \target macro
- \o \bold {The \c macro variable can be used to create your
- own QDoc commands.}
- The general syntax is \tt {macro.\i{command} =
- "\i{definition}}". The definition can be described using
+ \section1 macro
+ \target macro-variable
+
+ The \c macro variable can be used to create your
+ own QDoc commands.
+
+ The general syntax is \tt {macro.\e{command} =
+ "\e{definition}}". The definition can be described using
QDoc syntax. In addition it is possible to provide an HTML
definition by appending .HTML to the variable.
@@ -7725,10 +7589,12 @@
makes sure that the \\gui command renders its argument using a
bold font, and that \\raisedaster renders a '*'.
- \row
- \o \bold naturallanguage \target naturallanguage
- \o \bold {The \c naturallanguage variable specifies the natural
- language used for the documentation generated by qdoc.}
+
+ \section1 naturallanguage
+ \target naturallanguage-variable
+
+ The \c naturallanguage variable specifies the natural
+ language used for the documentation generated by qdoc.
For example:
@@ -7742,14 +7608,17 @@
qdoc will add the natural language information to the HTML
it generates, using the \c lang and \c xml:lang attributes.
- See also \l sourceencoding, \l outputencoding,
+ See also \l {sourceencoding-variable} {sourceencoding},
+ \l {outputencoding-variable} {outputencoding},
\l{http://www.w3.org/TR/xhtml1/#C_7} {C.7. The lang and xml:lang Attributes} and
\l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290} {Best Practice 13: Using Hans and Hant codes}.
- \row
- \o \bold outputdir \target outputdir
- \o \bold {The \c outputdir variable specifies the directory
- where QDoc will put the generated documentation.}
+
+ \section1 outputdir
+ \target outputdir-variable
+
+ The \c outputdir variable specifies the directory
+ where QDoc will put the generated documentation.
In qt.qdocconf:
@@ -7770,10 +7639,12 @@
\warning When running QDoc multiple times using the same output
directory, all files from the previous run will be lost.
- \row
- \o \bold outputencoding \target outputencoding
- \o \bold {The \c outputencoding variable specifies the encoding
- used for the documentation generated by qdoc.}
+
+ \section1 outputencoding
+ \target outputencoding-variable
+
+ The \c outputencoding variable specifies the encoding
+ used for the documentation generated by qdoc.
For example:
@@ -7795,26 +7666,32 @@
See also \l outputencoding and \l naturallanguage.
- \row
- \o \bold outputformats \target outputformats
- \o \bold {The \c outputformats variable specifies the format of
- the generated documentation.}
+
+ \section1 outputformats
+ \target outputformats-variable
+
+ The \c outputformats variable specifies the format of
+ the generated documentation.
Currently, QDoc only supports the HTML format. It is also
the default format, and doesn't need to be specified.
- \row
- \o \bold qhp \target qhp
- \o \bold{The \c qhp variable is used to define the information to be
- written out to Qt Help Project (\c{qhp}) files.}
- See the \l{Creating Help Project Files} chapter for information
- about this process.
+ \section1 qhp
+ \target qhp-variable
- \row
- \o \bold slow \target slow
- \o \bold {The \c slow variable specifies whether QDoc should do
- time-consuming processing, such as syntax highlighting.}
+ The \c qhp variable is used to define the information to be
+ written out to Qt Help Project (\c{qhp}) files.
+
+ See the \l{Creating Help Project Files} chapter for information
+ about this process.
+
+
+ \section1 slow
+ \target slow-variable
+
+ The \c slow variable specifies whether QDoc should do
+ time-consuming processing, such as syntax highlighting.
By default, this setting is false.
@@ -7827,11 +7704,13 @@
Another way to turn on "slowness" is to invoke QDoc with the
\c -slow command-line option.
- \row
- \o \bold sourcedirs \target sourcedirs
- \o \bold {The \c sourcedirs variable specifies the directories
- containing the \c .cpp or \c .qdoc files used in
- the documentation.}
+
+ \section1 sourcedirs
+ \target sourcedirs-variable
+
+ The \c sourcedirs variable specifies the directories
+ containing the \c .cpp or \c .qdoc files used in
+ the documentation.
For example in \l qt.qdocconf
@@ -7846,7 +7725,7 @@
\endcode
When executed, the first QDoc will do is to read through
- the headers specified in the \l {header} {\c header}
+ the headers specified in the \l {header-command} {\c header}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
@@ -7870,12 +7749,15 @@
*.cxx. The files specified by \l {sources} {\c sources} will
be read independent of their fileextensions.
- See also \l sources and \l sources.fileextensions.
+ See also \l {sources-variable} {sources} and
+ \l {sources.fileextensions-variable} {sources.fileextensions}.
- \row
- \o \bold sourceencoding \target sourceencoding
- \o \bold {The \c sourceencoding variable specifies the encoding
- used for the source code and documentation.}
+
+ \section1 sourceencoding
+ \target sourceencoding-variable
+
+ The \c sourceencoding variable specifies the encoding
+ used for the source code and documentation.
For example:
@@ -7894,14 +7776,16 @@
In cases like these, it is possible to write API documentation
completely in documentation files.
- See also \l naturallanguage and \l outputencoding.
+ See also \l {naturallanguage-variable} {naturallanguage} and
+ \l {outputencoding-variable} {outputencoding}.
- \row
- \o \bold sources \target sources
- \o \bold {The \c sources variable allows you to specify
- individual source files in addition to those located in the
- directories specified by the \l {sourcedir} {\c sourcedir}
- variable.}
+
+ \section1 sources
+ \target sources-variable
+
+ The \c sources variable allows you to specify individual source
+ files in addition to those located in the directories specified by
+ the \l {sourcedirs-variable} {sourcedirs} variable.
For example:
@@ -7911,16 +7795,18 @@
\endcode
When processing the \c sources variable, QDoc behaves in the
- same way as it does when processing the \l {sourcedirs} {\c
- sourcedirs} variable. For more information, see the \l
- {sourcedirs} {\c sourcedirs} variable.
+ same way as it does when processing the \l {sourcedirs-variable}
+ {sourcedirs} variable. For more information, see the \l
+ {sourcedirs-variable} {sourcedirs} variable.
- See also \l sourcedirs.
+ See also \l {sourcedirs-variable} {sourcedirs}.
- \row
- \o \bold sources.fileextensions \target sources.fileextensions
- \o \bold {The \c sources.fileextensions variable filters the
- files within a source directory.}
+
+ \section1 sources.fileextensions
+ \target sources.fileextensions-variable
+
+ The \c sources.fileextensions variable filters the
+ files within a source directory.
When processing the source files specified in the \l
{sourcedirs} {\c sourcedirs} variable, QDoc will only read
@@ -7940,12 +7826,15 @@
\warning The above assignment may not work as described.
- See also \l sourcedirs and \l sources.
+ See also \l {sourcedirs-variable} {sourcedirs} and
+ \l (sources-variable} {sources}.
- \row
- \o \bold spurious \target spurious
- \o \bold {The \c spurious variable excludes specified
- QDoc warnings from the output.}
+
+ \section1 spurious
+ \target spurious-variable
+
+ The \c spurious variable excludes specified
+ QDoc warnings from the output.
The warnings are specified using standard wildcard
expressions. For example:
@@ -7964,10 +7853,11 @@
qt-4.0/src/opengl/qgl_mac.cpp:156: Missing parameter name
\endcode
- \row
- \o \bold tabsize \target tabsize
- \o \bold {The \c tabsize variable defines the size of a tab
- character.}
+
+ \section1 tabsize
+ \target tabsize-variable
+
+ The \c tabsize variable defines the size of a tab character.
For example:
@@ -7980,14 +7870,18 @@
The default value of the variable is 8, and doesn't need to
be specified.
- \row
- \o \bold tagfile \target tagfile
- \o \bold{The \c tagfile variable specifies the Doxygen tag file to be written
- when HTML is generated.}
- \row
- \o \bold version \target version
- \o \bold {The \c version variable specifies the version number of the
- documented software.}
+
+ \section1 tagfile
+ \target tagfile-variable
+
+ The \c tagfile variable specifies the Doxygen tag file to be written
+ when HTML is generated.
+
+ \section1 version
+ \target version-variable
+
+ The \c version variable specifies the version number of the
+ documented software.
For example:
@@ -8006,11 +7900,13 @@
See also \l versionsym.
- \row
- \o \bold versionsym \target versionsym
- \o \bold {The \c versionsym variable specifies a C++
- preprocessor symbol that defines the version number
- of the documented software.}
+
+ \section1 versionsym
+ \target versionsym-variable
+
+ The \c versionsym variable specifies a C++
+ preprocessor symbol that defines the version number
+ of the documented software.
For example in \l qt.qdocconf:
@@ -8034,7 +7930,7 @@
See also \l {version} {\\version}.
- \endtable
+
*/
/*!
@@ -8117,25 +8013,11 @@
The C++ specific configuration variables are provided to avoid
erroneous documentation due to non-standard C++ constructs.
- \section1 Alphabetical List
-
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
- {Cpp.ignoredirectives},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
- {Cpp.ignoretokens}
-
- \section1 Variable Descriptions
-
- \table
-
- \header
- \o Variable
- \o Description
+ \section1 Cpp.ignoredirectives
+ \target Cpp.ignoredirectives-variable
- \row
- \o \bold Cpp.ignoredirectives \target Cpp.ignoredirectives
- \o \bold {The \c Cpp.ignoredirectives variable makes QDoc ignore
- the specified non-standard constructs, within C++ source code.}
+ The \c Cpp.ignoredirectives variable makes QDoc ignore
+ the specified non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
@@ -8188,10 +8070,12 @@
See also \l Cpp.ignoretokens.
- \row
- \o \bold Cpp.ignoretokens \target Cpp.ignoretokens
- \o \bold {The \c Cpp.ignoretokens variable makes QDoc ignore
- the specified non-standard constructs, within C++ source code.}
+
+ \section1 Cpp.ignoretokens
+ \target Cpp.ignoretokens-variable
+
+ The \c Cpp.ignoretokens variable makes QDoc ignore
+ the specified non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
@@ -8240,7 +8124,7 @@
See also \l Cpp.ignoredirectives.
- \endtable
+
*/
@@ -8257,27 +8141,11 @@
documentation's footer or postheader. The format of the variable
values are raw HTML.
- \section1 Alphabetical List
-
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
- {HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.stylesheets} {HTML.stylesheets}
-
-
- \section1 Variable Descriptions
-
- \table
-
- \header
- \o Variable
- \o Description
+ \section1 HTML.footer
+ \target HTML.footer-variable
- \row
- \o \bold HTML.footer \target HTML.footer
- \o \bold {The \c HTML.footer variable defines the content
- of the generated HTML documentation's footer.}
+ The \c HTML.footer variable defines the content
+ of the generated HTML documentation's footer.
The footer is rendered at the bottom of the generated
documentation page.
@@ -8299,10 +8167,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.postheader \target HTML.postheader
- \o \bold {The \c HTML.postheader variable defines the content
- of the generated HTML documentation's postheader.}
+
+ \section1 HTML.postheader
+ \target HTML.postheader-variable
+
+ The \c HTML.postheader variable defines the content
+ of the generated HTML documentation's postheader.
The header is rendered at the top of the generated
documentation page.
@@ -8328,10 +8198,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.style \target HTML.style
- \o \bold {The HTML.style variable defines the style for
- the generated HTML documentation.}
+
+ \section1 HTML.style
+ \target HTML.style-variable
+
+ The HTML.style variable defines the style for
+ the generated HTML documentation.
The variable's value is given as raw HTML enclosed by
quotation marks. Note that if the value spans several
@@ -8354,10 +8226,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.stylesheets \target HTML.stylesheets
- \o \bold {The HTML.stylesheets variable defines a list of stylesheets
- to use for the generated HTML documentation.}
+
+ \section1 HTML.stylesheets
+ \target HTML.stylesheets-variable
+
+ The HTML.stylesheets variable defines a list of stylesheets
+ to use for the generated HTML documentation.
Using separate stylesheets for the documentation makes it easier to
customize and experiment with the style used once the contents has
@@ -8371,51 +8245,37 @@
QDoc expects to find stylesheets in the directory containing the
\l qt.qdocconf file, and it will copy those specified to the output
directory alongside the HTML pages.
- \endtable
+
*/
/*!
\page 25-qdoc-configuration-derivedprojects.html
\previouspage HTML Specific Configuration Variables
\contentspage Table of Contents
- \nextpage QDoc Compatibility
+ \nextpage Compatibility Issues
\title Supporting Derived Projects
- \tableofcontents
-
Some particular configuration variables allow you to use QDoc to
support Qt-based projects; i.e to make projects, such as Qt Solutions,
contain references to the online Qt documentation. This
means that QDoc will be able to create links to the class reference
documentation, without any explicit linking command.
- \section1 The Configuration Variables
+ \section1 description
+ \target description-variable
- \section2 Alphabetical List
+ The description variable holds a short description of
+ the associated project.
- \l{25-qdoc-configuration-derivedprojects.html#description} {description},
- \l{25-qdoc-configuration-derivedprojects.html#indexes} {indexes},
- \l{25-qdoc-configuration-derivedprojects.html#project} {project},
- \l{25-qdoc-configuration-derivedprojects.html#url} {url}
-
- \section2 Variable Descriptions
+ See also \l project.
- \table
- \header
- \o Variable
- \o Description
- \row
- \o \bold description \target description
- \o \bold {The description variable holds a short description of
- the associated project.}
- See also \l project.
+ \section1 indexes
+ \target indexes-variable
- \row
- \o \bold indexes \target indexes
- \o \bold {The \c indexes variable lists the index files
- that will be used to generate references.}
+ The \c indexes variable lists the index files
+ that will be used to generate references.
For example. to make a derived Qt project contain links to
the Qt Reference documentation, you need to specify the
@@ -8427,13 +8287,15 @@
See also \l project and \l url.
- \row
- \o \bold project \target project
- \o \bold {The \c project variable provides a name for the project
- associated with the \c .qdocconf file.}
+
+ \section1 project
+ \target project-variable
+
+ The \c project variable provides a name for the project
+ associated with the \c .qdocconf file.
The project's name is used to form a file name for the
- associated project's \i index file. For example:
+ associated project's \e index file. For example:
\code
project = QtMotif
@@ -8443,10 +8305,12 @@
created.
See also \l description and \l indexes.
- \row
- \o \bold url \target url
- \o \bold {The \c url variable holds the base URL for the
- reference documentation associated with the current project.}
+
+ \section1 url
+ \target url-variable
+
+ The \c url variable holds the base URL for the
+ reference documentation associated with the current project.
The URL is stored in the generated index file for the
project. When we use the index on its own, QDoc will use
@@ -8469,7 +8333,7 @@
See also \l indexes.
- \endtable
+
\target howto
\section1 How to Support Derived Projects
@@ -8522,7 +8386,7 @@
The code above requires that you run QDoc from the directory that
contains this file. You need to include the compat.qdocconf
file for compatibility reasons; this is further explained in the
- \l {QDoc Compatibility} section.
+ \l {Compatibility Issues} section.
\bold {To resolve the actual links to Qt classes, the
mini-project's \c .qdocconf file needs to assign a value to the \l
@@ -8540,32 +8404,28 @@
\page 26-qdoc-commands-compatibility.html
\previouspage Supporting Derived Projects
\contentspage Table of Contents
- \nextpage QDoc Commands - Alphabetical List
+ \nextpage qt.qdocconf
- \title QDoc Compatibility
-
- \tableofcontents
+ \title Compatibility Issues
\section1 General Description
\target reason
- QDoc is a tool that constantly evolves to suit our needs, for that
- reason there are some compatibility issues in the transition
- between old and new practices.
+ Because QDoc evolves to suit our documentation needs, there can be
+ some compatibility issues when converting to a new version.
- To make the transition as smooth and rapid as possible, the
- general idea is to adopt the new commands and usage in new
- documentation. While waiting for the occurrences of the old
- practices to be eliminated from the old parts of the
- documentation, you can map the new commands and usage to the old
- ones using a compat.qdocconf file.
+ To allow you to proceed at your own speed when converting your
+ qdoc comments to use new qdoc commands and formats, the ability to
+ include a configuration file called \c {compat.qdocconf} is
+ provided.
- A compat.qdocconf file is a separate \c .qdocconf file which you
- can include in your main configuration file. It typically contains
- the mapping between old and new commands using the \l alias and \l
- {22-qdoc-configuration-generalvariables.html#macro} {macro}
- configuration variables.
+ A \c {compat.qdocconf} file is a separate configuration file,
+ which you include in your main configuration file. It typically
+ contains the mappings from old qdoc commands to new ones using
+ \l {alias} and
+ \l {22-qdoc-configuration-generalvariables.html#macro-variable}
+ {macro} configuration variables.
\section1 Qt Compatibility
@@ -8575,11 +8435,11 @@
detailed information about the commands creating compatibility
issues, see the \l {Command Comments} {command comments}.
- \section2 Qt's current compat.qdocconf file
+ \section1 Qt's current compat.qdocconf file
\quotefile files/compat.qdocconf
- \section2 Command Comments
+ \section1 Command Comments
\table
\header
@@ -8645,7 +8505,7 @@
in italic instead, we introduce the new \\o command for
this purpose.
- \bold {Use \l {o} {\\o} to indicate list and table items in
+ \bold {Use \l {o-command} {\\o} to indicate list and table items in
new documentation}.
\row
@@ -8663,118 +8523,120 @@
\o These commands are equivalent, and represent a simple name
change.
- \bold {Use \l {image} {\\image} in new documentation}.
+ \bold {Use \l {image-command} {\\image} in new documentation}.
\endtable
*/
/*!
\page 27-qdoc-commmands-alphabetical.html
- \previouspage QDoc Compatibility
+ \previouspage Introduction to QDoc
\contentspage Table of Contents
+ \nextpage Topic Commands
+
+ \title The QDoc Commands
- \title QDoc Commands - Alphabetical List
+ This is a complete, alphabetized list of the QDoc commands.
\list
- \o \l {04-qdoc-commands-textformatting.html#a} {\\a}
- \o \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract}
- \o \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode}
- \o \l {04-qdoc-commands-textformatting.html#bold} {\\bold}
- \o \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief}
- \o \l {04-qdoc-commands-textformatting.html#c} {\\c}
- \o \l {09-qdoc-commands-graphic.html#caption} {\\caption}
- \o \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter}
- \o \l {13-qdoc-commands-topical.html#class-command} {\\class}
- \o \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code}
- \o \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \o \l {16-qdoc-commands-status.html#compat} {\\compat}
- \o \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage}
- \o \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)}
- \o \l {07-0-qdoc-commands-quoting.html#dots} {\\dots}
- \o \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else}
- \o \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif}
- \o \l {13-qdoc-commands-topical.html#enum-command} {\\enum}
- \o \l {13-qdoc-commands-topical.html#example-command} {\\example}
- \o \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire}
- \o \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage}
- \o \l {13-qdoc-commands-topical.html#fn} {\\fn}
- \o \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote}
+ \o \l {04-qdoc-commands-textmarkup.html#a-command} {\\a}
+ \o \l {11-qdoc-commands-specialcontent.html#abstract-command} {\\abstract}
+ \o \l {06-qdoc-commands-includecodeinline.html#badcode-command} {\\badcode}
+ \o \l {04-qdoc-commands-textmarkup.html#bold-command} {\\bold}
+ \o \l {11-qdoc-commands-specialcontent.html#brief-command} {\\brief}
+ \o \l {04-qdoc-commands-textmarkup.html#c-command} {\\c}
+ \o \l {09-qdoc-commands-includingimages.html#caption-command} {\\caption}
+ \o \l {05-qdoc-commands-documentstructure.html#chapter-command} {\\chapter}
+ \o \l {13-qdoc-commands-topics.html#class-command} {\\class}
+ \o \l {06-qdoc-commands-includecodeinline.html#code-command} {\\code}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#codeline-command} {\\codeline},
+ \o \l {16-qdoc-commands-status.html#compat-command} {\\compat}
+ \o \l {15-qdoc-commands-navigation.html#contentspage-command} {\\contentspage}
+ \o \l {04-qdoc-commands-textmarkup.html#div-command} {\\div} \span {class="newStuff"} {(new)}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#dots-command} {\\dots}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#else-command} {\\else}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#endif-command} {\\endif}
+ \o \l {13-qdoc-commands-topics.html#enum-command} {\\enum}
+ \o \l {13-qdoc-commands-topics.html#example-command} {\\example}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#expire-command} {\\expire}
+ \o \l {13-qdoc-commands-topics.html#externalpage-command} {\\externalpage}
+ \o \l {13-qdoc-commands-topics.html#fn-command} {\\fn}
+ \o \l {11-qdoc-commands-specialcontent.html#footnote-command} {\\footnote}
\o \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist}
- \o \l {13-qdoc-commands-topical.html#group-command} {\\group}
- \o \l {10-qdoc-commands-container.html#header} {\\header}
- \o \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile}
- \o \l {04-qdoc-commands-textformatting.html#i} {\\i}
+ \o \l {13-qdoc-commands-topics.html#group-command} {\\group}
+ \o \l {10-qdoc-commands-tablesandlists.html#header-command} {\\header}
+ \o \l {13-qdoc-commands-topics.html#headerfile-command} {\\headerfile}
+ \o \l {04-qdoc-commands-textmarkup.html#i-command} {\\i}
\o \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if}
- \o \l {09-qdoc-commands-graphic.html#image} {\\image}
- \o \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include}
- \o \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage}
+ \o \l {09-qdoc-commands-includingimages.html#image-command} {\\image}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#include-command} {\\include}
+ \o \l {15-qdoc-commands-navigation.html#indexpage-command} {\\indexpage}
\o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
\o \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule}
- \o \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
- \o \l {16-qdoc-commands-status.html#internal} {\\internal}
- \o \l {08-qdoc-commands-linking.html#keyword} {\\keyword}
- \o \l {08-qdoc-commands-linking.html#l} {\\l}
- \o \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese}
- \o \l {10-qdoc-commands-container.html#list} {\\list}
- \o \l {13-qdoc-commands-topical.html#macro} {\\macro}
+ \o \l {09-qdoc-commands-includingimages.html#inlineimage-command} {\\inlineimage}
+ \o \l {16-qdoc-commands-status.html#internal-command} {\\internal}
+ \o \l {08-qdoc-commands-creatinglinks.html#keyword-command} {\\keyword}
+ \o \l {08-qdoc-commands-creatinglinks.html#l-command} {\\l}
+ \o \l {11-qdoc-commands-specialcontent.html#legalese-command} {\\legalese}
+ \o \l {10-qdoc-commands-tablesandlists.html#list-command} {\\list}
+ \o \l {13-qdoc-commands-topics.html#macro-command} {\\macro}
\o \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass}
- \o \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta}
- \o \l {13-qdoc-commands-topical.html#module} {\\module}
- \o \l {13-qdoc-commands-topical.html#namespace} {\\namespace}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#meta-command} {\\meta}
+ \o \l {13-qdoc-commands-topics.html#module-command} {\\module}
+ \o \l {13-qdoc-commands-topics.html#namespace-command} {\\namespace}
\o \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage}
- \o \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode}
- \o \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant}
- \o \l {10-qdoc-commands-container.html#o} {\\o}
- \o \l {16-qdoc-commands-status.html#obsolete} {\\obsolete}
- \o \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
- \o \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit}
- \o \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue}
- \o \l {18-qdoc-commands-relating.html#overload} {\\overload}
- \o \l {13-qdoc-commands-topical.html#page} {\\page}
- \o \l {05-qdoc-commands-documentstructuring.html#part} {\\part}
- \o \l {16-qdoc-commands-status.html#preliminary} {\\preliminary}
- \o \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage}
- \o \l {07-0-qdoc-commands-quoting.html#printline} {\\printline}
- \o \l {07-0-qdoc-commands-quoting.html#printto} {\\printto}
- \o \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil}
- \o \l {13-qdoc-commands-topical.html#property} {\\property}
- \o \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation}
- \o \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile}
- \o \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
- \o \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)}
- \o \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant}
- \o \l {18-qdoc-commands-relating.html#reimp} {\\reimp}
+ \o \l {06-qdoc-commands-includecodeinline.html#newcode-command} {\\newcode}
+ \o \l {17-qdoc-commands-thread.html#nonreentrant-command} {\\nonreentrant}
+ \o \l {10-qdoc-commands-tablesandlists.html#o-command} {\\o}
+ \o \l {16-qdoc-commands-status.html#obsolete-command} {\\obsolete}
+ \o \l {06-qdoc-commands-includecodeinline.html#oldcode-command} {\\oldcode}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#omit-command} {\\omit}
+ \o \l {10-qdoc-commands-tablesandlists.html#omitvalue-command} {\\omitvalue}
+ \o \l {18-qdoc-commands-relating.html#overload-command} {\\overload}
+ \o \l {13-qdoc-commands-topics.html#page-command} {\\page}
+ \o \l {05-qdoc-commands-documentstructure.html#part-command} {\\part}
+ \o \l {16-qdoc-commands-status.html#preliminary-command} {\\preliminary}
+ \o \l {15-qdoc-commands-navigation.html#previouspage-command} {\\previouspage}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printline-command} {\\printline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printto-command} {\\printto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printuntil-command} {\\printuntil}
+ \o \l {13-qdoc-commands-topics.html#property-command} {\\property}
+ \o \l {11-qdoc-commands-specialcontent.html#quotation-command} {\\quotation}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefile-command} {\\quotefile}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\raw} \span {class="newStuff"} {(avoid)}
+ \o \l {17-qdoc-commands-thread.html#reentrant-command} {\\reentrant}
+ \o \l {18-qdoc-commands-relating.html#reimp-command} {\\reimp}
\o \l {18-qdoc-commands-relating.html#relates-command} {\\relates}
- \o \l {10-qdoc-commands-container.html#row} {\\row}
- \o \l {08-qdoc-commands-linking.html#sa} {\\sa}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
- \o \l {13-qdoc-commands-topical.html#service} {\\service}
- \o \l {16-qdoc-commands-status.html#since} {\\since}
- \o \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline}
- \o \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto}
- \o \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil}
- \o \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
- \o \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)}
- \o \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
- \o \l {04-qdoc-commands-textformatting.html#sub} {\\sub}
- \o \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
- \o \l {04-qdoc-commands-textformatting.html#sup} {\\sup}
- \o \l {10-qdoc-commands-container.html#table} {\\table}
- \o \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents}
- \o \l {08-qdoc-commands-linking.html#target} {\\target}
- \o \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
- \o \l {20-qdoc-commands-title.html#title-command} {\\title}
- \o \l {04-qdoc-commands-textformatting.html#tt} {\\tt}
- \o \l {13-qdoc-commands-topical.html#typedef} {\\typedef}
- \o \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
- \o \l {13-qdoc-commands-topical.html#variable} {\\variable}
- \o \l {10-qdoc-commands-container.html#value-command} {\\value}
- \o \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
+ \o \l {10-qdoc-commands-tablesandlists.html#row-command} {\\row}
+ \o \l {08-qdoc-commands-creatinglinks.html#sa-command} {\\sa}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionOne-command} {\\section1}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionTwo-command} {\\section2}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionThree-command} {\\section3}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionFour-command} {\\section4}
+ \o \l {13-qdoc-commands-topics.html#service-command} {\\service}
+ \o \l {16-qdoc-commands-status.html#since-command} {\\since}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipline-command} {\\skipline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipto-command} {\\skipto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipuntil-command} {\\skipuntil}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#snippet-command} {\\snippet},
+ \o \l {04-qdoc-commands-textmarkup.html#span-command} {\\span} \span {class="newStuff"} {(new)}
+ \o \l {15-qdoc-commands-navigation.html#startpage-command} {\\startpage}
+ \o \l {04-qdoc-commands-textmarkup.html#sub-command} {\\sub}
+ \o \l {20-qdoc-commands-namingthings.html#subtitle-command} {\\subtitle}
+ \o \l {04-qdoc-commands-textmarkup.html#sup-command} {\\sup}
+ \o \l {10-qdoc-commands-tablesandlists.html#table-command} {\\table}
+ \o \l {11-qdoc-commands-specialcontent.html#tableofcontents-command} {\\tableofcontents}
+ \o \l {08-qdoc-commands-creatinglinks.html#target-command} {\\target}
+ \o \l {17-qdoc-commands-thread.html#threadsafe-command} {\\threadsafe}
+ \o \l {20-qdoc-commands-namingthings.html#title-command} {\\title}
+ \o \l {04-qdoc-commands-textmarkup.html#tt-command} {\\tt}
+ \o \l {13-qdoc-commands-topics.html#typedef-command} {\\typedef}
+ \o \l {04-qdoc-commands-textmarkup.html#underline-command} {\\underline}
+ \o \l {13-qdoc-commands-topics.html#variable-command} {\\variable}
+ \o \l {10-qdoc-commands-tablesandlists.html#value-command} {\\value}
+ \o \l {11-qdoc-commands-specialcontent.html#warning-command} {\\warning}
\endlist
*/
diff --git a/tools/qdoc3/doc/qdoc-manual.qdocconf b/tools/qdoc3/doc/qdoc-manual.qdocconf
index 84ee2ba..33e461f 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdocconf
+++ b/tools/qdoc3/doc/qdoc-manual.qdocconf
@@ -1,102 +1,30 @@
-include(../test/qt-html-default-styles.qdocconf)
+include(../test/compat.qdocconf)
include(../test/macros.qdocconf)
+include(../test/qt-cpp-ignore.qdocconf)
+include(../test/qt-defines.qdocconf)
+
+include(../test/qt-html-templates-online.qdocconf)
project = QDoc
description = QDoc3 Manual
+version = 4.7.1
indexes = ../../../doc/html/qt.index
-outputdir = html
-
-sources = qdoc-manual.qdoc
-sourcedirs = $PWD
-
-exampledirs += $PWD \
- ../../../examples
-
-imagedirs += images
-
-extraimages.HTML = qt-logo.png \
- arrow_down.png \
- breadcrumb.png \
- bullet_gt.png \
- bullet_dn.png \
- bullet_sq.png \
- bullet_up.png \
- horBar.png \
- sprites-combined.png
+sourceencoding = UTF-8
+outputencoding = UTF-8
+naturallanguage = en_US
-HTML.stylesheets = style/style.css \
- style/OfflineStyle.css \
- style/style_ie7.css \
- style/style_ie8.css \
- style/style_ie6.css
+outputdir = $PWD/doc/html
-HTML.postheader = "<div class=\"header\" id=\"qtdocheader\">\n" \
- " <div class=\"content\"> \n" \
- " <div id=\"nav-logo\">\n" \
- " <a href=\"index.html\">Home</a>\n" \
- " </div>\n" \
- " <a href=\"index.html\" class=\"qtref\"><span>QDoc User Manual</span></a>\n" \
- " </div>\n" \
- "</div>\n" \
- "<div class=\"wrap\">\n" \
- " <div class=\"toolbar\">\n" \
- " <div class=\"breadcrumb toolblock\">\n" \
- " <ul>\n" \
- " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
- " <!-- Bread crumbs goes here -->\n"
+sources = ../doc/qdoc-manual.qdoc
+sourcedirs = $PWD/doc
-HTML.postpostheader = " </ul>\n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"content mainContent\">\n"
-
-HTML.footer = "" \
- " </div>\n" \
- "</div>\n" \
- "<div class=\"ft\">\n" \
- " <span></span>\n" \
- "</div>\n" \
- "<div class=\"footer\">\n" \
- " <p>\n" \
- " <acronym title=\"Copyright\">©</acronym> 2008-2010 Nokia Corporation and/or its\n" \
- " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
- " in Finland and/or other countries worldwide.\n" \
- " </p>\n" \
- " <p>\n" \
- " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
- " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a>\n" \
- " </p>\n" \
- " <br />\n" \
- " <p>\n" \
- " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
- " Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
- " with the terms contained in a written agreement between you and Nokia.\n" \
- " </p>\n" \
- " <p>\n" \
- " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
- " Free Documentation License version 1.3</a>\n" \
- " as published by the Free Software Foundation.\n" \
- " </p>\n" \
- "</div>\n" \
- "<div id=\"blurpage\">\n" \
- "</div>\n"
-
-# This stuff is used by the Qt 4.7 doc format.
-scriptdirs = ../../../doc/src/template/scripts
-styledirs = ../../../doc/src/template/style
-
-scripts.HTML = functions.js \
- narrow.js \
- superfish.js \
- jquery.js
-
-styles.HTML = style.css \
- narrow.css \
- superfish.css \
- superfish_skin.css \
- style_ie6.css \
- style_ie7.css \
- style_ie8.css
+exampledirs += $PWD/doc \
+ ../../../examples
+imagedirs = $QT_SOURCE_TREE/doc/src/images \
+ $QT_SOURCE_TREE/examples \
+ $QT_SOURCE_TREE/doc/src/declarative/pics \
+ $QT_SOURCE_TREE/doc/src/template/images \
+ ../doc/images
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 63e43d2..ce6bd09 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -915,9 +915,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
if (threeColumnEnumValueTable) {
out() << "<table class=\"valuelist\">";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<th class=\"tblConst\">Constant</th>"
<< "<th class=\"tblval\">Value</th>"
@@ -1115,9 +1115,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
if (!atom->string().isEmpty())
out() << "<tr " << atom->string() << ">";
else if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
break;
case Atom::TableRowRight:
out() << "</tr>\n";
@@ -3875,9 +3875,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
if ((*p)->type() == Node::QmlProperty) {
qpn = static_cast<const QmlPropertyNode*>(*p);
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlPropNode\"><p>";
@@ -3902,9 +3902,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
out() << "<table class=\"qmlname\">";
//out() << "<tr>";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlFuncNode\"><p>";
out() << "<a name=\"" + refForNode(qsn) + "\"></a>";
generateSynopsis(qsn,relative,marker,CodeMarker::Detailed,false);
@@ -3919,9 +3919,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
out() << "<table class=\"qmlname\">";
//out() << "<tr>";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlFuncNode\"><p>";
out() << "<a name=\"" + refForNode(qmn) + "\"></a>";
generateSynopsis(qmn,relative,marker,CodeMarker::Detailed,false);
--
cgit v0.12
From 93101fa09c9d9ed87de818f11ac59157a7dd8305 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Wed, 16 Feb 2011 13:29:08 +0100
Subject: qdoc: Moved a lot of \target commands to be above the header.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 361 ++++++++++++++++++---------------------
1 file changed, 165 insertions(+), 196 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 12d0085..8ddb6c1 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -231,8 +231,8 @@
The text formatting commands indicate how the regular text in the
documentation is rendered.
- \section1 \\a (parameter marker)
\target a-command
+ \section1 \\a (parameter marker)
The \\a command indicates that the next word is a formal parameter name.
@@ -274,8 +274,8 @@
necessary. And for the same reason, parentheses seldom
occur.
- \section1 \\c (code font)
\target c-command
+ \section1 \\c (code font)
The \\c command is used for rendering variable names, user-defined
class names, and C++ keywords, like \c int and \c for in a
@@ -310,9 +310,9 @@
{tt-command} {teletype (\\tt)} command instead.
See also \l {tt-command} {\\tt} and \l {code-command} {\\code}.
-
- \section1 \\div \span {class="newStuff"} {(new)}
+
\target div-command
+ \section1 \\div \span {class="newStuff"} {(new)}
The \\div command and the corresponding \\enddiv
command delimit a large or small block of text and qdoc
@@ -483,8 +483,8 @@
See also \l {span-command} {\\span}.
- \section1 \\span \span {class="newStuff"} {(new)}
\target span -command
+ \section1 \\span \span {class="newStuff"} {(new)}
The \\span command is for applying special formatting
attributes to a small block of text.
@@ -536,8 +536,8 @@
See also \l {div-command} {\\div}.
- \section1 \\tt
\target tt-command
+ \section1 \\tt
The \\tt command can be used to render variables,
user-defined classes and C++ keywords like \c int, \c
@@ -576,8 +576,8 @@
See also \l {c-command} {\\c}.
- \section1 \\bold
\target bold-command
+ \section1 \\bold
The \\bold command renders its argument using
a bold font.
@@ -602,8 +602,8 @@
command for \l {argument} {punctuation, parentheses and use
of braces} for the argument.
- \section1 \\i
\target i-command
+ \section1 \\i
The \\i command renders its argument in italic.
\warning This is preliminary functionality. For
@@ -699,8 +699,8 @@
</table>
\endraw
- \section1 \\sub
\target sub-command
+ \section1 \\sub
The \\sub command renders its argument lower
than the baseline of the regular text, using a smaller font.
@@ -733,8 +733,8 @@
{i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \section1 \\sup
\target sup-command
+ \section1 \\sup
The \\sup command renders its argument higher than
the baseline of the regular text, using a smaller font.
@@ -765,8 +765,8 @@
{i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \section1 \\underline
\target underline-command
+ \section1 \\underline
The \\underline command renders its argument underlined.
@@ -792,8 +792,8 @@
\l {i-command} {\\i} command for \l {argument} {punctuation,
parentheses and use of braces} for the argument.
- \section1 \\\\ (double backslash)
\target backslash-command
+ \section1 \\\\ (double backslash)
The \\\\ command expands to a single backslash.
@@ -858,8 +858,8 @@
traditional section, subsection, subsubsection and
subsubsubsection.
- \section1 \\part
\target part-command
+ \section1 \\part
The \\part command is intended for use in
larger documents, and divides the document into parts.
@@ -1027,8 +1027,8 @@
righthand corner of the page.
- \section1 \\chapter
\target chapter-command
+ \section1 \\chapter
The \\chapter command is intended for use in
larger documents, and divides the document into chapters.
@@ -1036,35 +1036,32 @@
See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
-
- \section1 \\section1
\target sectionOne-command
+ \section1 \\section1
The \\section1 command starts a new section.
See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
- \section1 \\section2
\target sectionTwo-command
+ \section1 \\section2
The \\section2 command starts a new section.
See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
-
- \section1 \\section3
\target sectionThree-command
+ \section1 \\section3
The \\section3 command starts a new section.
See \l{part} {\\part} for an explanation of the various
section units, command argument and rendering.
-
- \section1 \\section4
\target sectionFour-command
+ \section1 \\section4
The \\section4 command starts a new section.
@@ -1095,8 +1092,8 @@
language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 \\code
\target code-command
+ \section1 \\code
The \\code command and the corresponding
\\endcode command delimit a piece of verbatim code.
@@ -1162,8 +1159,8 @@
{oldcode-command} {\\oldcode}.
- \section1 \\badcode
\target badcode-command
+ \section1 \\badcode
The \\badcode command and the corresponding
\\endcode command delimit a piece of code that doesn't
@@ -1221,8 +1218,8 @@
{oldcode-command} {\\oldcode}.
- \section1 \\newcode
\target newcode-command
+ \section1 \\newcode
The \\newcode command, and the associated \\oldcode
and \\endcode commands, indicate how to port a piece of
@@ -1271,8 +1268,8 @@
to be escaped.
- \section1 \\oldcode
\target oldcode-command
+ \section1 \\oldcode
The \\oldcode command requires a corresponding
\\newcode statement; otherwise QDoc fails to parse the command
@@ -1302,8 +1299,8 @@
for Qt language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 \\quotefile
\target quotefile-command
+ \section1 \\quotefile
The \\quotefile command expands to the complete
contents of the file given as argument.
@@ -1347,8 +1344,8 @@
\l {code-command} {\\code}.
- \section1 \\quotefromfile
\target quotefromfile-command
+ \section1 \\quotefromfile
The \\quotefromfile command opens the file
given as argument for quoting.
@@ -1426,8 +1423,8 @@
{code-command} {\\code} and \l {dots} {\\dots}.
- \section1 \\printline
\target printline-command
+ \section1 \\printline
The \\printline command expands to the line
from the current position to the next non-blank line of
@@ -1563,8 +1560,8 @@
{printuntil-command} {\\printuntil}.
- \section1 \\printto
\target printto-command
+ \section1 \\printto
The \\printto command expands to all the lines
from the current position up to and \e excluding the
@@ -1615,8 +1612,8 @@
{printuntil-command} {\\printuntil}.
- \section1 \\printuntil
\target printuntil-command
+ \section1 \\printuntil
The \\printuntil command expands to all the lines
from the current position up to and \e including the next line
@@ -1672,8 +1669,8 @@
{printto-command} {\\printto}.
- \section1 \\skipline
\target skipline-command
+ \section1 \\skipline
The \\skipline command ignores the next non-blank
line in the current source file.
@@ -1730,8 +1727,8 @@
{skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \section1 \\skipto
\target skipto-command
+ \section1 \\skipto
The \\skipto command ignores all the lines from the
current position up to and \e excluding the next line
@@ -1790,8 +1787,8 @@
{skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \section1 \\skipuntil
\target skipuntil-command
+ \section1 \\skipuntil
The \\skipuntil command ignores all the lines from
the current position up to and \e including the next line
@@ -1849,8 +1846,8 @@
and \l {dots} {\\dots}.
- \section1 \\dots
\target dots-command
+ \section1 \\dots
The \\dots command indicates that parts of the
source file have been omitted when quoting a file.
@@ -1909,8 +1906,8 @@
{\\skipuntil}.
- \section1 \\snippet
\target snippet-command
+ \section1 \\snippet
The \\snippet command causes a code snippet to be included
verbatim as preformatted text, which may be syntax highlighted.
@@ -1944,8 +1941,8 @@
\endcode
\dots
- \section1 \\codeline
\target codeline-command
+ \section1 \\codeline
The \\codeline command inserts a blank line of preformatted
text. It is used to insert gaps between snippets without closing
@@ -1976,8 +1973,8 @@
possible to link to targets within a document, as well as to other
documents and URLs.
- \section1 \\l
\target l-command
+ \section1 \\l
The \\l command is used to create hyperlinks.
@@ -2098,8 +2095,8 @@
and \l {keyword-command} {\\keyword}.
- \section1 \\sa
\target sa-command
+ \section1 \\sa
The \\sa command defines a list of links that will
be rendered in a separate "See also" section at the bottom
@@ -2163,8 +2160,8 @@
{keyword-command} {\\keyword}.
- \section1 \\target
\target target-command
+ \section1 \\target
The \\target command defines an explicit point in the
documentation that you can later link to using the \l {l-command} {\\l}
@@ -2212,8 +2209,8 @@
{keyword-command} {\\keyword}.
- \section1 \\keyword
\target keyword-command
+ \section1 \\keyword
The \\keyword command defines an explicit point in the
documentation that you can later link to using the \l {l-command} {\\l}
@@ -2284,8 +2281,8 @@
documentation. The images can be rendered as separate paragraphs,
or within running text.
- \section1 \\image
\target image-command
+ \section1 \\image
The \\image command expands to the image specified by its
argument, and renders it centered as a separate paragraph.
@@ -2339,8 +2336,8 @@
{caption-command} {\\caption}.
- \section1 \\inlineimage
\target inlineimage-command
+ \section1 \\inlineimage
The \\inlineimage command expands to the image
specified by its argument; the image is rendered inline
@@ -2449,8 +2446,8 @@
See also \l {image-command} {\\image} and \l {caption-command} {\\caption}.
- \section1 \\caption
\target caption-command
+ \section1 \\caption
The \\caption command provides a caption for an image.
@@ -2479,8 +2476,8 @@
paragraph. A table is rendered centered as a separate paragraph,
and its width depends on its content.
- \section1 \\table
\target table-command
+ \section1 \\table
The \\table command and the corresponding \\endtable
command delimit the contents of a table.
@@ -2625,8 +2622,8 @@
See also \l {header-command} {\\header}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \section1 \\header
\target header-command
+ \section1 \\header
The \\header command indicates that the following
table cells are the current table's column headers.
@@ -2677,8 +2674,8 @@
See also \l {table-command} {\\table}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \section1 \\row
\target row-command
+ \section1 \\row
The \\row command indicates that the following table
cells belong to the same row in the current table.
@@ -2762,8 +2759,8 @@
{o-command} {\\o}.
- \section1 \\value
\target value-command
+ \section1 \\value
The \\value command starts the documentation of a C++ enum
item.
@@ -2780,8 +2777,8 @@
See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
- \section1 \\omitvalue
\target omitvalue-command
+ \section1 \\omitvalue
The \\omitvalue command excludes a C++ enum item
from the documentation.
@@ -2793,8 +2790,8 @@
See also \l {enum-command} {\\enum} and \l {value-command} {\\value}.
- \section1 \\list
\target list-command
+ \section1 \\list
The \\list command and the corresponding \\endlist
command delimit a list of items.
@@ -2924,8 +2921,8 @@
See also \l {o-command} {\\o}.
- \section1 \\o
\target o-command
+ \section1 \\o
The \\o command announce a table or list item.
@@ -3014,8 +3011,8 @@
i.e. parts with a special rendering, conceptual meaning or
function.
- \section1 \\abstract
\target abstract-command
+ \section1 \\abstract
The \\abstract and \\endabstract commands delimit a
document's abstract section.
@@ -3028,8 +3025,8 @@
regular HTML paragraph.
- \section1 \\quotation
\target quotation-command
+ \section1 \\quotation
The \\quotation and \\endquotation commands delimit a long quotation.
@@ -3080,8 +3077,8 @@
{compatibility} section.
- \section1 \\footnote
\target footnote-command
+ \section1 \\footnote
The \\footnote command and the corresponding
\\endfootnote command delimit a footnote.
@@ -3093,8 +3090,8 @@
rendered as a regular HTML paragraph.
- \section1 \\tableofcontents
\target tableofcontents-command
+ \section1 \\tableofcontents
The \\tableofcontents command has been disabled because QDoc
now generates a table of contents automatically.
@@ -3103,8 +3100,8 @@
righthand corner of the page.
- \section1 \\brief
\target brief-command
+ \section1 \\brief
The \\brief command introduces a one-sentence
description of a class, namespace, header file, property
@@ -3356,8 +3353,8 @@
\l{namespace-command} {\\namespace} and \l{headerfile-command} {\\headerfile}.
- \section1 \\legalese
\target legalese-command
+ \section1 \\legalese
The \\legalese and \\endlegalese commands delimit a licence agreement.
@@ -3425,8 +3422,8 @@
associated with the source code.
- \section1 \\warning
\target warning-command
+ \section1 \\warning
The \\warning command renders a "Warning:" prefix to
the command's argument.
@@ -3469,8 +3466,8 @@
connected to the visual appearance of the documentation, and to the
process of generating the documentation.
- \section1 \\expire
\target expire-command
+ \section1 \\expire
The \\expire command allows you to define an expiration
date for your documentation.
@@ -3504,8 +3501,8 @@
\endquotation
- \section1 \\generatelist
\target generatelist-command
+ \section1 \\generatelist
The \\generatelist command expands to a list of
various documentation or links to documentation.
@@ -3905,8 +3902,8 @@
\l {service-command} {\\service} command.
- \section1 \\if
\target if-command
+ \section1 \\if
The \\if command and the corresponding \\endif command
enclose parts of a QDoc comment that only will be included if
@@ -3946,8 +3943,8 @@
{falsehoods-variable} {falsehoods}.
- \section1 \\endif
\target endif-command
+ \section1 \\endif
The \\endif command and the corresponding \\if command
enclose parts of a QDoc comment that will be included if
@@ -3962,8 +3959,8 @@
{falsehoods-variable} {falsehoods}.
- \section1 \\else
\target else-command
+ \section1 \\else
The \\else command specifies an alternative if the
condition in the \l {if-command} {\\if} command is false.
@@ -4062,8 +4059,8 @@
{falsehoods}.
- \section1 \\include
\target include-command
+ \section1 \\include
The \\include command expands to the contents of the
file specified by the command's argument.
@@ -4115,8 +4112,8 @@
layoutmanagement.qdocinc
- \section1 \\meta
\target meta-command
+ \section1 \\meta
The \\meta command is the QDoc equivalent to the HTML
\c meta tag.
@@ -4161,8 +4158,8 @@
\endcode
- \section1 \\omit
\target omit-command
+ \section1 \\omit
The \\omit command and the correspondning \\endomit
command delimit parts of the documentation that
@@ -4213,8 +4210,8 @@
- \section1 \\raw \span {class="newStuff"} {(avoid)}
\target raw-command
+ \section1 \\raw \span {class="newStuff"} {(avoid)}
The \\raw command and the corresponding
\\endraw command delimit a block of raw mark-up language code.
@@ -4289,8 +4286,8 @@
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
- \section1 \\unicode
\target unicode-command
+ \section1 \\unicode
The \\unicode command allows you to insert an
arbitrary Unicode character in the document.
@@ -4358,40 +4355,43 @@
\title Topic Commands
- The topic commands tell QDoc what is being documented
- (i.e. existing units like classes, functions and examples), and
- some of the commands allows you to create extra pages.
+ A topic command tells QDoc which source code element is being
+ documented. Some topic commands allow you to create documentation
+ pages that aren't tied to any underlying source code element.
\section1 General Description
- When QDoc is processing a comment, it will try to connect the
- documentation to the source code. For that reason it will first
- look for the topic commands. If there is no such command, it
- will try to tie the documentation to the immediately following
- code. If there is no topic command, and the documentation cannot
- be tied to following code, the documentation is simply lost.
+ When QDoc processes a QDoc comment, it tries to connect the
+ comment to an element in the source code by first looking for a
+ topic command that names the source code element. If there is no
+ topic command, QDoc tries to connect the comment to the source
+ code element that immediately follows the comment. If it can't do
+ either of these and if there is no topic command that indicates
+ the comment does not have an underlying source code element (e.g.
+ \l{page-command} {\\page}), then the comment is discarded.
\target topic argument
- The documented unit's name is passed as the unique argument for
- all the topic commands. The argument's naming convention is the
- documented unit's complete name. For example:
+ The name of the thing being documented is the unique argument for
+ each topic command. The naming convention is to use the complete
+ name. For example:
\code
\enum QComboBox::InsertPolicy
\endcode
- Functions is a special case, the argument's naming convention for
- the \l {fn-command} {\\fn} command is that of the function's
- definition outside the class definition. For example:
+ The \l {fn-command} {\\fn} command is a special case. For the \l
+ {fn-command} {\\fn} command, use the function's signature
+ including the class qualifier. For example:
\code
- \fn void PreviewWindow::setWindowFlags()
+ \fn void QGraphicsWidget::setWindowFlags(Qt::WindowFlags wFlags)
\endcode
- A topic command can appear anywhere in a comment, but must stand
- alone on its own line. If the argument spans several lines, make
- sure that each line (except the last one) is ended with a
+ A topic command can appear anywhere in a comment but must stand
+ alone on its own line. Best practice is to put the topic commend
+ at the top of the comment. If the argument spans several lines,
+ make sure that each line (except the last one) is ended with a
backslash. In addition QDoc counts parentheses, which means that
if it encounters a '(' it considers everything until the closing
')' as its argument.
@@ -4417,8 +4417,8 @@
ControllerWindow::setWindowFlags() functions will get the same
documentation.
- \section1 \\class
\target class-command
+ \section1 \\class
The \\class command tells QDoc that a class is
part of the public API, and lets you enter a detailed
@@ -4581,8 +4581,8 @@
\endquotation
- \section1 \\enum
\target enum-command
+ \section1 \\enum
The \\enum command allows you to document a C++ enum.
@@ -4686,8 +4686,8 @@
See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
- \section1 \\example
\target example-command
+ \section1 \\example
The \\example command allows you to document an example.
@@ -4743,8 +4743,8 @@
in widgets-imageviewer.html.
- \section1 \\fn
\target fn-command
+ \section1 \\fn
The \\fn command allows you to document a function.
@@ -4793,8 +4793,8 @@
See also \l {overload-command} {\\overload}.
- \section1 \\group
\target group-command
+ \section1 \\group
The \\group command creates a separate page that
lists the classes belonging to the group specified by the
@@ -4894,8 +4894,8 @@
{generatelist-command} {\\generatelist}.
- \section1 \\headerfile
\target headerfile-command
+ \section1 \\headerfile
The \\headerfile command allows you to document
global functions, types and macros declared in a header file.
@@ -4968,8 +4968,8 @@
in qtalgorithms.html.
- \section1 \\macro
\target macro-command
+ \section1 \\macro
The \\macro command allows you to document a C++ macro.
@@ -5086,8 +5086,8 @@
in qobject.html.
- \section1 \\module
\target module-command
+ \section1 \\module
The \\module creates a separate page that lists the
classes belonging to the module specified by the command's
@@ -5193,8 +5193,8 @@
See also \l {inmodule-command} {\\inmodule}
- \section1 \\namespace
\target namespace-command
+ \section1 \\namespace
The \\namespace command allows you to document a C++ namespace.
@@ -5258,8 +5258,8 @@
in qt.html.
- \section1 \\page
\target page-command
+ \section1 \\page
The \\page command allows you to create a stand-alone documentation page.
@@ -5295,8 +5295,8 @@
will be rendered in its own HTML file: \l{About Qt}.
- \section1 \\externalpage
\target externalpage-command
+ \section1 \\externalpage
The \\externalpage command gives a title to an external URL.
@@ -5350,8 +5350,8 @@
argument of the \\externalpage command.
- \section1 \\property
\target property-command
+ \section1 \\property
The \\property command allows you to document a Qt property.
@@ -5453,8 +5453,8 @@
in qwidget.html.
- \section1 \\service
\target service-command
+ \section1 \\service
The \\service command tells QDoc that a class is a
service class and specifies its alias, i.e. the associated
@@ -5478,8 +5478,8 @@
{generatelist-command} {\\generatelist}.
- \section1 \\typedef
\target typedef-command
+ \section1 \\typedef
The \\typedef command allows you to document a C++ type definition.
@@ -5573,8 +5573,8 @@
in qlinkedlist.html.
- \section1 \\variable
\target variable-command
+ \section1 \\variable
The \\variable command allows you to document a
member variable or a constant.
@@ -5880,8 +5880,8 @@
</head>
\endcode
- \section1 \\previouspage
\target previouspage-command
+ \section1 \\previouspage
The \\previouspage command links the current page
to the previous one in an ordered series of documents.
@@ -5899,8 +5899,8 @@
Description} section.
- \section1 \\nextpage
\target nextpage-command
+ \section1 \\nextpage
The \\nextpage command links the current
page to the next page in an ordered series of documents.
@@ -5911,8 +5911,8 @@
For an example, see the \l {General Description} section.
- \section1 \\startpage
\target startpage-command
+ \section1 \\startpage
The \\startpage command specifies the first document
in a collection of documents.
@@ -5929,8 +5929,8 @@
For an example, see the \l {General Description} section.
- \section1 \\contentspage
\target contentspage-command
+ \section1 \\contentspage
The \\contentspage command links the current
page to a contents page.
@@ -5941,8 +5941,8 @@
For an example, see the \l {General Description} section.
- \section1 \\indexpage
\target indexpage-command
+ \section1 \\indexpage
The \\indexpage command specifies a document providing
an index for the current document.
@@ -5975,8 +5975,8 @@
describe the history of minor versions. And they can also describe
a documented object's ability to handle multithreaded programming.
- \section1 \\preliminary
\target preliminary-command
+ \section1 \\preliminary
The \\preliminary command indicates that the
referenced function is under development.
@@ -6033,8 +6033,8 @@
\endquotation
- \section1 \\obsolete
\target obsolete-command
+ \section1 \\obsolete
The \\obsolete command indicates that the referenced
function no longer should be used in new code;
@@ -6091,8 +6091,8 @@
- \section1 \\compat
\target compat-command
+ \section1 \\compat
The \\compat command indicates that the referenced class
or function is part of the support library provided to keep
@@ -6175,8 +6175,8 @@
- \section1 \\internal
\target internal-command
+ \section1 \\internal
The \\internal command indicates that the referenced
function is not part of the public interface.
@@ -6208,8 +6208,8 @@
in qspinbox.cpp, will not be rendered at all.
- \section1 \\since
\target since-command
+ \section1 \\since
The \\since command tells in which minor release
the associated functionality was added.
@@ -6399,8 +6399,8 @@
For more information see the general documentation on \l
{threads.html#reentrant} {reentrancy and thread-safety}.
- \section1 \\threadsafe
\target threadsafe-command
+ \section1 \\threadsafe
The \\threadsafe command indicates that the
associated class or function can be called simultaneously by
@@ -6418,8 +6418,8 @@
\l{nonreentrant-command} {\\nonreentrant}.
- \section1 \\reentrant
\target reentrant-command
+ \section1 \\reentrant
The \\reentrant command indicates that the associated
class or function can be called simultaneously
@@ -6434,8 +6434,8 @@
\l{threadsafe-command} {\\threadsafe}.
- \section1 \\nonreentrant
\target nonreentrant-command
+ \section1 \\nonreentrant
The \\nonreentrant command indicates that the
associated class or function cannot be called by
@@ -6464,8 +6464,8 @@
reimplemented function or a global function related to a specified
class or header file.
- \section1 \\overload
\target overload-command
+ \section1 \\overload
The \\overload command indicates that the
function is a secondary overload of its name.
@@ -6540,8 +6540,8 @@
\endquotation.
- \section1 \\reimp
\target reimp-command
+ \section1 \\reimp
The \\reimp command indicates that the
referenced function is a reimplementation of a virtual function,
@@ -6571,8 +6571,8 @@
documentation.
- \section1 \\relates
\target relates-command
+ \section1 \\relates
The \\relates command attaches the documentation of
a global function to that of a related class or header file.
@@ -6615,8 +6615,8 @@
classes in the documentation, while the modules are elements of
Qt's structure.
- \section1 \\mainclass
\target mainclass-command
+ \section1 \\mainclass
The \\mainclass command relates the documented class to
a group called mainclasses.
@@ -6648,8 +6648,8 @@
See also \l {generatelist-command} {\\generatelist}.
- \section1 \\ingroup
\target ingroup-command
+ \section1 \\ingroup
The \\ingroup command indicates that the given
overview or documented class belongs to a certain group of
@@ -6685,8 +6685,8 @@
See also \l {group-command} {\\group}.
- \section1 \\inmodule
\target inmodule-command
+ \section1 \\inmodule
The \\inmodule command relates the documented class
to the module specified by the command's argument.
@@ -6732,8 +6732,8 @@
be spanned over several lines, make sure to end each line (except
the last one) with a backslash.
- \section1 \\title
\target title-command
+ \section1 \\title
The \\title command sets the title for a
documentation page, or allows you to override it.
@@ -6772,8 +6772,8 @@
See also \l {subtitle-command} {\\subtitle}.
- \section1 \\subtitle
\target subtitle-command
+ \section1 \\subtitle
The \\subtitle command sets a subtitle for a
documentation page.
@@ -6814,37 +6814,6 @@
*/
-
- \list II
- \o \section2 \l {The QDoc Configuration File}
-
- The configuration file is a list of entries of entries of the
- form "variable = value".
-
- \list
- \o \l {Configuration Variables}
- \o \l {Configuration File Examples}
- \endlist
-
- Some particular configuration variables allow you to use QDoc
- to support Qt-based projects; i.e to make projects, such as Qt
- Solutions, contain references to the online Qt documentation.
-
- \list
- \o \l {Supporting Derived Projects}
- \endlist
-
- QDoc is a tool that constantly evolves to suit our needs, for
- that reason there are some compatibility issues between old and
- new practices.
-
- \list
- \o \l {Compatibility Issues}
- \endlist
- \endlist
-
-
-
/*!
\page 21-0-qdoc-configuration.html
\previouspage Miscellaneous
@@ -7010,8 +6979,8 @@
documentation. You can also do some minor manipulation of QDoc
itself, controlling its output and processing behavior.
- \section1 alias
\target alias-variable
+ \section1 alias
The \c alias variable renames a QDoc command.
@@ -7033,8 +7002,8 @@
See also \l {macro-command} {macro}.
- \section1 codeindent
\target codeindent-variable
+ \section1 codeindent
The \c codeindent variable specifies the level of
indentation that QDoc uses when writing code snippets.
@@ -7047,8 +7016,8 @@
level of indentation is not always required.
- \section1 defines
\target defines-variable
+ \section1 defines
The \c defines variable specifies the C++ preprocessor
symbols that QDoc will recognize and respond to.
@@ -7105,8 +7074,8 @@
See also \l {falsehoods-variable} {falsehoods} and \l {if-command} {\\if}.
- \section1 edition
\target edition-variable
+ \section1 edition
The \c edition variable specifies which modules are
included in each edition of a package, and provides QDoc
@@ -7137,8 +7106,8 @@
\endcode
- \section1 exampledirs
\target exampledirs-variable
+ \section1 exampledirs
The \c exampledirs variable specifies the directories
containing the source code of the example files.
@@ -7197,8 +7166,8 @@
See also \l examples.
- \section1 examples
\target examples-variable
+ \section1 examples
The \c examples variable allows you to specify individual
example files in addition to those located in the directories
@@ -7227,8 +7196,8 @@
See also \l {exampledirs-variable} {exampledirs}.
- \section1 examples.fileextensions
\target examples.fileextensions-variable
+ \section1 examples.fileextensions
The \c examples.fileextensions variable specifies the
file extensions that qdoc will look for when collecting example
@@ -7248,8 +7217,8 @@
See also \l{headers.fileextensions}.
- \section1 extraimages
\target extraimages-variable
+ \section1 extraimages
The \c extraimages variable tells QDoc to incorporate
specific images in the generated documentation.
@@ -7276,8 +7245,8 @@
See also \l images and \l imagedirs.
- \section1 falsehoods
\target falsehoods-variable
+ \section1 falsehoods
The \c falsehoods variable defines the truth value of
specified preprocessor symbols as false.
@@ -7318,8 +7287,8 @@
See also \l defines.
- \section1 generateindex
\target generateindex-variable
+ \section1 generateindex
The \c generateindex variable contains a boolean value that
specifies whether to generate an index file when HTML documentation
@@ -7330,8 +7299,8 @@
(by setting the value to \c false) or when enabling index generation
for the WebXML output (by setting the value to \c true).
- \section1 headerdirs
\target headerdirs-variable
+ \section1 headerdirs
The \c headerdirs variable specifies the directories
containing the header files associated with the \c .cpp source
@@ -7378,8 +7347,8 @@
See also \l headers and \l headers.fileextensions.
- \section1 headers
\target headers-variable
+ \section1 headers
The \c headers variable allows you to specify individual
header files in addition to those located in the directories
@@ -7400,8 +7369,8 @@
See also \l headerdirs.
- \section1 headers.fileextensions
\target headers.fileextensions-variable
+ \section1 headers.fileextensions
The \c headers.fileextensions variable specify the
extension used by the headers.
@@ -7428,8 +7397,8 @@
See also \l headerdirs.
- \section1 imagedirs
\target imagedirs-variable
+ \section1 imagedirs
The \c imagedirs variable specifies the directories
containing the images used in the documentation.
@@ -7490,8 +7459,8 @@
See also \l images and \l images.fileextensions.
- \section1 images
\target images-variable
+ \section1 images
The \c images variable allows you to specify individual
image files in addition to those located in the directories
@@ -7511,8 +7480,8 @@
See also \l imagedirs and \l images.fileextensions.
- \section1 images.fileextensions
\target images.fileextensions-variable
+ \section1 images.fileextensions
The images.fileextensions variable filters the files within
an image directory.
@@ -7550,8 +7519,8 @@
See also \l imagedirs and \l images.
- \section1 language
\target language-variable
+ \section1 language
The \c language variable specifies the language of the
source code that is used in the documentation.
@@ -7568,8 +7537,8 @@
identifies the language of the Qt source code as C++.
- \section1 macro
\target macro-variable
+ \section1 macro
The \c macro variable can be used to create your
own QDoc commands.
@@ -7590,8 +7559,8 @@
bold font, and that \\raisedaster renders a '*'.
- \section1 naturallanguage
\target naturallanguage-variable
+ \section1 naturallanguage
The \c naturallanguage variable specifies the natural
language used for the documentation generated by qdoc.
@@ -7614,8 +7583,8 @@
\l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290} {Best Practice 13: Using Hans and Hant codes}.
- \section1 outputdir
\target outputdir-variable
+ \section1 outputdir
The \c outputdir variable specifies the directory
where QDoc will put the generated documentation.
@@ -7640,8 +7609,8 @@
directory, all files from the previous run will be lost.
- \section1 outputencoding
\target outputencoding-variable
+ \section1 outputencoding
The \c outputencoding variable specifies the encoding
used for the documentation generated by qdoc.
@@ -7667,8 +7636,8 @@
See also \l outputencoding and \l naturallanguage.
- \section1 outputformats
\target outputformats-variable
+ \section1 outputformats
The \c outputformats variable specifies the format of
the generated documentation.
@@ -7677,8 +7646,8 @@
the default format, and doesn't need to be specified.
- \section1 qhp
\target qhp-variable
+ \section1 qhp
The \c qhp variable is used to define the information to be
written out to Qt Help Project (\c{qhp}) files.
@@ -7687,8 +7656,8 @@
about this process.
- \section1 slow
\target slow-variable
+ \section1 slow
The \c slow variable specifies whether QDoc should do
time-consuming processing, such as syntax highlighting.
@@ -7705,8 +7674,8 @@
\c -slow command-line option.
- \section1 sourcedirs
\target sourcedirs-variable
+ \section1 sourcedirs
The \c sourcedirs variable specifies the directories
containing the \c .cpp or \c .qdoc files used in
@@ -7753,8 +7722,8 @@
\l {sources.fileextensions-variable} {sources.fileextensions}.
- \section1 sourceencoding
\target sourceencoding-variable
+ \section1 sourceencoding
The \c sourceencoding variable specifies the encoding
used for the source code and documentation.
@@ -7780,8 +7749,8 @@
\l {outputencoding-variable} {outputencoding}.
- \section1 sources
\target sources-variable
+ \section1 sources
The \c sources variable allows you to specify individual source
files in addition to those located in the directories specified by
@@ -7802,8 +7771,8 @@
See also \l {sourcedirs-variable} {sourcedirs}.
- \section1 sources.fileextensions
\target sources.fileextensions-variable
+ \section1 sources.fileextensions
The \c sources.fileextensions variable filters the
files within a source directory.
@@ -7830,8 +7799,8 @@
\l (sources-variable} {sources}.
- \section1 spurious
\target spurious-variable
+ \section1 spurious
The \c spurious variable excludes specified
QDoc warnings from the output.
@@ -7854,8 +7823,8 @@
\endcode
- \section1 tabsize
\target tabsize-variable
+ \section1 tabsize
The \c tabsize variable defines the size of a tab character.
@@ -7871,14 +7840,14 @@
be specified.
- \section1 tagfile
\target tagfile-variable
+ \section1 tagfile
The \c tagfile variable specifies the Doxygen tag file to be written
when HTML is generated.
- \section1 version
\target version-variable
+ \section1 version
The \c version variable specifies the version number of the
documented software.
@@ -7901,8 +7870,8 @@
See also \l versionsym.
- \section1 versionsym
\target versionsym-variable
+ \section1 versionsym
The \c versionsym variable specifies a C++
preprocessor symbol that defines the version number
@@ -8013,8 +7982,8 @@
The C++ specific configuration variables are provided to avoid
erroneous documentation due to non-standard C++ constructs.
- \section1 Cpp.ignoredirectives
\target Cpp.ignoredirectives-variable
+ \section1 Cpp.ignoredirectives
The \c Cpp.ignoredirectives variable makes QDoc ignore
the specified non-standard constructs, within C++ source code.
@@ -8071,8 +8040,8 @@
See also \l Cpp.ignoretokens.
- \section1 Cpp.ignoretokens
\target Cpp.ignoretokens-variable
+ \section1 Cpp.ignoretokens
The \c Cpp.ignoretokens variable makes QDoc ignore
the specified non-standard constructs, within C++ source code.
@@ -8141,8 +8110,8 @@
documentation's footer or postheader. The format of the variable
values are raw HTML.
- \section1 HTML.footer
\target HTML.footer-variable
+ \section1 HTML.footer
The \c HTML.footer variable defines the content
of the generated HTML documentation's footer.
@@ -8168,8 +8137,8 @@
Documentation}.
- \section1 HTML.postheader
\target HTML.postheader-variable
+ \section1 HTML.postheader
The \c HTML.postheader variable defines the content
of the generated HTML documentation's postheader.
@@ -8199,8 +8168,8 @@
Documentation}.
- \section1 HTML.style
\target HTML.style-variable
+ \section1 HTML.style
The HTML.style variable defines the style for
the generated HTML documentation.
@@ -8227,8 +8196,8 @@
Documentation}.
- \section1 HTML.stylesheets
\target HTML.stylesheets-variable
+ \section1 HTML.stylesheets
The HTML.stylesheets variable defines a list of stylesheets
to use for the generated HTML documentation.
@@ -8262,8 +8231,8 @@
means that QDoc will be able to create links to the class reference
documentation, without any explicit linking command.
- \section1 description
\target description-variable
+ \section1 description
The description variable holds a short description of
the associated project.
@@ -8271,8 +8240,8 @@
See also \l project.
- \section1 indexes
\target indexes-variable
+ \section1 indexes
The \c indexes variable lists the index files
that will be used to generate references.
@@ -8288,8 +8257,8 @@
See also \l project and \l url.
- \section1 project
\target project-variable
+ \section1 project
The \c project variable provides a name for the project
associated with the \c .qdocconf file.
@@ -8306,8 +8275,8 @@
See also \l description and \l indexes.
- \section1 url
\target url-variable
+ \section1 url
The \c url variable holds the base URL for the
reference documentation associated with the current project.
--
cgit v0.12
From e9172533cb1bbb7ffef93523580c2c5685959ebf Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 17 Feb 2011 12:00:28 +0100
Subject: qdoc: Began updating the command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 148 +++++++++++++++++++--------------------
1 file changed, 72 insertions(+), 76 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 8ddb6c1..0482c64 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -2163,109 +2163,105 @@
\target target-command
\section1 \\target
- The \\target command defines an explicit point in the
- documentation that you can later link to using the \l {l-command} {\\l}
- and \l {sa-command} {\\sa} commands.
+ The \\target command names a place in the documentation that you
+ can link to using the \l {l-command} {\\l (link)} and \l
+ {sa-command} {\\sa (see also)} commands.
- The command considers the rest of the line as part of its
- argument, make sure to follow the target name with a line
- break.
-
- For example:
-
- \code
- / *!
- \target capturing parentheses
- \section1 Capturing Text
+ The text up to the line break becomes the target name. Be sure to
+ follow the target name with a line break. Curly brackets are not
+ required around the target name, but they may be required when the
+ target name is used in a link cammand. See below.
- Parentheses allow us to group elements together so that
- we can quantify and capture them.
+ For example:
- ...
- * /
- \endcode
+ \code
+ / *!
+ \target capturing parentheses
+ \section1 Capturing Text
- can be referenced with
+ Parentheses allow us to group elements together so that
+ we can quantify and capture them.
- \list
- \o \c {\l {capturing parentheses}}
- (from elsewhere in the same comment)
- \o \c {\l qregexp.html#capturing-parentheses}
- (from anywhere else)
- \endlist
+ ...
+ * /
+ \endcode
- within a documentation unit, and with
+ The target name \e{capturing parentheses} can be linked from
+ within the same document containing the target in two ways:
- \list
- \o \c {\l http://www.trolltech.com/4.0/doc/html/qregexp.html#capturing-parentheses}
- \endlist
+ \list
+ \o \c {\l {capturing parentheses}} (from within the same qdoc comment)
+ \o \c {\l qregexp.html#capturing-parentheses} (from elsewhere in the same document)
+ \endlist
- on a more global scale.
+ \note The brackets in the link example are required because the
+ target name contains spaces.
- If the target name does't contain any spaces, the brackets can
- be omitted as well.
+ From other documents, the target name can be linked this way:
- See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
- {keyword-command} {\\keyword}.
+ \list
+ \o \c {\l http://www.trolltech.com/4.0/doc/html/qregexp.html#capturing-parentheses}
+ \endlist
+ See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
+ {keyword-command} {\\keyword}.
\target keyword-command
\section1 \\keyword
- The \\keyword command defines an explicit point in the
- documentation that you can later link to using the \l {l-command} {\\l}
- and \l {sa-command} {\\sa} commands.
+ The \\keyword command names a place in the documentation that you
+ can link to using the \l {l-command} {\\l (link)} and \l
+ {sa-command} {\\sa (see also)} commands.
- Keywords must be unique within the entire set of
- documentation processed in on QDoc run. The command
- considers the rest of the line as part of its argument,
- make sure to follow the keyword with a line break.
+ The \\keyword command is like the \l {target-command} {\\target}
+ command, but stronger. A keyword can be linked from anywhere using
+ a simple syntax. For example:
- The \\keyword command is similar to \l {target-command} {\\target},
- but stronger. A keyword can be referenced from anywhere
- using a simple syntax. For example:
+ Keywords must be unique over all the documents processed during
+ the QDoc run. The command uses the rest of the line as its
+ argument. Be sure to follow the keyword with a line break.
- \code
- / *!
- \class QRegExp
- \reentrant
- \brief The QRegExp class provides pattern
- matching using regular expressions.
- \ingroup tools
- \ingroup misc
- \ingroup shared
- \mainclass
- \keyword regular expression
+ \code
+ / *!
+ \class QRegExp
+ \reentrant
+ \brief The QRegExp class provides pattern
+ matching using regular expressions.
+ \ingroup tools
+ \ingroup misc
+ \ingroup shared
+ \mainclass
- Regular expressions, or "regexps", provide a way to
- find patterns within text.
+ \keyword regular expression
- ...
- * /
- \endcode
+ Regular expressions, or "regexps", provide a way to
+ find patterns within text.
- The location of the keyword can be linked to like this:
+ ...
+ * /
+ \endcode
- \code
- / *!
- When a string is surrounded by slashes, it's
- interpreted as a \l regular expression.
- * /
- \endcode
+ The location marked with the keyword can be linked with:
- QDoc renders this as:
+ \code
+ / *!
+ When a string is surrounded by slashes, it is
+ interpreted as a \l {regular expression}.
+ * /
+ \endcode
- \quotation
- When a string is surrounded by slashes, it's
- interpreted as a \l {regular expression}.
- \endquotation
+ QDoc renders this as:
+
+ \quotation
+ When a string is surrounded by slashes, it's
+ interpreted as a \l {regular expression}.
+ \endquotation
- If the keyword does't contain any spaces, the brackets can
- be omitted as well.
+ If the keyword text contains spaces, the brackets are required.
- See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
- {target-command} {\\target}.
+ See also \l {l-command} {\\l (link)}, \l {sa-command} {\\sa (see
+ also)} and \l {target-command} {\\target}.
*/
--
cgit v0.12
From aff44464700dabd4e6d65e17a6f5d5561a01f150 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 17 Feb 2011 12:50:17 +0100
Subject: qdoc: More updating of the command descriptions. \caption
implemented.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 283 ++++++++++++++++++++-------------------
1 file changed, 147 insertions(+), 136 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 0482c64..c1760cd 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -2280,183 +2280,194 @@
\target image-command
\section1 \\image
- The \\image command expands to the image specified by its
+ The \\image command expands to the image specified by its first
argument, and renders it centered as a separate paragraph.
- The \\image command replaces the old \\img command. For more
- information, see the \l
- {26-qdoc-commands-compatibility.html#image-versus-img}
- {compatibility} section.
-
- The command takes two arguments. The first is the name of
- the image file. The second argument is optional and is a
- simple description of the image equivalent to the HTML
- alt="" in an image tag. The description is used for
- tooltips, and when a browser doesn't support images like
- the Lynx text browser.
+ The \\image command replaces the old \\img command. For more
+ information, see the \l
+ {26-qdoc-commands-compatibility.html#image-versus-img}
+ {compatibility} section.
- The command considers the rest of the line after the file
- name its second argument, make sure that you follow the
- filename or description with a line break. Braces are only
- necessary if the description spans several lines.
+ The command takes two arguments. The first argument is the name of
+ the image file. The second argument is optional and is a simple
+ description of the image, equivalent to the HTML alt="" in an image
+ tag. The description is used for tooltips, and for when a browser
+ doesn't support images, like the Lynx text browser.
- For example:
+ The remaining text \e{after} the file name is the optional,
+ description argument. Be sure to follow the file name or the
+ description with a line break. Curly brackets are required if the
+ description argument spans multiple lines.
- \code
- / *!
- Qt by Trolltech is a C++ toolkit for cross-platform GUI
- application development.
+ For example:
- \image happyguy.jpg "Happy guy"
+ \code
+ / *!
+ Qt by Trolltech is a C++ toolkit for cross-platform GUI
+ application development.
- Qt provides single-source portability across Microsoft
- Windows, Mac OS X, Linux, and all major commercial Unix
- variants. It is also available for embedded devices.
- * /
- \endcode
+ \image happyguy.jpg "Happy guy"
- QDoc renders this as:
+ Qt provides single-source portability across Microsoft
+ Windows, Mac OS X, Linux, and all major commercial Unix
+ variants. It is also available for embedded devices.
+ * /
+ \endcode
- \quotation
- Qt by Trolltech is a C++ toolkit for cross-platform GUI
- application development.
+ QDoc renders this as:
- \image happyguy.jpg image "Happy guy"
+ \quotation
+ Qt by Trolltech is a C++ toolkit for cross-platform GUI
+ application development.
- Qt provides single-source portability across Microsoft
- Windows, Mac OS X, Linux, and all major commercial Unix
- variants. It is also available for embedded devices.
- \endquotation
+ \image happyguy.jpg image "Happy guy"
- See also \l {inlineimage-command} {\\inlineimage} and \l
- {caption-command} {\\caption}.
+ Qt provides single-source portability across Microsoft
+ Windows, Mac OS X, Linux, and all major commercial Unix
+ variants. It is also available for embedded devices.
+ \endquotation
+ See also \l {inlineimage-command} {\\inlineimage} and \l
+ {caption-command} {\\caption}.
\target inlineimage-command
\section1 \\inlineimage
- The \\inlineimage command expands to the image
- specified by its argument; the image is rendered inline
- with the rest of the text.
+ The \\inlineimage command expands to the image specified by its
+ argument. The image is rendered inline with the rest of the text.
- The command takes two arguments. The first is the name of
- the image file. The second argument is optional and is a
- simple description of the image equivalent to the HTML
- alt="" in an image tag. The description is used for
- tooltips, and when a browser doesn't support images like
- the Lynx text browser.
+ The command takes two arguments. The first argument is the name of
+ the image file. The second argument is optional and is a simple
+ description of the image, equivalent to the HTML alt="" in an image
+ tag. The description is used for tooltips, and for when a browser
+ doesn't support images, like the Lynx text browser.
- The most common use of the \\inlineimage command is in
- lists and tables. For example:
+ The most common use of the \\inlineimage command is in lists and
+ tables. Here is an example of including inline images in a list:
- \code
- / *!
- \list 1
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \endlist
- * /
- \endcode
-
- QDoc renders this as:
-
- \list 1
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \endlist
-
- And
-
- \code
- / *!
- \table
- \header
- \o Trolltech
- \o Trolltech
- \row
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \row
- \o \inlineimage happy.gif Oh so happy!
- \o \inlineimage happy.gif Oh so happy!
- \endtable
- * /
- \endcode
+ \code
+ / *!
+ \list 1
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \endlist
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \raw HTML
- <table align="center" cellpadding="2"
- cellspacing="1" border="0">
- <tr valign="top" bgcolor="#a2c511">
- <th>Trolltech</th>
- <th>Trolltech</th>
- </tr>
+ \list 1
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \endlist
- <tr valign="top" bgcolor="#f0f0f0">
- <td><img src="images/happy.gif" alt="Oh so happy!" />
- </td>
- <td><img src="images/happy.gif" alt="Oh so happy!" />
- </td>
- </tr>
+ Her eis an example of including inline images in a table:
- <tr valign="top" bgcolor="#f0f0f0">
- <td><img src="images/happy.gif" alt="Oh so happy!"/>
- </td>
- <td><img src="images/happy.gif" alt="Oh so happy!" />
- </td>
- </tr>
+ \code
+ / *!
+ \table
+ \header
+ \o Trolltech
+ \o Trolltech
+ \row
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \row
+ \o \inlineimage happy.gif Oh so happy!
+ \o \inlineimage happy.gif Oh so happy!
+ \endtable
+ * /
+ \endcode
- </table>
- \endraw
+ QDoc renders this as:
- The command can also be used to insert an image
- inline with the regular text. For example:
+ \raw HTML
+ <table align="center" cellpadding="2"
+ cellspacing="1" border="0">
+ <tr valign="top" bgcolor="#a2c511">
+ <th>Trolltech</th>
+ <th>Trolltech</th>
+ </tr>
+ <tr valign="top" bgcolor="#f0f0f0">
+ <td><img src="images/happy.gif" alt="Oh so happy!" />
+ </td>
+ <td><img src="images/happy.gif" alt="Oh so happy!" />
+ </td>
+ </tr>
+ <tr valign="top" bgcolor="#f0f0f0">
+ <td><img src="images/happy.gif" alt="Oh so happy!"/>
+ </td>
+ <td><img src="images/happy.gif" alt="Oh so happy!" />
+ </td>
+ </tr>
+ </table>
+ \endraw
- \code
- / *!
- \inlineimage training.jpg Training by Trolltech
- The Qt Programming course is offered as a
- five day Open Enrollment Course. The classes
- are open to the public.While the course is open
- to anyone who wants to learn, attendees should
- have significant experience in C++ development
- to derive maximum benefit from the course.
- * /
- \endcode
+ The command can also be used to insert an image inline with the
+ text. For example:
- QDoc renders this as:
+ \code
+ / *!
+ \inlineimage training.jpg Training by Trolltech
+ The Qt Programming course is offered as a
+ five day Open Enrollment Course. The classes
+ are open to the public.While the course is open
+ to anyone who wants to learn, attendees should
+ have significant experience in C++ development
+ to derive maximum benefit from the course.
+ * /
+ \endcode
- \quotation
- \inlineimage training.jpg Training by Trolltech
- The Qt Programming course is offered as a
- five day Open Enrollment Course. The classes
- are open to the public.While the course is open
- to anyone who wants to learn, attendees should
- have significant experience in C++ development
- to derive maximum benefit from the course.
- \endquotation
+ QDoc renders this as:
- See also \l {image-command} {\\image} and \l {caption-command} {\\caption}.
+ \quotation
+ \inlineimage training.jpg Training by Trolltech
+ The Qt Programming course is offered as a
+ five day Open Enrollment Course. The classes
+ are open to the public.While the course is open
+ to anyone who wants to learn, attendees should
+ have significant experience in C++ development
+ to derive maximum benefit from the course.
+ \endquotation
+ See also \l {image-command} {\\image} and \l {caption-command} {\\caption}.
\target caption-command
\section1 \\caption
The \\caption command provides a caption for an image.
- The command follows the same conventions for parentheses and use
- of braces for its \l argument as the \l {i-command} {\\i} command.
+ The command takes all the text up to the end of the paragraph to
+ be the caption. Experiment until you get the effect you want.
- \warning This is preliminary functionality. The
- command is not fully implemented.
+ \code
+ / *!
+ \table 100%
+ \row
+ \o \image windowsvista-pushbutton.png
+ \caption The QPushButton widget provides a command button.
+ \o \image windowsvista-toolbutton.png
+ \caption The QToolButton class provides a quick-access button to commands
+ or options, usually used inside a QToolBar.
+ \endtable
+ * /
+ \endcode
- See also \l {image-command} {\\image} and \l
- {inlineimage-command} {\\inlineimage}
+ QDoc renders this as:
+ \table 100%
+ \row
+ \o \image windowsvista-pushbutton.png
+ \caption The QPushButton widget provides a command button.
+ \o \image windowsvista-toolbutton.png
+ \caption The QToolButton class provides a quick-access button to commands
+ or options, usually used inside a QToolBar.
+ \endtable
+ See also \l {image-command} {\\image} and \l {inlineimage-command}
+ {\\inlineimage}
*/
/*!
--
cgit v0.12
From 8e548bb7cc1df5fef19ab7befe14c7fb3dbd8193 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 17 Feb 2011 13:43:53 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 286 ++++++++++++++++++---------------------
1 file changed, 135 insertions(+), 151 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index c1760cd..fa1b739 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -140,20 +140,6 @@
The markup commands indicate the generated documentation's visual
appearance and logical structure.
- \section2 Categories
- \list
- \o \l {Text Markup}
- \o \l {Document Structure}
- \o \l {Including Code Inline}
- \o \l {Including External Code}
- \o \l {Creating Links}
- \o \l {Including Images}
- \o \l {Tables and Lists}
- \o \l {Special Content}
- \o \l {Miscellaneous}
- \endlist
-
- \section2 Command list
\list
\o \l {04-qdoc-commands-textmarkup.html#backslash-command} {\\\\}
\o \l {04-qdoc-commands-textmarkup.html#a-command} {\\a}
@@ -1968,196 +1954,194 @@
\title Creating Links
- The linking commands make it possible to create hyperlinks to
- classes, functions, header files and examples. They also make it
- possible to link to targets within a document, as well as to other
- documents and URLs.
+ These commands are for creating hyperlinks to classes, functions,
+ examples, and other targets.
\target l-command
- \section1 \\l
+ \section1 \\l (link)
- The \\l command is used to create hyperlinks.
+ The \\l link command is used to create a hyperlink to many
+ different kinds of targets. The command's general syntax is
- The command's general syntax is
+ \code
+ \l {link target} {link text}
+ \endcode
- \code
- \l {link target} {link text}
- \endcode
+ For example:
- For example:
+ \code
+ / *!
+ Read the \l {http://qt.nokia.com/doc/4.0/}
+ {Qt's Reference Documentation} carefully.
+ * /
+ \endcode
- \code
- / *!
- Read the \l {http://qt.nokia.com/doc/4.0/}
- {Qt's Reference Documentation} carefully.
- * /
- \endcode
+ QDoc renders this as:
- QDoc renders this as:
+ \quotation
+ Read the \l {http://qt.nokia.com/doc/4.0/}
+ {Qt's Reference Documentation} carefully.
+ \endquotation
- \quotation
- Read the \l {http://qt.nokia.com/doc/4.0/}
- {Qt's Reference Documentation} carefully.
- \endquotation
+ If the link target is equivalent to the link text, the second
+ argument can be omitted.
- If the link target is equivalent to the link text, the
- second argument can be omitted.
+ For example, if you have documentation like:
- For example, if you have documentation like:
+ \code
+ / *!
+ \target assertions
- \code
- / *!
- \target assertions
+ Assertions make some statement about the text at the
+ point where they occur in the regexp but they do not
+ match any characters.
- Assertions make some statement about the text at the
- point where they occur in the regexp but they do not
- match any characters.
+ ...
- ...
+ Regexps are built up from expressions, quantifiers, and
+ \l {assertions} {assertions}.
+ * /
+ \endcode
- Regexps are built up from expressions, quantifiers, and
- \l {assertions} {assertions}.
- * /
- \endcode
+ You can simplify this as follows:
- you can rewrite it as
+ \code
+ / *!
+ \target assertions
- \code
- / *!
- \target assertions
+ Assertions make some statement about the text at the
+ point where they occur in the regexp but they do not
+ match any characters.
- Assertions make some statement about the text at the
- point where they occur in the regexp but they do not
- match any characters.
+ ...
- ...
+ Regexps are built up from expressions, quantifiers, and
+ \l assertions.
+ * /
+ \endcode
- Regexps are built up from expressions, quantifiers, and
- \l assertions.
- * /
- \endcode
+ For the one-parameter version the braces can often be omitted.
+ The \\l command supports several kinds of links:
- For the one-parameter version the braces can often
- be omitted. See the \l {i-command} {\\i} command for the \l
- {argument} {argument conventions}.
+ \list
- The \\l command supports several kinds of links:
+ \o \c {\l QWidget} - The name of a class documented with the \l
+ {class-command} {\\class} command.
- \list
+ \o \c {\l QWidget::sizeHint()} - The name of a member function,
+ documented with or without an \l {fn-command} {\\fn} command.
- \o \c {\l QWidget} - The name of a class documented with
- the \l {class-command} {\\class} command.
+ \o \c {\l <QtGlobal>} - The subject of a \l {headerfile-command}
+ {\\headerfile} command.
- \o \c {\l QWidget::sizeHint()} - The name of a documented
- member function (documented with or without the \l
- {fn-command} {\\fn} command).
+ \o \c {\l widgets/wiggly} - The relative path used in an \l
+ {example-command} {\\example} command.
- \o \c {\l <QtGlobal>} - The subject of a \l
- {headerfile-command} {\\headerfile} command.
+ \o \c {\l {QWidget Class Reference}} - The title used in a
+ \l {title-command} {\\title} command.
- \o \c {\l widgets/wiggly} - The relative path used in an \l
- {example-command} {\\example} command.
+ \o \c {\l {Introduction to QDoc}}- The text from one of the
+ \l{part-command} {\\part}, \l{chapter} {\\chapter} or \l
+ {sectionOne-command} {\\section} commands.
- \o \c {\l {QWidget Class Reference}} - The title used in a
- \l {title-command} {\\title} command.
+ \o \c {\l fontmatching} - The argument of a \l {target-command}
+ {\\target} command.
- \o \c {\l {Introduction to QDoc}}- The text from one of the
- \l{part-command} {\\part}, \l{chapter} {\\chapter}
- or \l {sectionOne-command} {\\section} commands.
+ \o \c {\l {Shared Classes}} - A keyword named in a \l
+ {keyword-command} {\\keyword} command.
- \o \c {\l fontmatching} - The argument of a \l
- {target-command} {\\target} command.
+ \o \c {\l network.html} - The file name used in a \l
+ {page-command} {\\page} command.
- \o \c {\l {Shared Classes}} - A keyword used in a \l
- {keyword-command} {\\keyword} command.
+ \o \c {\l http://www.trolltech.com/} - A URL.
- \o \c {\l network.html} - The file name used in a \l
- {page-command} {\\page} command.
+ \endlist
- \o \c {\l http://www.trolltech.com/} - A URL.
+ QDoc also tries to make a link out of any words that don't
+ resemble any normal English words, for example Qt class names or
+ functions, like QWidget or QWidget::sizeHint(). In these cases,
+ the \\l command can actually be omitted, but by using the command,
+ you ensure that QDoc will emit a warning if it cannot find the
+ link target. In addition, if you only want the function name to
+ appear in the link, you can use the following syntax:
- \endlist
+ \list
+ \o \c {\l {QWidget::} {sizeHint()}}
+ \endlist
- QDoc also tries to make a link out of any words that don't
- resemble any normal English words, for example Qt class
- names or functions, like QWidget or QWidget::sizeHint(). In
- these cases, the \\l command can actually be omitted, but
- by using the command, you ensure that QDoc will emit a
- warning if it cannot find the link target. In addition, if
- you only want the function name to appear in the link, you
- can use the following syntax:
+ QDoc renders this as:
- \list
- \o \c {\l {QWidget::} {sizeHint()}}
- \endlist
+ \quotation
+ \l {QWidget::} {sizeHint()}
+ \endquotation
- See also \l {sa-command} {\\sa}, \l {target-command} {\\target}
- and \l {keyword-command} {\\keyword}.
+ See also \l {sa-command} {\\sa}, \l {target-command} {\\target}
+ and \l {keyword-command} {\\keyword}.
\target sa-command
- \section1 \\sa
+ \section1 \\sa (see also)
- The \\sa command defines a list of links that will
- be rendered in a separate "See also" section at the bottom
- of the documentation.
+ The \\sa command defines a list of links that will be rendered in
+ a separate "See also" section at the bottom of the documentation
+ unit.
- The command takes a comma-separated list of links as its
- argument. If the line ends with a comma, you can continue
- on a second line. The general syntax is:
+ The command takes a comma-separated list of links as its
+ argument. If the line ends with a comma, you can continue
+ on a second line. The general syntax is:
- \code
- \sa {the first link}, {the second link},
- {the third link}, ...
- \endcode
+ \code
+ \sa {the first link}, {the second link},
+ {the third link}, ...
+ \endcode
- QDoc will automatically try to generate "See also" links
- interconnecting a property's various functions. For
- example, an setVisible() function will automatically get a
- link to visible() and vice versa.
+ QDoc will automatically try to generate "See also" links
+ interconnecting a property's various functions. For example, an
+ setVisible() function will automatically get a link to visible()
+ and vice versa.
- In general, QDoc will generate "See also" links that
- interconnect the functions that access the same
- property. It recognizes four different syntax versions:
+ In general, QDoc will generate "See also" links that interconnect
+ the functions that access the same property. It recognizes four
+ different syntax versions:
- \list
- \o \c property()
- \o \c setProperty()
- \o \c isProperty()
- \o \c hasProperty()
- \endlist
-
- The \\sa command supports the same kind
- of links as the \l {l-command} {\\l} command. For example:
+ \list
+ \o \c property()
+ \o \c setProperty()
+ \o \c isProperty()
+ \o \c hasProperty()
+ \endlist
- \code
- / *!
- Appends the actions \a actions to this widget's
- list of actions.
+ The \\sa command supports the same kind of links as the \l
+ {l-command} {\\l} command. For example:
- \sa removeAction(), QMenu, addAction()
- * /
- void QWidget::addActions(QList<QAction *> actions)
- {
- ...
- }
- \endcode
+ \code
+ / *!
+ Appends the actions \a actions to this widget's
+ list of actions.
+
+ \sa removeAction(), QMenu, addAction()
+ * /
+ void QWidget::addActions(QList<QAction *> actions)
+ {
+ ...
+ }
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- \bold {void QWidget::addActions ( QList<QAction*>
- \e actions )}
+ \quotation
+ \bold {void QWidget::addActions ( QList<QAction*>
+ \e actions )}
- Appends the actions \e actions to this widget's
- list of actions.
+ Appends the actions \e actions to this widget's list of
+ actions.
- See also \l {QWidget::removeAction()} {removeAction()},
- \l QMenu, and \l {QWidget::addAction()} {addAction()}.
- \endquotation
+ See also \l {QWidget::removeAction()} {removeAction()},
+ \l QMenu, and \l {QWidget::addAction()} {addAction()}.
+ \endquotation
- See also \l {l-command} {\\l}, \l {target-command} {\\target} and \l
- {keyword-command} {\\keyword}.
+ See also \l {l-command} {\\l}, \l {target-command} {\\target} and
+ \l {keyword-command} {\\keyword}.
\target target-command
--
cgit v0.12
From 1e5ec7241495ba78d171f51036a0011f1813d7ab Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Thu, 17 Feb 2011 14:33:16 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 261 +++++++++++++++++++--------------------
1 file changed, 127 insertions(+), 134 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index fa1b739..95c87e8 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -214,184 +214,177 @@
\title Text Markup
- The text formatting commands indicate how the regular text in the
- documentation is rendered.
+ The text formatting commands indicate how text is to be rendered.
\target a-command
\section1 \\a (parameter marker)
- The \\a command indicates that the next word is a formal parameter name.
+ The \\a command tells QDoc the next word is a formal parameter name.
- A warning is emitted when a function parameter is not documented
- or is misspelled, so when you document a function you should
- mention each formal parameter name in the function description,
- preceded by the \\a command. The parameter is then rendered in
- italics. For example:
+ A warning is emitted when a formal parameter is not documented or
+ is misspelled, so when you document a function you should mention
+ each formal parameter by name in the function description,
+ preceded by the \\a command. The parameter name is then rendered
+ in italics. For example:
- \code
- / *!
- Constructs a line edit containing the text
- \a contents. The \a parent parameter is sent
- to the QWidget constructor.
- * /
+ \code
+ / *!
+ Constructs a line edit containing the text
+ \a contents. The \a parent parameter is sent
+ to the QWidget constructor.
+ * /
- QLineEdit::QLineEdit(const QString &contents, QWidget *parent)
- :QWidget(parent)
- {
- ...
- }
+ QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)
+ {
+ ...
+ }
- \endcode
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- \bold {QLineEdit::QLineEdit ( const QString &
- contents, QWidget *parent )}
+ \quotation
+ \bold {QLineEdit::QLineEdit ( const QString &
+ contents, QWidget *parent )}
- Constructs a line edit containing the text \a contents.
- The \a parent parameter is sent to the QWidget constructor.
- \endquotation
+ Constructs a line edit containing the text \a contents.
+ The \a parent parameter is sent to the QWidget constructor.
+ \endquotation
- The \\a command follows the same conventions as the \l
- {i-command} {\\i} command for \l {argument} {punctuation, parentheses
- and use of braces} for the argument. However, a parameter
- is always a single word, so braces are rarely
- necessary. And for the same reason, parentheses seldom
- occur.
+ The \\a command follows the same conventions as the \l {i-command}
+ {\\i} command for \l {argument} {punctuation, parentheses and use
+ of braces} for the argument. However, a parameter is always a
+ single word, so braces are rarely necessary. And for the same
+ reason, parentheses seldom occur.
\target c-command
\section1 \\c (code font)
The \\c command is used for rendering variable names, user-defined
- class names, and C++ keywords, like \c int and \c for in a
- code font.
+ class names, and C++ keywords (e.g. \c int and \c for) in the code
+ font.
- The command renders its argument using a typewriter font. For
- example:
+ The command renders its argument using a typewriter font. For
+ example:
- \code
- / *!
- The \c AnalogClock class provides a clock widget with hour
- and minute hands that is automatically updated every
- few seconds.
- * /
- \endcode
+ \code
+ / *!
+ The \c AnalogClock class provides a clock widget with hour
+ and minute hands that is automatically updated every
+ few seconds.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- The \c AnalogClock class provides a clock widget with hour
- and minute hands that is automatically updated every
- few seconds.
- \endquotation
+ \quotation
+ The \c AnalogClock class provides a clock widget with hour
+ and minute hands that is automatically updated every
+ few seconds.
+ \endquotation
- The \\c command follows the same conventions as the \l
- {i-command} {\\i} command for \l {argument} {punctuation, parentheses
- and use of braces} for the argument.
+ The \\c command follows the same conventions as the \l {i-command}
+ {\\i} command for \l {argument} {punctuation, parentheses and use
+ of braces} for the argument.
- The \\c command accepts the special character \c \ within
- its argument, i.e. it renders it as a normal character. So
- if you want to use nested commands, you must use the \l
- {tt-command} {teletype (\\tt)} command instead.
+ The \\c command accepts the special character \c \ within its
+ argument, i.e. it renders it as a normal character. So if you want
+ to use nested commands, you must use the \l {tt-command} {teletype
+ (\\tt)} command instead.
- See also \l {tt-command} {\\tt} and \l {code-command} {\\code}.
+ See also \l {tt-command} {\\tt} and \l {code-command} {\\code}.
\target div-command
\section1 \\div \span {class="newStuff"} {(new)}
- The \\div command and the corresponding \\enddiv
- command delimit a large or small block of text and qdoc
- commands for which special formatting attributes apply.
+ The \\div and \\enddiv commands delimit a large or small block of
+ text (which may include other QDoc commands) to which special
+ formatting attributes should be applied.
- An argument must be provided in curly braces, as in the
- qdoc comment shown below. The argument is not interpreted
- but is used as attribute(s) of the tag that is ultimately
- output by qdoc.
+ An argument must be provided in curly braces, as in the qdoc
+ comment shown below. The argument is not interpreted but is used
+ as attribute(s) of the tag that is ultimately output by qdoc.
- For example, we might want to render an inline image so
- that it floats to the right of the current block of text:
+ For example, we might want to render an inline image so that it
+ floats to the right of the current block of text:
- \code
- / *!
-
- \div {class="float-right"}
- \inlineimage qml-column.png
- \enddiv
+ \code
+ / *!
+ \div {class="float-right"}
+ \inlineimage qml-column.png
+ \enddiv
- * /
- \endcode
+ * /
+ \endcode
- If qdoc is generating HTML, it will translate these
- commands to:
+ If qdoc is generating HTML, it will translate these commands to:
- \code
- <div class="float-right"><p><img src="images/qml-column.png" /></p></div>
- \endcode
+ \code
+ <div class="float-right"><p><img src="images/qml-column.png" /></p></div>
+ \endcode
- For HTML, the attribute value \e {float-right} then will
- refer to a clause in the style.css file. which in this case
- could be:
+ For HTML, the attribute value \e {float-right} then will refer to
+ a clause in the style.css file. which in this case could be:
- \code
- div.float-right
- {
- float: right; margin-left: 2em
- }
- \endcode
+ \code
+ div.float-right
+ {
+ float: right; margin-left: 2em
+ }
+ \endcode
- If qdoc is generating DITA XML, it will translate the commands to:
+ If qdoc is generating DITA XML, it will translate the commands to:
- \code
- <sectiondiv outputclass="float-right">
- <p>
- <fig>
- <image href="images/qml-column.png" placement="inline"/>
- </fig>
- </p>
- </sectiondiv>
- \endcode
+ \code
+ <sectiondiv outputclass="float-right">
+ <p>
+ <fig>
+ <image href="images/qml-column.png" placement="inline"/>
+ </fig>
+ </p>
+ </sectiondiv>
+ \endcode
- Your DITA XML publishing program must then recognize the
- \e {outputclass} attribute value.
+ Your DITA XML publishing program must then recognize the \e
+ {outputclass} attribute value.
- \note The \bold {\\div} command can be nested.
+ \note The \bold {\\div} command can be nested.
- Below is an example taken from the index.qdoc file used to
- generate index.html for Qt 4.7:
+ Below is an example taken from the index.qdoc file used to
+ generate index.html for Qt 4.7:
- \code
- \div {class="indexbox guide"}
+ \code
+ \div {class="indexbox guide"}
\div {class="heading"}
- Qt Developer Guide
+ Qt Developer Guide
\enddiv
\div {class="indexboxcont indexboxbar"}
- \div {class="section indexIcon"} \emptyspan
- \enddiv
- \div {class="section"}
- Qt is a cross-platform application and UI
- framework. Using Qt, you can write web-enabled
- applications once and deploy them across desktop,
- mobile and embedded operating systems without
- rewriting the source code.
- \enddiv
- \div {class="section sectionlist"}
- \list
- \o \l{Getting Started Guides} {Getting started}
- \o \l{Installation} {Installation}
- \o \l{how-to-learn-qt.html} {How to learn Qt}
- \o \l{tutorials.html} {Tutorials}
- \o \l{Qt Examples} {Examples}
- \o \l{qt4-7-intro.html} {What's new in Qt 4.7}
- \endlist
- \enddiv
+ \div {class="section indexIcon"} \emptyspan
+ \enddiv
+ \div {class="section"}
+ Qt is a cross-platform application and UI
+ framework. Using Qt, you can write web-enabled
+ applications once and deploy them across desktop,
+ mobile and embedded operating systems without
+ rewriting the source code.
+ \enddiv
+ \div {class="section sectionlist"}
+ \list
+ \o \l{Getting Started Guides} {Getting started}
+ \o \l{Installation} {Installation}
+ \o \l{how-to-learn-qt.html} {How to learn Qt}
+ \o \l{tutorials.html} {Tutorials}
+ \o \l{Qt Examples} {Examples}
+ \o \l{qt4-7-intro.html} {What's new in Qt 4.7}
+ \endlist
+ \enddiv
\enddiv
- \enddiv
- \endcode
+ \enddiv
+ \endcode
- When all the class attribute values are defined as they are
- in the style.css file that is used for rendering the Qt 4.7
- documentation, the above example is rendered as:
+ When all the class attribute values are defined as they are in the
+ style.css file that is used for rendering the Qt 4.7 documentation,
+ the above example is rendered as:
\div {class="indexbox guide"}
\div {class="heading"}
@@ -420,7 +413,7 @@
\enddiv
\enddiv
- When generating DITA XML, qdoc outputs the nested \e {div} commands as:
+ When generating DITA XML, qdoc outputs the nested \e {div} commands as:
\code
<sectiondiv outputclass="indexbox guide">
@@ -2088,7 +2081,7 @@
The command takes a comma-separated list of links as its
argument. If the line ends with a comma, you can continue
- on a second line. The general syntax is:
+ the list on the next line. The general syntax is:
\code
\sa {the first link}, {the second link},
@@ -2096,7 +2089,7 @@
\endcode
QDoc will automatically try to generate "See also" links
- interconnecting a property's various functions. For example, an
+ interconnecting a property's various functions. For example, a
setVisible() function will automatically get a link to visible()
and vice versa.
--
cgit v0.12
From 99afc72d8c3b1adb7ddce6754447ed8585cf23d7 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 18 Feb 2011 10:50:39 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 627 ++++++++++++++++++++-------------------
1 file changed, 314 insertions(+), 313 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 95c87e8..ff764a0 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -251,11 +251,8 @@
The \a parent parameter is sent to the QWidget constructor.
\endquotation
- The \\a command follows the same conventions as the \l {i-command}
- {\\i} command for \l {argument} {punctuation, parentheses and use
- of braces} for the argument. However, a parameter is always a
- single word, so braces are rarely necessary. And for the same
- reason, parentheses seldom occur.
+ You can enclose the formal parameter name in curly brackets, if
+ you want to, but it isn't necessary.
\target c-command
\section1 \\c (code font)
@@ -283,9 +280,18 @@
few seconds.
\endquotation
- The \\c command follows the same conventions as the \l {i-command}
- {\\i} command for \l {argument} {punctuation, parentheses and use
- of braces} for the argument.
+ If the text to be rendered in the code font contains spaces, enclose the
+ entire text in curly brackets.
+
+ \code
+ \c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}
+ \endcode
+
+ QDoc renders this as:
+
+ \quotation
+ \c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}
+ \endquotation
The \\c command accepts the special character \c \ within its
argument, i.e. it renders it as a normal character. So if you want
@@ -415,52 +421,52 @@
When generating DITA XML, qdoc outputs the nested \e {div} commands as:
- \code
- <sectiondiv outputclass="indexbox guide">
- <sectiondiv outputclass="heading">
- <p>Qt Developer Guide</p>
- </sectiondiv>
- <sectiondiv outputclass="indexboxcont indexboxbar">
- <sectiondiv outputclass="section indexIcon"/>
- <sectiondiv outputclass="section">
- <p>Qt is a cross-platform application and UI
- framework. Using Qt, you can write
- web-enabled applications once and deploy
- them across desktop, mobile and embedded
- operating systems without rewriting the
- source code.
- </p>
- </sectiondiv>
- <sectiondiv outputclass="section sectionlist">
- <ul>
- <li>
- <xref href="gettingstarted.xml#id-606ee7a8-219b-47b7-8f94-91bc8c76e54c">Getting started</xref>
- </li>
- <li>
- <xref href="installation.xml#id-075c20e2-aa1e-4f88-a316-a46517e50443">Installation</xref>
- </li>
- <li>
- <xref href="how-to-learn-qt.xml#id-49f509b5-52f9-4cd9-9921-74217b9a5182">How to learn Qt</xref>
- </li>
- <li>
- <xref href="tutorials.xml#id-a737f955-a904-455f-b4aa-0dc69ed5a64f">Tutorials</xref>
- </li>
- <li>
- <xref href="all-examples.xml#id-98d95159-d65b-4706-b08f-13d80080448d">Examples</xref>
- </li>
- <li>
- <xref href="qt4-7-intro.xml#id-519ae0e3-4242-4c2a-b2be-e05d1e95f177">What's new in Qt 4.7</xref>
- </li>
- </ul>
- </sectiondiv>
- </sectiondiv>
- </sectiondiv>
- \endcode
+ \code
+ <sectiondiv outputclass="indexbox guide">
+ <sectiondiv outputclass="heading">
+ <p>Qt Developer Guide</p>
+ </sectiondiv>
+ <sectiondiv outputclass="indexboxcont indexboxbar">
+ <sectiondiv outputclass="section indexIcon"/>
+ <sectiondiv outputclass="section">
+ <p>Qt is a cross-platform application and UI
+ framework. Using Qt, you can write
+ web-enabled applications once and deploy
+ them across desktop, mobile and embedded
+ operating systems without rewriting the
+ source code.
+ </p>
+ </sectiondiv>
+ <sectiondiv outputclass="section sectionlist">
+ <ul>
+ <li>
+ <xref href="gettingstarted.xml#id-606ee7a8-219b-47b7-8f94-91bc8c76e54c">Getting started</xref>
+ </li>
+ <li>
+ <xref href="installation.xml#id-075c20e2-aa1e-4f88-a316-a46517e50443">Installation</xref>
+ </li>
+ <li>
+ <xref href="how-to-learn-qt.xml#id-49f509b5-52f9-4cd9-9921-74217b9a5182">How to learn Qt</xref>
+ </li>
+ <li>
+ <xref href="tutorials.xml#id-a737f955-a904-455f-b4aa-0dc69ed5a64f">Tutorials</xref>
+ </li>
+ <li>
+ <xref href="all-examples.xml#id-98d95159-d65b-4706-b08f-13d80080448d">Examples</xref>
+ </li>
+ <li>
+ <xref href="qt4-7-intro.xml#id-519ae0e3-4242-4c2a-b2be-e05d1e95f177">What's new in Qt 4.7</xref>
+ </li>
+ </ul>
+ </sectiondiv>
+ </sectiondiv>
+ </sectiondiv>
+ \endcode
- Your DITA XML publishing program must recognize the values
- of the \e {outputclass} attribute.
+ Your DITA XML publishing program must recognize the values of the
+ \e {outputclass} attribute.
- See also \l {span-command} {\\span}.
+ See also \l {span-command} {\\span}.
\target span -command
\section1 \\span \span {class="newStuff"} {(new)}
@@ -468,249 +474,246 @@
The \\span command is for applying special formatting
attributes to a small block of text.
- Two arguments must be provided, each argument in curly
- braces, as shown in the qdoc comment below. The first
- argument is not interpreted but is used as the formatting
- attribute(s) of the tag that is ultimately output by
- qdoc. The second argument is the text to be rendered with
- the special formatting attributes.
+ Two arguments must be provided, each argument in curly braces, as
+ shown in the qdoc comment below. The first argument is not
+ interpreted but is used as the formatting attribute(s) of the tag
+ that is ultimately output by qdoc. The second argument is the text
+ to be rendered with the special formatting attributes.
- For example, we might want to render the first word of each
- element in a numeric list in blue.
+ For example, we might want to render the first word of each
+ element in a numeric list in blue.
- \code
- / *!
- Global variables with complex types:
- \list 1
- \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
- \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
- \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
- \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
- \endlist
- * /
- \endcode
-
- Class \e {variableName} refers to a clause in your style.css.
-
- \code
- .variableName
- {
- font-family: courier;
- color: blue
- }
- \endcode
-
- Using the \e {variableName} clause shown above, the example is rendered as:
-
- Global variables with complex types:
- \list 1
- \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
- \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
- \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
- \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
- \endlist
-
- \note The \bold span command does not cause a new paragraph to
- be started.
-
- See also \l {div-command} {\\div}.
+ \code
+ / *!
+ Global variables with complex types:
+ \list 1
+ \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
+ \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
+ \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
+ \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
+ \endlist
+ * /
+ \endcode
+
+ Class \e {variableName} refers to a clause in your style.css.
+
+ \code
+ .variableName
+ {
+ font-family: courier;
+ color: blue
+ }
+ \endcode
+
+ Using the \e {variableName} clause shown above, the example is rendered as:
+
+ Global variables with complex types:
+ \list 1
+ \o \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
+ \o \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
+ \o \span {class="variableName"} {constComplex1} in globals.cpp at line 16
+ \o \span {class="variableName"} {constComplex2} in globals.cpp at line 17
+ \endlist
+
+ \note The \bold span command does not cause a new paragraph to be
+ started.
+
+ See also \l {div-command} {\\div}.
\target tt-command
- \section1 \\tt
+ \section1 \\tt (teletype font)
- The \\tt command can be used to render variables,
- user-defined classes and C++ keywords like \c int, \c
- for, etc.
+ The \\tt command renders its argument in a monospace font. This
+ command behaves just like the \l {c-command} {\\c} command, except
+ that \\tt allows you to nest QDoc commands within the argument
+ (e.g. \l {i-command} {\\i}, \l {bold-command} {\\bold} and \l
+ {underline-command} {\\underline}).
- The \\tt command behaves just like the \l {c-command} {\\c}
- command, except that \\tt parses QDoc commands (like \l
- {i-command} {\\i}, \l {bold-command} {\\bold} and \l
- {underline-command} {\\underline}) contained within its
- argument.
+ \code
+ / *!
+ After \c setupUi() populates the main container with
+ child widgets it scans the main container's list of
+ slots for names with the form
+ \tt{on_\e{objectName}_\e{signalName}().}
+ * /
+ \endcode
- The command renders its argument using a monospace
- font. For example:
+ QDoc renders this as:
- \code
- / *!
- After \c setupUi() populates the main container with
- child widgets it scans the main container's list of
- slots for names with the form
- \tt{on_\e{objectName}_\e{signalName}().}
- * /
- \endcode
+ \quotation
+ After \c setupUi() populates the main container with
+ child widgets it scans the main container's list of
+ slots for names with the form
+ \tt{on_\e{objectName}_\e{signalName}().}
+ \endquotation
- QDoc renders this as:
+ If the text to be rendered in the code font contains spaces, enclose the
+ entire text in curly brackets.
- \quotation
- After \c setupUi() populates the main container with
- child widgets it scans the main container's list of
- slots for names with the form
- \tt{on_\e{objectName}_\e{signalName}().}
- \endquotation
+ \code
+ \tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}
+ \endcode
- The \\tt command follows the same conventions as the \l
- {i-command} {\\i} command for \l {argument} {punctuation, parentheses
- and use of braces} for the argument.
+ QDoc renders this as:
+
+ \quotation
+ \tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}
+ \endquotation
- See also \l {c-command} {\\c}.
+ See also \l {c-command} {\\c}.
\target bold-command
\section1 \\bold
- The \\bold command renders its argument using
- a bold font.
+ The \\bold command renders its argument in bold font.
- For example:
-
- \code
- / *!
- This is regular text; \bold {this text is
- rendered using the \\bold command}.
- * /
- \endcode
+ For example:
- QDoc renders this as:
+ \code
+ / *!
+ This is regular text; \bold {this text is
+ rendered using the \\bold command}.
+ * /
+ \endcode
- \quotation
- This is regular text; \bold {this text is rendered using
- the \\bold command}.
- \endquotation
+ QDoc renders this as:
- The command follows the same conventions as the \l {i-command} {\\i}
- command for \l {argument} {punctuation, parentheses and use
- of braces} for the argument.
+ \quotation
+ This is regular text; \bold {this text is rendered using
+ the \\bold command}.
+ \endquotation
\target i-command
- \section1 \\i
- The \\i command renders its argument in italic.
+ \section1 \\i (italics)
- \warning This is preliminary functionality. For
- more information, see the \l
- {26-qdoc-commands-compatibility.html#i-versus-e} {compatibility}
- section.
+ The \\i command renders its argument in italics.
- \target argument
- Normally, a command argument ends at the next whitespace [1],
- but braces can be used to group words [2]. For example:
+ \warning If \\i doesn't work and you get some strange error
+ meesages from qdoc3 about using \\o outside of tables and lists,
+ use \bold{\\e} for italics instead of \\i. For more information,
+ see the relevant explanation in the section on \l
+ {26-qdoc-commands-compatibility.html#i-versus-e} {compatibility
+ issues}.
- \code
- / *!
- Here, we render \i {a few words} in italic.
- * /
- \endcode
+ If the argument contains spaces or other punctuation, enclose the
+ argument in curly brackets.
- QDoc renders this as:
+ \code
+ / *!
+ Here, we render \i {a few words} in italic.
+ * /
+ \endcode
- \quotation
- Here, we render \e {a few words} in italic.
- \endquotation
+ QDoc renders this as:
- If you want to use other QDoc commands within an argument
- that contains spaces, you always need to enclose the
- argument with braces. But QDoc is smart enough to count
- parentheses [3], so you don't need braces in cases like this:
+ \quotation
+ Here, we render \e {a few words} in italic.
+ \endquotation
- \code
- / *!
- An argument can sometimes contain whitespaces,
- for example: \i QPushButton(tr("A Brand New Button"))
- * /
- \endcode
+ If you want to use other QDoc commands within an argument that
+ contains spaces, you always need to enclose the argument with
+ braces. But QDoc is smart enough to count parentheses [3], so you
+ don't need braces in cases like this:
- QDoc renders this as:
+ \code
+ / *!
+ An argument can sometimes contain whitespaces,
+ for example: \i QPushButton(tr("A Brand New Button"))
+ * /
+ \endcode
- \quotation
- An argument can sometimes contain whitespaces,
- for example: \e QPushButton(tr("A Brand New Button"))
- \endquotation
+ QDoc renders this as:
- Finally, trailing punctuation is not included in an
- argument [4], nor is 's [5]
+ \quotation
+ An argument can sometimes contain whitespaces,
+ for example: \e QPushButton(tr("A Brand New Button"))
+ \endquotation
- \raw HTML
- <table align="center" cellpadding="2"
- cellspacing="1" border="0">
- <tr valign="top" bgcolor="#a2c511">
- <th></th>
- <th>QDoc Syntax</th>
- <th>Generated Documentation</th>
- </tr>
+ Finally, trailing punctuation is not included in an argument [4],
+ nor is 's [5]
- <tr valign="top" bgcolor="#d0d0d0">
- <td>1</td>
- <td>A variation of a command button is a \e menu
- button.</td>
- <td>A variation of a command button is a <i>menu</i>
- button.</td>
- </tr>
+ \raw HTML
+ <table align="center" cellpadding="2"
+ cellspacing="1" border="0">
+ <tr valign="top" bgcolor="#a2c511">
+ <th></th>
+ <th>QDoc Syntax</th>
+ <th>Generated Documentation</th>
+ </tr>
- <tr valign="top" bgcolor="#c0c0c0">
- <td>2</td>
- <td>The QPushButton widget provides a
- \e {command button}.</td>
- <td>The QPushButton widget provides a
- <i>command button</i>.</td>
- </tr>
+ <tr valign="top" bgcolor="#d0d0d0">
+ <td>1</td>
+ <td>A variation of a command button is a \e menu
+ button.</td>
+ <td>A variation of a command button is a <i>menu</i>
+ button.</td>
+ </tr>
- <tr valign="top" bgcolor="#d0d0d0">
- <td>3</td>
- <td>Another class of buttons are option buttons
- \e (see QRadioButton).</td>
- <td>Another class of buttons are option buttons
- <i> (see QRadioButton)</i>.</td>
- </tr>
+ <tr valign="top" bgcolor="#c0c0c0">
+ <td>2</td>
+ <td>The QPushButton widget provides a
+ \e {command button}.</td>
+ <td>The QPushButton widget provides a
+ <i>command button</i>.</td>
+ </tr>
- <tr valign="top" bgcolor="#c0c0c0">
- <td>4</td>
- <td>A push button emits the signal \e clicked().</td>
- <td>A push button emits the signal <i>clicked</i>().</td>
- </tr>
+ <tr valign="top" bgcolor="#d0d0d0">
+ <td>3</td>
+ <td>Another class of buttons are option buttons
+ \e (see QRadioButton).</td>
+ <td>Another class of buttons are option buttons
+ <i> (see QRadioButton)</i>.</td>
+ </tr>
- <tr valign="top" bgcolor="#d0d0d0">
- <td>5</td>
- <td>The \e QPushButton's checked property is
- false by default.</td>
- <td>The <i>QPushButton</i>'s checked property is
- false by default.</td>
- </tr>
+ <tr valign="top" bgcolor="#c0c0c0">
+ <td>4</td>
+ <td>A push button emits the signal \e clicked().</td>
+ <td>A push button emits the signal <i>clicked</i>().</td>
+ </tr>
- </table>
- \endraw
+ <tr valign="top" bgcolor="#d0d0d0">
+ <td>5</td>
+ <td>The \e QPushButton's checked property is
+ false by default.</td>
+ <td>The <i>QPushButton</i>'s checked property is
+ false by default.</td>
+ </tr>
+
+ </table>
+ \endraw
\target sub-command
\section1 \\sub
- The \\sub command renders its argument lower
- than the baseline of the regular text, using a smaller font.
+ The \\sub command renders its argument lower than the baseline of
+ the regular text, using a smaller font.
- For example:
+ For example:
- \code
- / *!
- Definition (Range): Consider the sequence
- {x\sub n}\sub {n > 1} . The set
+ \code
+ / *!
+ Definition (Range): Consider the sequence
+ {x\sub n}\sub {n > 1} . The set
- {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}
+ {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}
- is called the range of the sequence.
- * /
- \endcode
+ is called the range of the sequence.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- Definition (Range): Consider the sequence
- {x\sub n}\sub {n > 1} . The set
+ \quotation
+ Definition (Range): Consider the sequence
+ {x\sub n}\sub {n > 1} . The set
- {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}
+ {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}
- is called the range of the sequence.
- \endquotation
+ is called the range of the sequence.
+ \endquotation
- The \\sub command follows the same conventions as the \l
- {i-command} {\\i} command for \l {argument} {punctuation, parentheses
- and use of braces} for the argument.
+ If the argument contains spaces or other punctuation, enclose the
+ argument in curly brackets.
\target sup-command
\section1 \\sup
@@ -718,107 +721,105 @@
The \\sup command renders its argument higher than
the baseline of the regular text, using a smaller font.
- For example:
+ For example:
- \code
- / *!
- The series
+ \code
+ / *!
+ The series
- 1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
+ 1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
- is called the \i {geometric series}.
- * /
- \endcode
+ is called the \i {geometric series}.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- The series
+ \quotation
+ The series
- 1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
+ 1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
- is called the \e {geometric series}.
- \endquotation
+ is called the \e {geometric series}.
+ \endquotation
- The \\sup command follows the same conventions as the \l
- {i-command} {\\i} command for \l {argument} {punctuation, parentheses
- and use of braces} for the argument.
+ If the argument contains spaces or other punctuation, enclose the
+ argument in curly brackets.
\target underline-command
\section1 \\underline
The \\underline command renders its argument underlined.
- For example:
+ For example:
- \code
- / *!
- The \underline {F}ile menu gives the users the possibility
- to open, and edit, an existing file, save a new or modified
- file, and exit the application.
- * /
- \endcode
+ \code
+ / *!
+ The \underline {F}ile menu gives the users the possibility
+ to open, and edit, an existing file, save a new or modified
+ file, and exit the application.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- The \underline {F}ile menu gives the users the possibility
- to open, and edit, an existing file, save a new or modified
- file, and exit the application.
- \endquotation
+ \quotation
+ The \underline {F}ile menu gives the users the possibility
+ to open, and edit, an existing file, save a new or modified
+ file, and exit the application.
+ \endquotation
- The \\underline command follows the same conventions as the
- \l {i-command} {\\i} command for \l {argument} {punctuation,
- parentheses and use of braces} for the argument.
+ If the argument contains spaces or other punctuation, enclose the
+ argument in curly brackets.
\target backslash-command
\section1 \\\\ (double backslash)
The \\\\ command expands to a single backslash.
- QDoc commands always start with a backslash alone. To
- display an actual backslash in the text you need to type
- two of the kind. If you want to display two backslashes,
- you need to type four, and so forth. For example:
+ QDoc commands always start with a backslash alone. To display an
+ actual backslash in the text you need to type two of the kind. If
+ you want to display two backslashes, you need to type four, and so
+ forth. For example:
- \code
- / *!
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- * /
- \endcode
+ \code
+ / *!
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- \endquotation
+ \quotation
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ \endquotation
- However, if you want your text to appear in a typewriter
- font as well, you can use the \l {c-command} {\\c} command instead,
- which accepts and renders the backslash as any other
- character. For example:
+ However, if you want your text to appear in a typewriter font as
+ well, you can use the \l {c-command} {\\c} command instead, which
+ accepts and renders the backslash as any other character. For
+ example:
- \code
- / *!
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- * /
- \endcode
+ \code
+ / *!
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this as:
- \quotation
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- \endquotation
+ \quotation
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ \endquotation
*/
--
cgit v0.12
From 7b3f781aa4badba08cb49d61c52a0990485432ec Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 18 Feb 2011 13:46:16 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 597 ++++++++++++++++++---------------------
1 file changed, 280 insertions(+), 317 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index ff764a0..bd3bdef 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -831,33 +831,32 @@
\title Document Structure
- The document structuring commands divide the documentation into
- sections. In total, there are six levels of sections in QDoc: \c
- \part, \c \chapter, \c \section1, \c \section2, \c \section3 and
- \c \section4. \c \section1 to \c \section4 correspond to the
- traditional section, subsection, subsubsection and
- subsubsubsection.
+ The document structuring commands are for dividing your document
+ into sections. QDoc supports six kinds of sections: \c \part, \c
+ \chapter, \c \section1, \c \section2, \c \section3 and \c
+ \section4. The \c \section1..4 commands are the most useful. The
+ correspond to the traditional section, subsection, etc used in
+ outlining.
\target part-command
\section1 \\part
- The \\part command is intended for use in
- larger documents, and divides the document into parts.
+ The \\part command is intended for use in a large document, like a
+ book.
- In general a document structuring command considers
- everything that follows it until the first line break as
- its argument. The argument is rendered as the unit's
- title. If the title needs to be spanned over several lines,
- make sure that each line (except the last one) is ended
- with a backslash.
+ In general a document structuring command considers everything
+ that follows it until the first line break as its argument. The
+ argument is rendered as the unit's title. If the title needs to be
+ spanned over several lines, make sure that each line (except the
+ last one) is ended with a backslash.
- In total, there are six levels of sections in QDoc: \c
- \part, \c \chapter, \c \section1, \c \section2, \c
- \section3 and \c \section4. \c \section1 to \c \section4
- correspond to the traditional section, subsection,
- subsubsection and subsubsubsection.
+ In total, there are six levels of sections in QDoc: \c \part, \c
+ \chapter, \c \section1, \c \section2, \c \section3 and \c
+ \section4. \c \section1 to \c \section4 correspond to the
+ traditional section, subsection, subsubsection and
+ subsubsubsection.
- There is a strict ordering of the section units:
+ There is a strict ordering of the section units:
\code
part
@@ -873,13 +872,12 @@
section4
\endcode
- For example, a \c section1 unit can only appear as the top
- level section or inside a \c chapter unit. Skipping a
- section unit, for example from \c part to \c section1, is
- not allowed.
+ For example, a \c section1 unit can only appear as the top level
+ section or inside a \c chapter unit. Skipping a section unit, for
+ example from \c part to \c section1, is not allowed.
- You can \e begin with either of the three: \c part, \c
- chapter or \c section1. For example:
+ You can \e begin with either of the three: \c part, \c chapter or
+ \c section1. For example:
\code
@@ -939,7 +937,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\raw HTML
@@ -1000,12 +998,9 @@
\endraw
\endquotation
- Each section level is a logical unit within the
- document. Its title will appear in the table of contents
- automatically generated by QDoc. The automatically
- generated table of contents appears in the upper
- righthand corner of the page.
-
+ Each section is a logical unit in the document. The section
+ heading appears in the automatically generated table of contents
+ that normally appears in the upper righthand corner of the page.
\target chapter-command
\section1 \\chapter
@@ -1058,44 +1053,43 @@
\title Including Code Inline
- The following commands are used to render verbatim code within the
- documentation. The code is rendered on a new line, using a
- typewriter font and the standard indentation.
+ The following commands are used to render source code without
+ formatting. The source code begins on a new line, rendered in the
+ code.
- \bold{Note:} Although all of these commands can be used to present
- C++ code, the
+ \bold{Note:} Although all these commands are for rendering C++
+ code, the
\l{07-0-qdoc-commands-includingexternalcode.html#snippet-command}
{\\snippet} and
\l{07-0-qdoc-commands-includingexternalcode.html#codeline-command}
- {\\codeline} commands should be used in preference to the others
- when presenting valid code. This allows auxilliary tools for Qt
- language bindings to substitute the relevant code snippets in
- place of the C++ ones.
+ {\\codeline} commands are preferred over the others. These
+ commands allow equivalent code snippets for other Qt language
+ bindings to be substituted for the C++ snippets in the
+ documentation.
\target code-command
\section1 \\code
- The \\code command and the corresponding
- \\endcode command delimit a piece of verbatim code.
-
- Whereas the \l {c-command} {\\c} command can be used for short code
- fragments within a sentence, the \\code command is for
- longer code snippets and renders the code verbatim in a
- separate paragraph using a typewriter font and the standard
- indentation.
-
- When processing any of the \\code, \l {badcode-command} {\\badcode},
- \l {newcode-command} {\\newcode} and \l {oldcode-command} {\\oldcode}
- commands, QDoc basically removes all indentation that is
- common for the verbatim code blocks within a \c{/}\c{*!} ...
- \c{*}\c{/} comment before it adds the standard
- indentation. For that reason the recommended style is to
- use 8 spaces for the verbatim code contained within these
- commands (note that this doesn't apply to externally
- quoted code using the \l {quotefromfile-command} {\\quotefromfile}
- or \l {quotefile-command} {\\quotefile} command).
+ The \\code and \\endcode commands enclose a snippet of source code.
- For example:
+ \note The \l {c-command} {\\c} command can be used for short code
+ fragments within a sentence. The \\code command is for longer code
+ snippets. It renders the code verbatim in a separate paragraph in
+ the code font.
+
+ When processing any of the \\code, \l {badcode-command}
+ {\\badcode}, \l {newcode-command} {\\newcode} or \l
+ {oldcode-command} {\\oldcode} commands, QDoc removes all
+ indentation that is common for the verbatim code blocks within a
+ \c{/}\c{*!} ... \c{*}\c{/} comment before it adds the standard
+ indentation. For that reason the recommended style is to use 8
+ spaces for the verbatim code contained within these commands
+
+ \note This doesn't apply to externally quoted code using the \l
+ {quotefromfile-command} {\\quotefromfile} or \l
+ {quotefile-command} {\\quotefile} command.
+
+ For example:
\code
/ *!
@@ -1123,36 +1117,36 @@
}
\endcode
- Other QDoc commands are disabled within
- \\code... \\endcode, and the special character '\\' is
- accepted and rendered like the rest of the code.
+ Other QDoc commands are disabled within \\code... \\endcode, and
+ the special character '\\' is accepted and rendered like the rest
+ of the code.
- You need to type the code manually between the \\code and
- \\endcode commands. If you want to include code snippets
- from a particular file, use the \l
- {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
- command instead.
+ To include code snippets from an external file, use the
+ \l{07-0-qdoc-commands-includingexternalcode.html#snippet-command}
+ {\\snippet} and
+ \l{07-0-qdoc-commands-includingexternalcode.html#codeline-command}
+ {\\codeline} commands.
- See also \l {c-command} {\\c}, \l
- {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile},
- \l {badcode-command} {\\badcode}, \l {newcode-command} {\\newcode} and \l
- {oldcode-command} {\\oldcode}.
+ See also \l {c-command} {\\c}, \l
+ {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command}
+ {\\quotefromfile}, \l {badcode-command} {\\badcode}, \l
+ {newcode-command} {\\newcode} and \l {oldcode-command}
+ {\\oldcode}.
\target badcode-command
\section1 \\badcode
- The \\badcode command and the corresponding
- \\endcode command delimit a piece of code that doesn't
- compile or is wrong for some other reason.
+ The \\badcode and \\endcode commands delimit a snippet of code
+ that doesn't compile or is wrong for some other reason.
- The \\badcode command is similar the \l {code-command} {\\code}
- command, but renders the code using a grey font instead of
- black (the default).
+ The \\badcode command is similar to the \l {code-command} {\\code}
+ command, but it renders the code snippet using a grey font instead
+ of black.
- Like the \l {code-command} {\\code} command, it renders its code on
- a new line in the documentation using a typewriter font and
- the standard indentation. For example:
+ Like the \l {code-command} {\\code} command, this command begins
+ its code snippet on a new line rendered in the code font and with
+ the standard indentation. For example:
\code
/ *!
@@ -1172,7 +1166,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The statement below is rendered using the
@@ -1190,32 +1184,29 @@
\endcode
\endquotation
- Other QDoc commands are disabled within
- \\badcode... \\endcode, and the special character '\\' is
- accepted and rendered like the rest of the code.
-
- See also \l {code-command} {\\code}, \l {newcode-command} {\\newcode} and \l
- {oldcode-command} {\\oldcode}.
+ Other QDoc commands are disabled within \\badcode... \\endcode,
+ and the special character '\\' is accepted and rendered like the
+ rest of the code.
+ See also \l {code-command} {\\code}, \l {newcode-command}
+ {\\newcode} and \l {oldcode-command} {\\oldcode}.
\target newcode-command
\section1 \\newcode
- The \\newcode command, and the associated \\oldcode
- and \\endcode commands, indicate how to port a piece of
- code to a new version of an API.
+ The \\newcode, \\oldcode, and \\endcode commands enable you to
+ show how to port a snippet of code to a new version of an API.
- The \\newcode command, and its companion the \\oldcode
- command, is a convenience combination of the \l
- {code-command} {\\code} and \l {badcode-command} {\\badcode} commands: The
- combination provides a text relating the two code snippets
- to each other. The command requires a preceding \\oldcode
- statement.
+ The \\newcode command, and its companion the \\oldcode command, is
+ a convenience combination of the \l {code-command} {\\code} and \l
+ {badcode-command} {\\badcode} commands: The combination provides a
+ text relating the two code snippets to each other. The command
+ requires a preceding \\oldcode statement.
- Like the \l {code-command} {\\code} and \l {badcode-command} {\\badcode}
- commands, the \\newcode command renders its code on a new
- line in the documentation using a typewriter font and the
- standard indentation. For example:
+ Like the \l {code-command} {\\code} and \l {badcode-command}
+ {\\badcode} commands, the \\newcode command renders its code on a
+ new line in the documentation using a typewriter font and the
+ standard indentation. For example:
\code
/ *!
@@ -1230,7 +1221,7 @@
* /
\endcode
- is rendered like this:
+ QDoc renders this as:
\quotation
\oldcode
@@ -1243,10 +1234,8 @@
\endcode
\endquotation
- Other QDoc commands are disabled within
- \\oldcode ... \\endcode, and the '\\' character doesn't need
- to be escaped.
-
+ Other QDoc commands are disabled within \\oldcode ... \\endcode,
+ and the '\\' character doesn't need to be escaped.
\target oldcode-command
\section1 \\oldcode
@@ -1266,34 +1255,34 @@
\title Including External Code
- The following commands enable quoting from files in the
- documentation: You can make QDoc include the complete contents of
+ The following commands enable you to include code snippets from
+ external files. You can make QDoc include the complete contents of
a file, or you can quote specific parts of the file and skip
others. The typical use of the latter is to quote a file chunk by
chunk.
- \bold{Note:} Although all of these commands can be used to present
- C++ code, the \l{#snippet} {\\snippet} and \l{#codeline} {\\codeline}
- commands should be used in preference to
- the others when presenting valid code. This allows auxilliary tools
- for Qt language bindings to substitute the relevant code snippets in
- place of the C++ ones.
+ \bold{Note:} Although all these commands are for rendering C++
+ code, the
+ \l{07-0-qdoc-commands-includingexternalcode.html#snippet-command}
+ {\\snippet} and
+ \l{07-0-qdoc-commands-includingexternalcode.html#codeline-command}
+ {\\codeline} commands are preferred over the others. These
+ commands allow equivalent code snippets for other Qt language
+ bindings to be substituted for the C++ snippets in the
+ documentation.
\target quotefile-command
\section1 \\quotefile
- The \\quotefile command expands to the complete
- contents of the file given as argument.
+ The \\quotefile command expands to the complete contents of the
+ file given as argument.
- The command considers the rest of the line as part of its
- argument, make sure to follow the file name with a line
- break.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the file name with a line break.
- The file's contents is rendered in a separate paragraph,
- using a typewriter font and the standard indentation. The
- code is shown verbatim.
-
- For example:
+ The file's contents is rendered in a separate paragraph, using a
+ typewriter font and the standard indentation. The code is shown
+ verbatim. For example:
\code
/ *!
@@ -1306,7 +1295,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
This is a simple "Hello world" example:
@@ -1317,30 +1306,29 @@
application up and running.
\endquotation
- \warning If you use the \l {Compatibility Issues}
- {compat.qdocconf} file this command is called \\include.
+ \warning If you use the \l {Compatibility Issues}
+ {compat.qdocconf} file this command is called \\include.
- See also \l {quotefromfile-command} {\\quotefromfile} and
- \l {code-command} {\\code}.
+ See also \l {quotefromfile-command} {\\quotefromfile} and
+ \l {code-command} {\\code}.
\target quotefromfile-command
\section1 \\quotefromfile
- The \\quotefromfile command opens the file
- given as argument for quoting.
+ The \\quotefromfile command opens the file given as argument for
+ quoting.
- The command considers the rest of the line as part of its
- argument, make sure to follow the file name with a line
- break.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the file name with a line break.
- The command is intended for use when quoting parts from
- file with the walkthrough commands: \l
- {printline-command} {\\printline}, \l {printto-command} {\\printto}, \l
- {printuntil-command} {\\printuntil}, \l {skipline-command} {\\skipline}, \l
- {skipto-command} {\\skipto}, \l {skipuntil-command} {\\skipuntil}. This
- enables you to quote specific portions of a file. For
- example:
+ The command is intended for use when quoting parts from file with
+ the walkthrough commands: \l {printline-command} {\\printline}, \l
+ {printto-command} {\\printto}, \l {printuntil-command}
+ {\\printuntil}, \l {skipline-command} {\\skipline}, \l
+ {skipto-command} {\\skipto}, \l {skipuntil-command}
+ {\\skipuntil}. This enables you to quote specific portions of a
+ file. For example:
\code
/ *!
@@ -1365,7 +1353,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1388,40 +1376,35 @@
...
\endquotation
- (\l {Example File} {The complete example file...})
-
- QDoc remembers which file it's quoting, and the current
- position within that file (see \l {file} {\\printline} for
- more information). There is no need to "close" the file.
+ (\l {Example File} {The complete example file...})
- Earlier we called this command \\quotefile. For more
- information, see the \l
- {26-qdoc-commands-compatibility.html#quotefromfile-versus-quotefile}
- {compatibility} section.
+ QDoc remembers which file it's quoting, and the current position
+ within that file (see \l {file} {\\printline} for more
+ information). There is no need to "close" the file.
- See also \l {quotefile-command} {\\quotefile}, \l
- {code-command} {\\code} and \l {dots} {\\dots}.
+ Earlier we called this command \\quotefile. For more information,
+ see the \l
+ {26-qdoc-commands-compatibility.html#quotefromfile-versus-quotefile}
+ {compatibility} section.
+ See also \l {quotefile-command} {\\quotefile}, \l {code-command}
+ {\\code} and \l {dots} {\\dots}.
\target printline-command
\section1 \\printline
- The \\printline command expands to the line
- from the current position to the next non-blank line of
- the current souce file.
-
- To ensure that the documentation always is synchronized
- with the source file, a substring of the line must be
- specified as an argument to the command. Note that the
- command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break.
+ The \\printline command expands to the line from the current
+ position to the next non-blank line of the current souce file.
- The line from the source file is rendered as a separate
- paragraph, using a typewriter font and the standard
- indentation. The code is shown verbatim.
+ To ensure that the documentation remains synchronized with the
+ source file, a substring of the line must be specified as an
+ argument to the command. Note that the command considers the rest
+ of the line as part of its argument, make sure to follow the
+ substring with a line break.
- For example:
+ The line from the source file is rendered as a separate paragraph,
+ using a typewriter font and the standard indentation. The code is
+ shown verbatim. For example:
\code
/ *!
@@ -1449,7 +1432,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
There has to be exactly one QApplication object
@@ -1476,22 +1459,20 @@
The main function...
\endquotation
- (\l {Example File} {The complete example file...})
+ (\l {Example File} {The complete example file...})
- \target file
+ \target file
- QDoc reads the file sequentially. To move the current
- position forward you can use either of the \l
- {skipline-command} {\\skip...} commands. To move the current
- position backward, you can use the \l
- {quotefromfile-command} {\\quotefromfile} command again.
+ QDoc reads the file sequentially. To move the current position
+ forward you can use either of the \l {skipline-command}
+ {\\skip...} commands. To move the current position backward, you
+ can use the \l {quotefromfile-command} {\\quotefromfile} command
+ again.
- \target substring
+ \target substring
- If the substring argument is surrounded by slashes it is
- interpreted as a \l {regular expression}.
-
- For example:
+ If the substring argument is surrounded by slashes it is
+ interpreted as a \l {regular expression}. For example:
\code
/ *!
@@ -1508,7 +1489,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\quotefromfile widgets/scribble/mainwindow.cpp
@@ -1523,41 +1504,36 @@
application.
\endquotation
- (\l {widgets/scribble} {The complete example file...})
+ (\l {widgets/scribble} {The complete example file...})
- The regular expression \c /^\}/ makes QDoc print until the
- first '}' character occurring at the beginning of the line
- without indentation. /.../ encloses the regular expression,
- and '^' means the beginning of the line. The '}' character
- must be escaped since it is a special character in regular
- expressions.
+ The regular expression \c /^\}/ makes QDoc print until the first
+ '}' character occurring at the beginning of the line without
+ indentation. /.../ encloses the regular expression, and '^' means
+ the beginning of the line. The '}' character must be escaped since
+ it is a special character in regular expressions.
- QDoc will emit a warning if the specified substring or
- regular expression cannot be located, i.e. if the source
- code has changed.
-
- See also \l {printto-command} {\\printto} and \l
- {printuntil-command} {\\printuntil}.
+ QDoc will emit a warning if the specified substring or regular
+ expression cannot be located, i.e. if the source code has changed.
+ See also \l {printto-command} {\\printto} and \l
+ {printuntil-command} {\\printuntil}.
\target printto-command
\section1 \\printto
- The \\printto command expands to all the lines
- from the current position up to and \e excluding the
- next line containing a given substring.
-
- The command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break. The command also follows the same conventions for \l
- {file} {positioning} and \l {substring} {argument} as the \l
- {printline-command} {\\printline} command.
+ The \\printto command expands to all the lines from the current
+ position up to and \e excluding the next line containing a given
+ substring.
- The lines from the source file are rendered in a separate
- paragraph, using a typewriter font and the standard
- indentation. The code is shown verbatim.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the substring with a line break. The
+ command also follows the same conventions for \l {file}
+ {positioning} and \l {substring} {argument} as the \l
+ {printline-command} {\\printline} command.
- For example:
+ The lines from the source file are rendered in a separate
+ paragraph, using a typewriter font and the standard
+ indentation. The code is shown verbatim. For example:
\code
/ *!
@@ -1572,7 +1548,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1586,30 +1562,27 @@
and \c argv parameters...
\endquotation
- (\l {Example File} {The complete example file...})
-
- See also \l {printline-command} {\\printline} and \l
- {printuntil-command} {\\printuntil}.
+ (\l {Example File} {The complete example file...})
+ See also \l {printline-command} {\\printline} and \l
+ {printuntil-command} {\\printuntil}.
\target printuntil-command
\section1 \\printuntil
- The \\printuntil command expands to all the lines
- from the current position up to and \e including the next line
- containing a given substring.
-
- The command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break. The command also follows the same conventions for \l
- {file} {positioning} and \l {substring} {argument} as the \l
- {printline-command} {\\printline} command.
+ The \\printuntil command expands to all the lines from the current
+ position up to and \e including the next line containing a given
+ substring.
- The lines from the source file are rendered in a separate
- paragraph, using a typewriter font and the standard
- indentation. The code is shown verbatim.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the substring with a line break. The
+ command also follows the same conventions for \l {file}
+ {positioning} and \l {substring} {argument} as the \l
+ {printline-command} {\\printline} command.
- For example:
+ The lines from the source file are rendered in a separate
+ paragraph, using a typewriter font and the standard
+ indentation. The code is shown verbatim. For example:
\code
/ *!
@@ -1626,7 +1599,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1643,29 +1616,27 @@
{http://qt.nokia.com/doc/4.0/qpushbutton} {QPushButton}.
\endquotation
- (\l {Example File} {The complete example file...})
-
- See also \l {printline-command} {\\printline} and \l
- {printto-command} {\\printto}.
+ (\l {Example File} {The complete example file...})
+ See also \l {printline-command} {\\printline} and \l
+ {printto-command} {\\printto}.
\target skipline-command
\section1 \\skipline
- The \\skipline command ignores the next non-blank
- line in the current source file.
+ The \\skipline command ignores the next non-blank line in the
+ current source file.
- Doc reads the file sequentially, and the \\skipline command
- is used to move the current position (omitting a line of
- the source file). See the remark about \l {file} {file
- positioning} above.
+ Doc reads the file sequentially, and the \\skipline command is
+ used to move the current position (omitting a line of the source
+ file). See the remark about \l {file} {file positioning} above.
- The command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break. The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline-command} {\\printline}
- command, and it is used in conjunction with the \l
- {quotefromfile-command} {\\quotefromfile} command. For example:
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the substring with a line break. The
+ command also follows the same conventions for \l {substring}
+ {argument} as the \l {printline-command} {\\printline} command,
+ and it is used in conjunction with the \l {quotefromfile-command}
+ {\\quotefromfile} command. For example:
\code
/ *!
@@ -1683,7 +1654,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\l
@@ -1701,32 +1672,30 @@
that contains its definition.
\endquotation
- (\l {Example File} {The complete example file...})
-
- See also \l {skipto-command} {\\skipto}, \l
- {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
+ (\l {Example File} {The complete example file...})
+ See also \l {skipto-command} {\\skipto}, \l {skipuntil-command}
+ {\\skipuntil} and \l {dots} {\\dots}.
\target skipto-command
\section1 \\skipto
- The \\skipto command ignores all the lines from the
- current position up to and \e excluding the next line
- containing a given substring.
+ The \\skipto command ignores all the lines from the current
+ position up to and \e excluding the next line containing a given
+ substring.
- QDoc reads the file sequentially, and the \\skipto command
- is used to move the current position (omitting one or
- several lines of the source file). See the remark about \l
- {file} {file positioning} above.
+ QDoc reads the file sequentially, and the \\skipto command is used
+ to move the current position (omitting one or several lines of the
+ source file). See the remark about \l {file} {file positioning}
+ above.
- The command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the substring with a line break.
- The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline-command} {\\printline}
- command, and it is used in conjunction with the \l
- {quotefromfile-command} {\\quotefromfile} command. For example:
+ The command also follows the same conventions for \l {substring}
+ {argument} as the \l {printline-command} {\\printline} command,
+ and it is used in conjunction with the \l {quotefromfile-command}
+ {\\quotefromfile} command. For example:
\code
/ *!
@@ -1745,7 +1714,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1761,32 +1730,30 @@
reasonable size ...
\endquotation
- (\l {Example File} {The complete example file...})
-
- See also \l {skipline-command} {\\skipline}, \l
- {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
+ (\l {Example File} {The complete example file...})
+ See also \l {skipline-command} {\\skipline}, \l
+ {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
\target skipuntil-command
\section1 \\skipuntil
- The \\skipuntil command ignores all the lines from
- the current position up to and \e including the next line
- containing a given substring.
+ The \\skipuntil command ignores all the lines from the current
+ position up to and \e including the next line containing a given
+ substring.
- QDoc reads the file sequentially, and the \\skipuntil
- command is used to move the current position (omitting one
- or several lines of the source file). See the remark about
- \l {file} {file positioning} above.
+ QDoc reads the file sequentially, and the \\skipuntil command is
+ used to move the current position (omitting one or several lines
+ of the source file). See the remark about \l {file} {file
+ positioning} above.
- The command considers the rest of the line as part of its
- argument, make sure to follow the substring with a line
- break.
+ The command considers the rest of the line as part of its
+ argument, make sure to follow the substring with a line break.
- The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline-command} {\\printline}
- command, and it is used in conjunction with the \l
- {quotefromfile-command} {\\quotefromfile} command. For example:
+ The command also follows the same conventions for \l {substring}
+ {argument} as the \l {printline-command} {\\printline} command,
+ and it is used in conjunction with the \l {quotefromfile-command}
+ {\\quotefromfile} command. For example:
\code
/ *!
@@ -1804,7 +1771,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
The first thing we did in the \c main() function was to
@@ -1820,22 +1787,21 @@
will return when the application exits...
\endquotation
- (\l {Example File} {The complete example file...})
-
- See also \l {skipline-command} {\\skipline}, \l {skipto-command} {\\skipto}
- and \l {dots} {\\dots}.
+ (\l {Example File} {The complete example file...})
+ See also \l {skipline-command} {\\skipline}, \l {skipto-command}
+ {\\skipto} and \l {dots} {\\dots}.
\target dots-command
\section1 \\dots
- The \\dots command indicates that parts of the
- source file have been omitted when quoting a file.
+ The \\dots command indicates that parts of the source file have
+ been omitted when quoting a file.
- The command is used in conjunction with the \l
- {quotefromfile-command} {\\quotefromfile} command, and should be
- stated on its own line. The dots are rendered on a new
- line, using a typewriter font. For example:
+ The command is used in conjunction with the \l
+ {quotefromfile-command} {\\quotefromfile} command, and should be
+ stated on its own line. The dots are rendered on a new line, using
+ a typewriter font. For example:
\code
/ *!
@@ -1848,7 +1814,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotefromfile examples/main.cpp
\skipto main
@@ -1857,34 +1823,31 @@
\skipuntil exec
\printline }
- (\l {Example File} {The complete example file...})
+ (\l {Example File} {The complete example file...})
- The default indentation is 4 spaces, but this can be
- adjusted using the command's optional argument. For
- example:
+ The default indentation is 4 spaces, but this can be adjusted
+ using the command's optional argument. For example:
- \code
- / *!
- \dots 0
- \dots
- \dots 8
- \dots 12
- \dots 16
- * /
- \endcode
-
- QDoc renders this as:
+ \code
+ / *!
+ \dots 0
+ \dots
+ \dots 8
+ \dots 12
+ \dots 16
+ * /
+ \endcode
- \dots 0
- \dots
- \dots 8
- \dots 12
- \dots 16
+ QDoc renders this as:
- See also \l {skipline-command} {\\skipline}, \l
- {skipto-command} {\\skipto} and \l {skipuntil-command}
- {\\skipuntil}.
+ \dots 0
+ \dots
+ \dots 8
+ \dots 12
+ \dots 16
+ See also \l {skipline-command} {\\skipline}, \l {skipto-command}
+ {\\skipto} and \l {skipuntil-command} {\\skipuntil}.
\target snippet-command
\section1 \\snippet
--
cgit v0.12
From aed0f544aebd63ed812a6832feca2d52bf981eba Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 18 Feb 2011 14:13:23 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 233 +++++++++++++++++++--------------------
1 file changed, 112 insertions(+), 121 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index bd3bdef..da636f3 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -1855,22 +1855,22 @@
The \\snippet command causes a code snippet to be included
verbatim as preformatted text, which may be syntax highlighted.
- Each code snippet are referenced by the file that holds it and by
- a unique identifier for that file. Snippet files are typically
- stored in a \c{snippets} directory inside the documentation
- directory (e.g., \c{$QTDIR/doc/src/snippets}).
+ Each code snippet are referenced by the file that holds it and by
+ a unique identifier for that file. Snippet files are typically
+ stored in a \c{snippets} directory inside the documentation
+ directory (e.g., \c{$QTDIR/doc/src/snippets}).
- For example, the following documentation references a snippet in
- a file residing in a subdirectory of the documentation directory:
+ For example, the following documentation references a snippet in a
+ file residing in a subdirectory of the documentation directory:
\code
\snippet snippets/textdocument-resources/main.cpp Adding a resource
\endcode
- The text following the file name is the unique identifier for the
- snippet. This is used to delimit the quoted code in the relevant
- snippet file as shown in the following example that corresponds to
- the above \c{\\snippet} command:
+ The text following the file name is the unique identifier for the
+ snippet. This is used to delimit the quoted code in the relevant
+ snippet file as shown in the following example that corresponds to
+ the above \c{\\snippet} command:
\dots
\code
@@ -2419,19 +2419,19 @@
\title Tables and Lists
- The container commands create tables and lists with associated
- items and contents. A list is rendered left aligned as a separate
- paragraph. A table is rendered centered as a separate paragraph,
- and its width depends on its content.
+ These commands enable creating lists and tables. A list is
+ rendered left aligned as a separate paragraph. A table is rendered
+ centered as a separate paragraph. The table width depends on the
+ width of its contents.
\target table-command
\section1 \\table
- The \\table command and the corresponding \\endtable
- command delimit the contents of a table.
+ The \\table and \\endtable commands delimit the contents of a
+ table.
- The command accepts a single argument specifying the
- table's width in percentage:
+ The command accepts a single argument specifying the table's width
+ as a percentage of the page width:
\code
/ *!
@@ -2443,15 +2443,15 @@
* /
\endcode
- The code above ensures that the table will fill all
- available space. If the table's width is smaller than 100 %,
- the table will be centered in the generated documentation.
+ The code above ensures that the table will fill all available
+ space. If the table's width is smaller than 100 %, the table will
+ be centered in the generated documentation.
- A table can contain headers, rows and columns. A row starts
- with a \l {row-command} {\\row} command and consists of cells, which
- starts with a \l {o-command} {\\o} command. There is also a \l
- {header-command} {\\header} command which is a special kind of row
- with a special formatting. For example:
+ A table can contain headers, rows and columns. A row starts with a
+ \l {row-command} {\\row} command and consists of cells, which
+ starts with a \l {o-command} {\\o} command. There is also a \l
+ {header-command} {\\header} command which is a special kind of row
+ with a special formatting. For example:
\code
/ *!
@@ -2477,7 +2477,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2517,8 +2517,8 @@
</table>
\endraw
- You can also make cells span several rows and columns. For
- example:
+ You can also make cells span several rows and columns. For
+ example:
\code
/ *!
@@ -2538,7 +2538,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -2567,22 +2567,20 @@
</table>
\endraw
- See also \l {header-command} {\\header}, \l {row-command} {\\row} and \l {o-command} {\\o}.
-
+ See also \l {header-command} {\\header}, \l {row-command} {\\row} and \l {o-command} {\\o}.
\target header-command
\section1 \\header
- The \\header command indicates that the following
- table cells are the current table's column headers.
+ The \\header command indicates that the following table cells are
+ the current table's column headers.
- The command can only be used within the \l{table-command}
- {\\table...\\endtable} commands. A header can contain
- several cells. A cell is created with the \l {o-command} {\\o}
- command.
+ The command can only be used within the \l{table-command}
+ {\\table...\\endtable} commands. A header can contain several
+ cells. A cell is created with the \l {o-command} {\\o} command.
- A header cell's text is centered within the table cell and
- rendered using a bold font. For example:
+ A header cell's text is centered within the table cell and
+ rendered using a bold font. For example:
\code
/ *!
@@ -2598,7 +2596,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2619,25 +2617,22 @@
</table>
\endraw
- See also \l {table-command} {\\table}, \l {row-command} {\\row} and \l {o-command} {\\o}.
-
+ See also \l {table-command} {\\table}, \l {row-command} {\\row} and \l {o-command} {\\o}.
\target row-command
\section1 \\row
- The \\row command indicates that the following table
- cells belong to the same row in the current table.
+ The \\row command begins a new row in a table. The \l {o-command}
+ {\\o items} that belong in the new row will immediately follow the
+ \\row.
- The command can only be used within the \l{table-command}
- {\\table...\\endtable} commands. A row can contain
- several cells. A cell is created with the \l {o-command} {\\o}
- command.
+ The command can only be used within the \l{table-command}
+ {\\table...\\endtable} commands. A row can contain several
+ cells. A cell is created with the \l {o-command} {\\o} command.
- The background cell color of each row alternate between two
- shades of grey, making it easier to distinguish the rows
- from each other. The cells' contents is left aligned.
-
- For example:
+ The background cell color of each row alternates between two
+ shades of grey, making it easier to distinguish the rows from each
+ other. The cells' contents is left aligned. For example:
\code
/ *!
@@ -2663,7 +2658,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2703,50 +2698,45 @@
</table>
\endraw
- See also \l {table-command} {\\table}, \l {header-command} {\\header} and \l
- {o-command} {\\o}.
-
+ See also \l {table-command} {\\table}, \l {header-command}
+ {\\header} and \l {o-command} {\\o}.
\target value-command
\section1 \\value
- The \\value command starts the documentation of a C++ enum
- item.
+ The \\value command starts the documentation of a C++ enum item.
- The command's first argument is the enum item. Then follows
- its associated description. The description argument ends
- at the next blank line or \\value. The arguments are
- rendered within a table.
+ The command's first argument is the enum item. Then follows its
+ associated description. The description argument ends at the next
+ blank line or \\value. The arguments are rendered within a table.
- The documentation will be located in the associated class,
- header file or namespace documentation. See the \l {enum-command}
- {\\enum} documentation for an example.
-
- See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
+ The documentation will be located in the associated class, header
+ file or namespace documentation. See the \l {enum-command}
+ {\\enum} documentation for an example.
+ See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
\target omitvalue-command
\section1 \\omitvalue
- The \\omitvalue command excludes a C++ enum item
- from the documentation.
-
- The command's only argument is the name of the enum item
- that will be omitted. See the \l {enum-command} {\\enum}
- documentation for an example.
+ The \\omitvalue command excludes a C++ enum item from the
+ documentation.
- See also \l {enum-command} {\\enum} and \l {value-command} {\\value}.
+ The command's only argument is the name of the enum item that will
+ be omitted. See the \l {enum-command} {\\enum} documentation for
+ an example.
+ See also \l {enum-command} {\\enum} and \l {value-command}
+ {\\value}.
\target list-command
\section1 \\list
- The \\list command and the corresponding \\endlist
- command delimit a list of items.
+ The \\list and \\endlist commands delimit a list of items.
- You need to create each list item explicitly using the \l
- {o-command} {\\o} command. A list can contain one or more items; it
- can also be nested. For example:
+ Create each list item with the \l {o-command} {\\o} command. A
+ list always contains one or more items. Lists can be nested. For
+ example:
\code
/ *!
@@ -2767,7 +2757,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\list
\o Qt Reference Documentation: Getting Started
@@ -2784,8 +2774,8 @@
\endlist
\endlist
- The \\list command takes an optional argument providing
- alternative appearances for the list items. For example:
+ The \\list command takes an optional argument providing
+ alternative appearances for the list items. For example:
\code
/ *!
@@ -2797,7 +2787,7 @@
* /
\endcode
- will render the list items with bullets (the default):
+ QDoc renders the list items with bullets (the default):
\list
\o How to Learn Qt
@@ -2805,9 +2795,12 @@
\o Tutorial and Examples
\endlist
- If you provide 'A' as an argument to the \\list command,
- the bullets are replaced with characters following in
- alphabetical order:
+ \warning There appears to be a bug in qdoc3 here. If you include
+ any of the argument types, you get a numeric list. We're looking
+ into it.
+
+ If you provide 'A' as an argument to the \\list command, the
+ bullets are replaced with characters in alphabetical order:
\list A
\o How to Learn Qt
@@ -2815,8 +2808,8 @@
\o Tutorial and Examples
\endlist
- If you replace 'A' with '1', the list items are rendered
- with numbers following in ascending order:
+ If you replace 'A' with '1', the list items are numbered in
+ ascending order:
\list 1
\o How to Learn Qt
@@ -2825,8 +2818,8 @@
\endlist
- If you provide 'i' as the argument, the default bullets are
- replaced with roman numerals:
+ If you provide 'i' as the argument, the bullets are replaced with
+ roman numerals:
\list i
\o How to Learn Qt
@@ -2834,9 +2827,9 @@
\o Tutorial and Examples
\endlist
- Or finally, you can make the list items appear with roman
- numbers following in ascending order if you provide 'I' as
- the optional argument:
+ Finally, you can make the list items appear with roman numbers
+ following in ascending order if you provide 'I' as the optional
+ argument:
\list I
\o How to Learn Qt
@@ -2844,9 +2837,9 @@
\o Tutorial and Examples
\endlist
- You can also make the listing start at any character or
- number by simply provide the number or character you want
- to start at. For example:
+ You can also make the listing start at any character or number by
+ simply provide the number or character you want to start at. For
+ example:
\code
/ *!
@@ -2858,7 +2851,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\list G
\o How to Learn Qt
@@ -2866,32 +2859,30 @@
\o Tutorial and Examples
\endlist
- See also \l {o-command} {\\o}.
-
+ See also \l {o-command} {\\o}.
\target o-command
- \section1 \\o
+ \section1 \\o (cell, item)
The \\o command announce a table or list item.
- Earlier we used the \l {i-command} {\\i} command for this purpose. For more
- information see the \l
- {26-qdoc-commands-compatibility.html#o-versus-i} {compatibility}
- section.
+ Earlier we used the \l {i-command} {\\i} command for this
+ purpose. For more information see the \l
+ {26-qdoc-commands-compatibility.html#o-versus-i} {compatibility}
+ section.
- The command can only be used within the \l{table-command}
- {\\table...\\endtable} or \l{list-command} {\\list... \\endlist}
- commands.
+ The command can only be used within the \l{table-command}
+ {\\table...\\endtable} or \l{list-command} {\\list... \\endlist}
+ commands.
- It considers everything until the next occurrence
- of the \\o command, or the currently applicable \l
- {table-command} {\\endtable} or \l {list-command} {\\endlist} command, as its
- argument. For examples, see \l {table-command} {\\table} and \l
- {list-command} {\\list}.
+ It considers everything until the next occurrence of the \\o
+ command, or the currently applicable \l {table-command}
+ {\\endtable} or \l {list-command} {\\endlist} command, as its
+ argument. For examples, see \l {table-command} {\\table} and \l
+ {list-command} {\\list}.
- If the command is used within a table, you can in addition
- specify how many rows or columns the item should span. For
- example:
+ If the command is used within a table, you can in addition specify
+ how many rows or columns the item should span. For example:
\code
/ *!
@@ -2911,7 +2902,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -2940,10 +2931,10 @@
</table>
\endraw
- If not specified, the item will span one column and one row.
+ If not specified, the item will span one column and one row.
- See also \l {table-command} {\\table}, \l {header-command} {\\header},
- \l {list-command} {\\list} and \l {o-command} {\\o}.
+ See also \l {table-command} {\\table}, \l {header-command}
+ {\\header}, \l {list-command} {\\list} and \l {o-command} {\\o}.
*/
--
cgit v0.12
From 6be3b8e5ccf5992039e7d625c55f335d13224373 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 18 Feb 2011 14:23:41 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 115 +++++++++++++++++----------------------
1 file changed, 51 insertions(+), 64 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index da636f3..4506b85 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -2956,21 +2956,21 @@
The \\abstract and \\endabstract commands delimit a
document's abstract section.
- The abstract section is rendered as an indented italicized
- paragraph.
-
- \warning The \bold{\\abstract} and \bold{\\endabstract} commands
- have not been implemented. The abstract section is rendered as a
- regular HTML paragraph.
+ The abstract section is rendered as an indented italicized
+ paragraph.
+ \warning The \bold{\\abstract} and \bold{\\endabstract} commands
+ have not been implemented. The abstract section is rendered as a
+ regular HTML paragraph.
\target quotation-command
\section1 \\quotation
The \\quotation and \\endquotation commands delimit a long quotation.
- The text in the delimited block is surrounded by \bold{<blockquote>}
- and \bold{</blockquote>} in the html output, e.g.:
+ The text in the delimited block is surrounded by
+ \bold{<blockquote>} and \bold{</blockquote>} in the html output,
+ e.g.:
\code
/ *!
@@ -2988,7 +2988,7 @@
* /
\endcode
- The text in the \bold{\\quotation} block will appear in the generated HTML as:
+ The text in the \bold{\\quotation} block will appear in the generated HTML as:
\code
<blockquote>
@@ -2998,9 +2998,9 @@
</blockquote>
\endcode
- The built-in style sheet for most browsers will render the
- contents of the <blockquote> tag with left and right
- indentations. The example above would be rendered as:
+ The built-in style sheet for most browsers will render the
+ contents of the <blockquote> tag with left and right
+ indentations. The example above would be rendered as:
\quotation
As our solutions were being adopted into new
@@ -3009,25 +3009,23 @@
applications.
\endquotation
- But you can redefine the \bold{<blockquote>} tag in your style.css file.
-
- This command replaces the old \\quote command. For more information
- see the \l {26-qdoc-commands-compatibility.html#quotation-versus-quote}
- {compatibility} section.
+ But you can redefine the \bold{<blockquote>} tag in your style.css file.
+ This command replaces the old \\quote command. For more
+ information see the \l
+ {26-qdoc-commands-compatibility.html#quotation-versus-quote}
+ {compatibility} section.
\target footnote-command
\section1 \\footnote
- The \\footnote command and the corresponding
- \\endfootnote command delimit a footnote.
-
- The footnote is rendered at the bottom of the page.
+ The \\footnote and \\endfootnote commands delimit a footnote.
- \warning The \bold{\\footnote} and \bold{\\endfootnote}
- commands have not been implemented. The footnote is
- rendered as a regular HTML paragraph.
+ The footnote is rendered at the bottom of the page.
+ \warning The \bold{\\footnote} and \bold{\\endfootnote} commands
+ have not been implemented. The footnote is rendered as a regular
+ HTML paragraph.
\target tableofcontents-command
\section1 \\tableofcontents
@@ -3035,35 +3033,31 @@
The \\tableofcontents command has been disabled because QDoc
now generates a table of contents automatically.
- The automatically generated table of contents appears in the upper
- righthand corner of the page.
-
+ The automatically generated table of contents appears in the upper
+ righthand corner of the page.
\target brief-command
\section1 \\brief
- The \\brief command introduces a one-sentence
- description of a class, namespace, header file, property
- or variable.
+ The \\brief command introduces a one-sentence description of a
+ class, namespace, header file, property or variable.
- The brief text is used to introduce the documentation of
- the associated object, and in lists generated using the \l
- {generatelist-command} {\\generatelist} command.
+ The brief text is used to introduce the documentation of the
+ associated object, and in lists generated using the \l
+ {generatelist-command} {\\generatelist} command.
- The \\brief command can be used in two significant
- different ways: \l {brief class} {One for classes,
- namespaces and header files}, and \l {brief-property} {one
- for properties and variables}.
+ The \\brief command can be used in two significant different ways:
+ \l {brief class} {One for classes, namespaces and header files},
+ and \l {brief-property} {one for properties and variables}.
- \target brief-property
+ \target brief-property
- When the \\brief command is used to describe a property or
- a variable, the brief text must be a sentence fragment
- starting with "whether" (for a boolean property or
- variable) or starting with "the" (for any other property
- or variable).
+ When the \\brief command is used to describe a property or a
+ variable, the brief text must be a sentence fragment starting with
+ "whether" (for a boolean property or variable) or starting with
+ "the" (for any other property or variable).
- For example the boolean QWidget::isWindow property:
+ For example the boolean QWidget::isWindow property:
\code
/ *!
@@ -3098,7 +3092,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3124,24 +3118,17 @@
{QWidget::rect()} {rect()}, ...
\endquotation
- \target brief class
+ \target brief class
- When the \\brief command is used to describe a class, the
- brief text should be a complete sentence and must start
- like this:
+ When the \\brief command is used to describe a class, the brief
+ text should be a complete sentence and must start like this:
\code
The <classname> class is|provides|contains|specifies...
\endcode
- and likewise when the command is used for namespaces or
- header files.
-
- \warning The brief statement is used as the first
- paragraph of the detailed description. Do not repeat the
- sentence.
-
- For example:
+ \warning The brief statement is used as the first paragraph of the
+ detailed description. Do not repeat the sentence. For example:
\code
/ *!
@@ -3161,7 +3148,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3223,6 +3210,7 @@
<hr />
<h2>Detailed Description</h2>
\endraw
+
The PreviewWindow class is a custom widget displaying
the names of its currently set window flags in a
read-only text editor.
@@ -3262,7 +3250,7 @@
the text in the widgets text editor.
\endquotation
- Using \\brief with a namespace can for example look like this:
+ Using \\brief in a \l{namespace-command}{\\namespace}:
\code
/ *!
@@ -3273,8 +3261,7 @@
* /
\endcode
- and finally using \\brief with a header file can look
- something like this:
+ Using \\brief in a \l{headerfile-command}{\\headerfile}:
\code
/ *!
@@ -3288,9 +3275,9 @@
* /
\endcode
- See also \l{property-command} {\\property}, \l{class-command} {\\class},
- \l{namespace-command} {\\namespace} and \l{headerfile-command} {\\headerfile}.
-
+ See also \l{property-command} {\\property}, \l{class-command}
+ {\\class}, \l{namespace-command} {\\namespace} and
+ \l{headerfile-command} {\\headerfile}.
\target legalese-command
\section1 \\legalese
--
cgit v0.12
From 1743bce4ff6fc4cb6788964ce0cc653aa0988b7e Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 21 Feb 2011 12:09:33 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 356 ++++++++++++++++-----------------------
1 file changed, 145 insertions(+), 211 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 4506b85..03ca0a9 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -3284,11 +3284,11 @@
The \\legalese and \\endlegalese commands delimit a licence agreement.
- In the generated HTML, the delimited text is surrounded by a
- \bold {<div class="LegaleseLeft">} and \bold {</div>} tags.
+ In the generated HTML, the delimited text is surrounded by a \bold
+ {<div class="LegaleseLeft">} and \bold {</div>} tags.
- For example, here is a license agreement enclosed in \\legalese and
- \\endlegalese:
+ For example, here is a license agreement enclosed in \\legalese
+ and \\endlegalese:
\code
/ *!
@@ -3335,26 +3335,23 @@
</div>
\endcode
- If the \\endlegalese command is omitted, QDoc will still
- process the \\legalese command but considers the rest of the
- documentation page as the license agreement.
+ If the \\endlegalese command is omitted, QDoc will process the
+ \\legalese command but considers the rest of the documentation
+ page as the license agreement.
- Ideally, the license text is located with the licensed code.
-
- Elsewhere, the documentation identified as \e{\\legalese}
- command can be accumulated using \l {generatelist-command}
- {\\generatelist} with \c {legalese-command} as the argument. This is
- useful for generating an overview of the license agreements
- associated with the source code.
+ Ideally, the license text is located with the licensed code.
+ Elsewhere, the documentation identified as \e{\\legalese} command
+ can be accumulated using \l {generatelist-command} {\\generatelist}
+ with \c {legalese-command} as the argument. This is useful for
+ generating an overview of the license agreements associated with
+ the source code.
\target warning-command
\section1 \\warning
- The \\warning command renders a "Warning:" prefix to
- the command's argument.
-
- For example:
+ The \\warning command prepends "Warning:" to the command's
+ argument, in bold font. For example:
\code
/ *!
@@ -3367,7 +3364,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
Qt::HANDLE is a platform-specific handle type
@@ -3388,9 +3385,9 @@
\title Miscellaneous
- These commands provide miscellaneous functions
- connected to the visual appearance of the documentation, and to the
- process of generating the documentation.
+ These commands provide miscellaneous functions connected to the
+ visual appearance of the documentation, and to the process of
+ generating the documentation.
\target expire-command
\section1 \\expire
@@ -3398,10 +3395,10 @@
The \\expire command allows you to define an expiration
date for your documentation.
- When using the \\expire command, QDoc will emit a warning
- when the current date is larger than the specified
- date. The command accepts one argument; the argument's
- format is yyyy-mm-dd. For example:
+ When using the \\expire command, QDoc will emit a warning when the
+ current date is larger than the specified date. The command
+ accepts one argument; the argument's format is yyyy-mm-dd. For
+ example:
\code
/ *!
@@ -3420,7 +3417,7 @@
* /
\endcode
- If you run QDoc on 4 July 2005, it will emit the warning
+ If you run QDoc on 4 July 2005, it will emit the warning
\quotation
porting.qdoc:6: Documentation expired 185 days ago
@@ -3430,10 +3427,9 @@
\target generatelist-command
\section1 \\generatelist
- The \\generatelist command expands to a list of
- various documentation or links to documentation.
-
- For example in the Qt Reference Documentation:
+ The \\generatelist command expands to a list of various
+ documentation or links to documentation. Below is an example from
+ the Qt Reference Documentation:
\code
/ *!
@@ -3449,225 +3445,163 @@
* /
\endcode
- is used to generate \l {All Classes}.
-
- The command accepts the following arguments:
-
- \target table example
-
- \section2 \c annotatedclasses
-
- The \c annotatedclasses argument provides a table
- containing the names of all the classes, and a
- description of each class. Each class name is a link to
- the class's reference documentation.
-
- For example:
-
- \table
- \row
- \o QDial
- \o Rounded range control (like a speedometer or potentiometer)
- \row
- \o QDialog
- \o The base class of dialog windows
- \row
- \o QDir
- \o Access to directory structures and their contents
- \endtable
-
- \quotation
- \raw HTML
- <table align="center" cellpadding="2"
- cellspacing="1" border="0">
-
- <tr valign="top" bgcolor="#d0d0d0">
- <td>
- <a href="http://qt.nokia.com/doc/4.0/qdial.html">
- QDial</a>
- </td>
- <td>Rounded range control (like a speedometer
- or potentiometer)</td>
- </tr>
-
- <tr valign="top" bgcolor="#d0d0d0">
- <td>
- <a href="http://qt.nokia.com/doc/4.0/qdialog.html">
- QDialog</a>
- </td>
- <td>The base class of dialog windows</td>
- </tr>
-
- <tr valign="top" bgcolor="#d0d0d0">
- <td>
- <a href="http://qt.nokia.com/doc/4.0/qdir.html">
- QDir</a>
- </td>
- <td>Access to directory structures and their
- contents</td>
- </tr>
- </table>
- \endraw
- \endquotation
-
- A class is identified within the documentation by the
- the \l {class-command} {\\class} command, and the descriptions
- are based on the argument of the \l {brief-command} {\\brief}
- commands in the class documentation.
-
- \target list example
-
- \section2 \c classes
-
- The \c classes argument provides a complete alphabetical
- list of the classes. Each class name is a link to the
- class's reference documentation.
-
- For example:
-
- \quotation
- \raw HTML
- <p><table width="100%">
-
- <tr>
- <td align="right"><b>A </b></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractbutton.html">QAbstractButton</a></td>
+ This generates the \l {All Classes} page. The command accepts the
+ following arguments:
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionmanager.html">QAbstractExtensionManager</a></td>
+ \target table example
+ \section2 \c annotatedclasses
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemmodel.html">QAbstractItemModel</a></td>
- </tr>
-
- <tr>
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstracteventdispatcher.html">QAbstractEventDispatcher</a></td>
+ The \c annotatedclasses argument provides a table containing the
+ names of all the classes, and a description of each class. Each
+ class name is a link to the class's reference documentation. For
+ example:
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractformbuilder.html">QAbstractFormBuilder</a></td>
+ \table
+ \row
+ \o QDial
+ \o Rounded range control (like a speedometer or potentiometer)
+ \row
+ \o QDialog
+ \o The base class of dialog windows
+ \row
+ \o QDir
+ \o Access to directory structures and their contents
+ \endtable
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemview.html">QAbstractItemView</a></td>
- </tr>
+ A C++ class is documented with the \l {class-command} {\\class}
+ command. The annotation for the class is taken from the argument
+ of the class comment's \l {brief-command} {\\brief} command.
- <tr>
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionfactory.html">QAbstractExtensionFactory</a></td>
+ \target list example
+ \section2 \c classes
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemdelegate.html">QAbstractItemDelegate</a></td>
+ The \c classes argument provides a complete alphabetical list of
+ the classes. Each class name is a link to the class's reference
+ documentation.
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractlistmodel.html">QAbstractListModel</a></td>
- </tr>
- </table></p>
- \endraw
- \endquotation
+ For example:
- A class is identified within the documentation by the
- the \l {class-command} {\\class} command.
+ \quotation
+ \raw HTML
+ <p>
+ <table width="100%">
+ <tr>
+ <td align="right"><b>A </b></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractbutton.html">QAbstractButton</a></td>
- \section2 \c classesbymodule
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionmanager.html">QAbstractExtensionManager</a></td>
- This particular argument requests an additional argument,
- i.e. a specification of the module.
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemmodel.html">QAbstractItemModel</a></td>
+ </tr>
- For example:
+ <tr>
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstracteventdispatcher.html">QAbstractEventDispatcher</a></td>
- \code
- / *!
- \page qtgui.html
- \contentspage Qt Classes by Module
- \previouspage QtCore Classes
- \nextpage QtNetwork Classes
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractformbuilder.html">QAbstractFormBuilder</a></td>
- \title QtGui Classes
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemview.html">QAbstractItemView</a></td>
+ </tr>
- \keyword QtGui
+ <tr>
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionfactory.html">QAbstractExtensionFactory</a></td>
- \generatelist {classesbymodule QtGui}
- * /
- \endcode
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemdelegate.html">QAbstractItemDelegate</a></td>
- Together, these arguments provide a table containing the
- classes considered members of the specified module,
- accompanied with a brief description. Each class name is
- a link to the class's reference documentation.
+ <td align="right"></td>
+ <td><a href="http://qt.nokia.com/doc/4.0/qabstractlistmodel.html">QAbstractListModel</a></td>
+ </tr>
+ </table></p>
+ \endraw
+ \endquotation
- The generated table is rendered similarily to the one
- generated when using the \l {table example} {\c
- annotatedclasses} argument.
+ A C++ class is documented with the \l {class-command} {\\class}
+ command.
- For the basic classes in Qt, a class's module is
- determined by its location, i.e. its directory. However,
- for extensions, like ActiveQt and Qt Designer, a class
- is related to a module with the \l
- {inmodule-command} {\\inmodule} command.
+ \section2 \c classesbymodule
- \section2 \c classesbyedition
+ When this argument is used, a second argument is required, which
+ specifies the module whose classes are to be listed. QDoc
+ generates a table containing those classes. Each class is listed
+ with the text of its \l{brief-command} {\\brief} command.
- This particular argument requests an additional argument,
- i.e. a specification of the edition.
+ This command is used to generate the \l {phonon-module.html}
+ {Phonon Module} page this way.
- For example:
+ \code
+ / *!
+ \page phonon-module.html
+ \module Phonon
+ \title Phonon Module
+ \ingroup modules
- \code
- / *!
- \page console-edition-classes.html
- \title Qt Console Edition Classes
+ \brief The Phonon module contains namespaces and classes for multimedia functionality.
- \generatelist{classesbyedition Console}
- * /
- \endcode
+ \generatelist{classesbymodule Phonon}
- Together, these arguments provide a table containing the
- classes considered members of the specified edition,
- accompanied with a brief description. Each class name is
- a link to the class's reference documentation.
+ ...
- The edition a given class can be found in is determined by
- the module it belongs to.
+ * /
+ \endcode
- \section2 \c compatclasses
+ Each class that is a member of the specified module must be
+ marked with the \l {inmodule-command} {\\inmodule} command in
+ its \\class comment.
- The \c compatclasses argument provides a complete and
- alphabetical list of the support classes. A support
- class is identified within the documentation by the \l
- {compat-command} {\\compat} command. Each class name is
- a link to the class's reference documentation. The list
- is rendered similarily to the list generated by the \l
- {list example} {\c classes} argument.
+ \section2 \c compatclasses
- \warning The \c classesbymodule argument will at some
- point replace the this argument.
+ The \c compatclasses argument generates a list in alphabetical
+ order of the support classes. It is normally used only to
+ generate the \l {compatclasses.html} {Qt3 Support Classes} page
+ this way:
- \section2 \c functionindex
+ \code
+ / *!
+ \page compatclasses.html
+ \title Qt3 Support Classes
+ \ingroup classlists
- The \c functionindex argument provides a complete
- alphabetical list of all the documented member
- functions.
+ \brief These classes ease the porting of code from Qt 3 to Qt 4.
- For example:
+ These are the classes that Qt provides for compatibility with Qt
+ 3. Most of these are provided by the Qt3Support module.
- \quotation
- \raw HTML
- <p><center><font size="+1"><b><a href="#a">A</a> <a href="#b">B</a> <a href="#c">C</a> <a href="#d">D</a> <a href="#e">E</a> <a href="#f">F</a> <a href="#g">G</a> <a href="#h">H</a> <a href="#i">I</a> <a href="#j">J</a> <a href="#k">K</a> <a href="#l">L</a> <a href="#m">M</a> <a href="#n">N</a> <a href="#o">O</a> <a href="#p">P</a> <a href="#q">Q</a> <a href="#r">R</a> <a href="#s">S</a> <a href="#t">T</a> <a href="#u">U</a> <a href="#v">V</a> <a href="#w">W</a> <a href="#x">X</a> <a href="#y">Y</a> <a href="#z">Z</a> </b></font></center></p>
+ \generatelist compatclasses
+ * /
+ \endcode
- <p>DTDHandler: <a href="http://qt.nokia.com/doc/4.0/qxmlreader.html#DTDHandler">QXmlReader</a></p>
+ A support class is identified in the \\class comment with the \l
+ {compat-command} {\\compat} command.
- <p>QAXCLASS: <a href="http://qt.nokia.com/doc/4.0/qaxfactory.html#QAXCLASS">global</a></p>
+ \section2 \c functionindex
- <p>QAXFACTORY_BEGIN: <a href="http://qt.nokia.com/doc/4.0/qaxfactory.html#QAXFACTORY_BEGIN">global</a></p>
+ The \c functionindex argument provides a complete alphabetical
+ list of all the documented member functions. It is normally used
+ only to generate the \l {functions.html} {Qt function index}
+ page this way:
- <p>QAXFACTORY_DEFAULT: <a href="http://qt.nokia.com/doc/4.0/qaxfactory.html#QAXFACTORY_DEFAULT">global</a></p>
+ \code
+ / *!
+ \page functions.html
+ \title All Functions
+ \ingroup funclists
- <p>QAXFACTORY_END: <a href="http://qt.nokia.com/doc/4.0/qaxfactory.html#QAXFACTORY_END">global</a></p>
+ \brief All documented Qt functions listed alphabetically with a
+ link to where each one is declared.
- \endraw
+ This is the list of all documented member functions and global
+ functions in the Qt API. Each function has a link to the class or
+ header file where it is declared and documented.
- ...
- \endquotation
+ \generatelist functionindex
+ * /
+ \endcode
\section2 \c legalese
--
cgit v0.12
From b8c69107e2675b8c2895b8354781c60d3be560df Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 21 Feb 2011 12:20:22 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 172 +++++++++++++++++----------------------
1 file changed, 74 insertions(+), 98 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 03ca0a9..908eeb9 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -3477,131 +3477,107 @@
The \c classes argument provides a complete alphabetical list of
the classes. Each class name is a link to the class's reference
- documentation.
-
- For example:
-
- \quotation
- \raw HTML
- <p>
- <table width="100%">
- <tr>
- <td align="right"><b>A </b></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractbutton.html">QAbstractButton</a></td>
-
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionmanager.html">QAbstractExtensionManager</a></td>
-
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemmodel.html">QAbstractItemModel</a></td>
- </tr>
-
- <tr>
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstracteventdispatcher.html">QAbstractEventDispatcher</a></td>
+ documentation. This command is uded to generate the \l
+ {classes.html} {All Classes} page this way:
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractformbuilder.html">QAbstractFormBuilder</a></td>
-
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemview.html">QAbstractItemView</a></td>
- </tr>
+ \code
+ / *!
+ \page classes.html
+ \title All Classes
+ \ingroup classlists
- <tr>
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractextensionfactory.html">QAbstractExtensionFactory</a></td>
+ \brief If you know the name of the class you want, find it here.
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractitemdelegate.html">QAbstractItemDelegate</a></td>
+ This is a list of all Qt classes. For a list of the classes
+ provided for compatibility with Qt3, see \l{Qt3 Support
+ Classes}. For classes that have been deprecated, see the
+ \l{Obsolete Classes} list.
- <td align="right"></td>
- <td><a href="http://qt.nokia.com/doc/4.0/qabstractlistmodel.html">QAbstractListModel</a></td>
- </tr>
- </table></p>
- \endraw
- \endquotation
+ \generatelist classes
+ * /
+ \endcode
- A C++ class is documented with the \l {class-command} {\\class}
- command.
+ A C++ class is documented with the \l {class-command} {\\class}
+ command.
- \section2 \c classesbymodule
+ \section2 \c classesbymodule
- When this argument is used, a second argument is required, which
- specifies the module whose classes are to be listed. QDoc
- generates a table containing those classes. Each class is listed
- with the text of its \l{brief-command} {\\brief} command.
+ When this argument is used, a second argument is required, which
+ specifies the module whose classes are to be listed. QDoc
+ generates a table containing those classes. Each class is listed
+ with the text of its \l{brief-command} {\\brief} command.
- This command is used to generate the \l {phonon-module.html}
- {Phonon Module} page this way.
+ This command is used to generate the \l {phonon-module.html}
+ {Phonon Module} page this way.
- \code
- / *!
- \page phonon-module.html
- \module Phonon
- \title Phonon Module
- \ingroup modules
+ \code
+ / *!
+ \page phonon-module.html
+ \module Phonon
+ \title Phonon Module
+ \ingroup modules
- \brief The Phonon module contains namespaces and classes for multimedia functionality.
+ \brief The Phonon module contains namespaces and classes for multimedia functionality.
- \generatelist{classesbymodule Phonon}
+ \generatelist{classesbymodule Phonon}
- ...
+ ...
- * /
- \endcode
+ * /
+ \endcode
- Each class that is a member of the specified module must be
- marked with the \l {inmodule-command} {\\inmodule} command in
- its \\class comment.
+ Each class that is a member of the specified module must be marked
+ with the \l {inmodule-command} {\\inmodule} command in its \\class
+ comment.
- \section2 \c compatclasses
+ \section2 \c compatclasses
- The \c compatclasses argument generates a list in alphabetical
- order of the support classes. It is normally used only to
- generate the \l {compatclasses.html} {Qt3 Support Classes} page
- this way:
+ The \c compatclasses argument generates a list in alphabetical
+ order of the support classes. It is normally used only to
+ generate the \l {compatclasses.html} {Qt3 Support Classes} page
+ this way:
- \code
- / *!
- \page compatclasses.html
- \title Qt3 Support Classes
- \ingroup classlists
+ \code
+ / *!
+ \page compatclasses.html
+ \title Qt3 Support Classes
+ \ingroup classlists
- \brief These classes ease the porting of code from Qt 3 to Qt 4.
+ \brief These classes ease the porting of code from Qt 3 to Qt 4.
- These are the classes that Qt provides for compatibility with Qt
- 3. Most of these are provided by the Qt3Support module.
+ These are the classes that Qt provides for compatibility with Qt
+ 3. Most of these are provided by the Qt3Support module.
- \generatelist compatclasses
- * /
- \endcode
+ \generatelist compatclasses
+ * /
+ \endcode
- A support class is identified in the \\class comment with the \l
- {compat-command} {\\compat} command.
+ A support class is identified in the \\class comment with the \l
+ {compat-command} {\\compat} command.
- \section2 \c functionindex
+ \section2 \c functionindex
- The \c functionindex argument provides a complete alphabetical
- list of all the documented member functions. It is normally used
- only to generate the \l {functions.html} {Qt function index}
- page this way:
+ The \c functionindex argument provides a complete alphabetical
+ list of all the documented member functions. It is normally used
+ only to generate the \l {functions.html} {Qt function index} page
+ this way:
- \code
- / *!
- \page functions.html
- \title All Functions
- \ingroup funclists
+ \code
+ / *!
+ \page functions.html
+ \title All Functions
+ \ingroup funclists
- \brief All documented Qt functions listed alphabetically with a
- link to where each one is declared.
+ \brief All documented Qt functions listed alphabetically with a
+ link to where each one is declared.
- This is the list of all documented member functions and global
- functions in the Qt API. Each function has a link to the class or
- header file where it is declared and documented.
+ This is the list of all documented member functions and global
+ functions in the Qt API. Each function has a link to the
+ class or header file where it is declared and documented.
- \generatelist functionindex
- * /
- \endcode
+ \generatelist functionindex
+ * /
+ \endcode
\section2 \c legalese
--
cgit v0.12
From 9a811800ed08ac9744f625d57a7dd9227b77a9f8 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 21 Feb 2011 13:18:42 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 207 +++++++++++++--------------------------
1 file changed, 67 insertions(+), 140 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 908eeb9..4ea9fb5 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -3579,163 +3579,90 @@
* /
\endcode
- \section2 \c legalese
-
- The \c legalese argument provides a complete list of all
- the licenses. The licenses are identified within the
- documentation using the \l {legalese-command} {\\legalese}
- command.
-
- For example:
-
- \quotation
- \raw HTML
- <hr />
- <p>
- Copyright (c) 1989 The Regents of the
- University of California. All rights reserved.
- </p>
-
- <p>
- Redistribution and use in source and binary
- forms are permitted provided that the above
- copyright notice and this paragraph are
- duplicated in all such forms and that any
- documentation, advertising materials, and other
- materials related to such distribution and use
- acknowledge that the software was developed by
- the University of California, Berkeley...
- </p>
-
- <ul>
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qdate.html#weekNumber">QDate::weekNumber()</a>
- </li>
- </ul>
-
- <hr />
- <p>
- Copyright (c) 1991 by AT&T.
- </p>
-
- <p>
- Permission to use, copy, modify, and distribute
- this software for any purpose without fee is
- hereby granted, provided that this entire notice
- is included in all copies of any software which
- is or includes a copy or modification of this
- software and in all copies of the supporting
- documentation for such software...
- </p>
-
- <ul>
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qlocale.html">QLocale</a>
- </li>
- </ul>
- <hr />
- \endraw
- ...
- \endquotation
-
- \section2 \c mainclasses
-
- The \c mainclasses argument provides a complete
- alphabetical list of the main classes. Each class name
- is a link to the class's reference documentation. A
- class is related to the group of main classes by using
- the \l {mainclass-command} {\\mainclass} command.
-
- The list is rendered similarily to the list generated by
- the \l {list example} {\c classes} argument.
+ \section2 \c legalese
- \section2 \c overviews
+ The \c legalese argument tells QDoc to generate a complete list of
+ licenses in the documentation. Each license is identified using
+ the \l {legalese-command} {\\legalese} command. This command is
+ used to generate the \l {licenses.html} {Qt license information}
+ page this way:
- The \c overviews argument provides a complete
- alphabetical overview of the documentation. Each list
- entry is a link to the respective documentation page.
-
- The list includes pages declared using commands like \l
- {page-command} {\\page} and \l {group-command}
- {\\group}. The list omits examples and classes, and only
- lists the first page of documentation that contains two
- or more pages using commands like \l {nextpage-command}
- {\\nextpage}.
-
- For example:
+ \code
+ / *!
+ \page licenses.html
+ \title Other Licenses Used in Qt
+ \ingroup licensing
+ \brief Information about other licenses used for Qt components and third-party code.
+
+ Qt contains some code that is not provided under the
+ \l{GNU General Public License (GPL)},
+ \l{GNU Lesser General Public License (LGPL)} or the
+ \l{Qt Commercial Edition}{Qt Commercial License Agreement}, but rather under
+ specific licenses from the original authors. Some pieces of code were developed
+ by Nokia and others originated from third parties.
+ This page lists the licenses used, names the authors, and links
+ to the places where it is used.
+
+ Nokia gratefully acknowledges these and other contributions
+ to Qt. We recommend that programs that use Qt also acknowledge
+ these contributions, and quote these license statements in an
+ appendix to the documentation.
+
+ See also: \l{Licenses for Fonts Used in Qt for Embedded Linux}
+
+ \generatelist legalese
+ * /
+ \endcode
- \quotation
- \raw HTML
- <ul>
+ \section2 \c mainclasses
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qtalgorithms.html">
- <QtAlgorithms> - Generic Algorithms
- </a>
- </li>
+ The \c mainclasses argument tells QDoc to generate an alphabetical
+ list of the main classes. A class is marked as a main class by
+ including a \l {mainclass-command} {\\mainclass} command in the
+ \\class comment.
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qtglobal.html">
- <QtGlobal> - Global Qt Declarations
- </a>
- </li>
+ \note The Qt documentation no longer includes a main classes page,
+ but you can generate one for your main classes if you want it.
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qaxserver-demo-simple.html">
- A standard ActiveX and the "simple" ActiveQt widget
- </a>
- </li>
+ \section2 \c overviews
- <li>
- <a href="http://qt.nokia.com/doc/4.0/aboutqt.html">
- About Qt
- </a>
- </li>
+ The \c overviews argument is used to tell QDoc to generate a list
+ by concatenating the contents of all the \l {group-command}
+ {\\group} pages. Qt uses it to generate the \l {overviews.html}
+ {overviews} page this way:
- <li>
- <a href="http://qt.nokia.com/doc/4.0/trolltech.html">
- About Trolltech
- </a>
- </li>
+ \code
+ / *!
+ \page overviews.html
- <li>
- <a href="http://qt.nokia.com/doc/4.0/abstractwidgets.html">
- Abstract Widget Classes
- </a>
- </li>
+ \title All Overviews and HOWTOs
- <li>
- <a href="http://qt.nokia.com/doc/4.0/accessibility.html">
- Accessibility Classes
- </a>
- </li>
- ...
- </ul>
- \endraw
- \endquotation
+ \generatelist overviews
+ * /
+ \endcode
- \section2 \c related
+ \section2 \c related
- The \c related argument is used in combination with the
- \l {group-command} {\\group} command to list all the overviews
- related to the given group. Each list entry is a link to
- the respective documentation page.
+ The \c related argument is used in combination with the \l
+ {group-command} {\\group} command to list all the overviews
+ related to the given group. Each list entry is a link to the
+ respective documentation page.
- \section2 \c relatedinline
+ \section2 \c relatedinline
- The \c related argument is used in combination with the
- \l {group-command} {\\group} command to collect all documentation
- related to the given group. The various documentation
- snippets are copied directly into the group page.
+ The \c related argument is used in combination with the \l
+ {group-command} {\\group} command to collect all documentation
+ related to the given group. The various documentation snippets are
+ copied directly into the group page.
- \section2 \c service
+ \section2 \c service
- The \c service argument provides a complete alphabetical
- list of the services. Each service name is a link to the
- service's reference documentation.
+ The \c service argument provides a complete alphabetical list of
+ the services. Each service name is a link to the service's
+ reference documentation.
- A service is identified within the documentation by the
- \l {service-command} {\\service} command.
+ A service is identified within the documentation by the \l
+ {service-command} {\\service} command.
\target if-command
--
cgit v0.12
From 009f57dd22694ee7d599e0aeb3ae2282be843f74 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Mon, 21 Feb 2011 14:04:32 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 201 ++++++++++++++++++++-------------------
1 file changed, 101 insertions(+), 100 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 4ea9fb5..a81d15a 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -3644,26 +3644,45 @@
\section2 \c related
The \c related argument is used in combination with the \l
- {group-command} {\\group} command to list all the overviews
- related to the given group. Each list entry is a link to the
- respective documentation page.
+ {group-command} {\\group} and \l {ingroup-command} {\\ingroup}
+ commands to list all the overviews related to a specified
+ group. For example, the page for the \l {Programming with Qt}
+ {Programming with Qt} page is generated this way:
- \section2 \c relatedinline
+ \code
+ / *!
+ \group qt-basic-concepts
+ \title Programming with Qt
- The \c related argument is used in combination with the \l
- {group-command} {\\group} command to collect all documentation
- related to the given group. The various documentation snippets are
- copied directly into the group page.
+ \brief The basic architecture of the Qt cross-platform application and UI framework.
+
+ Qt is a cross-platform application and UI framework for
+ writing web-enabled applications for desktop, mobile, and
+ embedded operating systems. This page contains links to
+ articles and overviews explaining key components and
+ techniuqes used in Qt development.
+
+ \generatelist {related}
+ * /
+ \endcode
+
+ Each page listed on this group page contains the command:
+
+ \code
+ \ingroup qt-basic-concepts
+ \endcode
\section2 \c service
- The \c service argument provides a complete alphabetical list of
- the services. Each service name is a link to the service's
+ The \c service argument tells QDoc to generate an alphabetical
+ list of the services. Each service name is a link to the service's
reference documentation.
- A service is identified within the documentation by the \l
- {service-command} {\\service} command.
+ A service is identified with the \l {service-command} {\\service}
+ command.
+ \note This command and the \l {service-command} {\\service}
+ command are not used in the Qt documentation.
\target if-command
\section1 \\if
@@ -3672,8 +3691,8 @@
enclose parts of a QDoc comment that only will be included if
the condition specified by the command's argument is true.
- The command reads the rest of the line and parses it as an
- C++ #if statement. For example:
+ The command reads the rest of the line and parses it as an C++ #if
+ statement. For example:
\code
/ *!
@@ -3687,24 +3706,22 @@
* /
\endcode
- This QDoc comment will only be rendered if the \c
- opensourceedition preprocessor symbol is defined, and
- specified in the \l {defines-variable} {defines} variable in
- the configuration file to make QDoc process
- the code within #ifdef and #endif:
+ This QDoc comment will only be rendered if the \c
+ opensourceedition preprocessor symbol is defined, and specified in
+ the \l {defines-variable} {defines} variable in the configuration
+ file to make QDoc process the code within #ifdef and #endif:
\code
defines = opensourceedition
\endcode
- You can also define the preprocessor symbol manually on the
- command line. For more information see the documentation of
- the \l {defines-variable} {defines} variable.
-
- See also \l{endif-command} {\\endif}, \l{else-command}
- {\\else}, \l {defines-variable} {defines} and \l
- {falsehoods-variable} {falsehoods}.
+ You can also define the preprocessor symbol manually on the
+ command line. For more information see the documentation of the \l
+ {defines-variable} {defines} variable.
+ See also \l{endif-command} {\\endif}, \l{else-command} {\\else},
+ \l {defines-variable} {defines} and \l {falsehoods-variable}
+ {falsehoods}.
\target endif-command
\section1 \\endif
@@ -3714,13 +3731,12 @@
the condition specified by the \l {if-command} {\\if} command's
argument is true.
- For more information, see the documentation of the \l
- {if-command} {\\if} command.
-
- See also \l{if-command} {\\if}, \l{else-command} {\\else},
- \l {defines-variable} {defines} and \l
- {falsehoods-variable} {falsehoods}.
+ For more information, see the documentation of the \l {if-command}
+ {\\if} command.
+ See also \l{if-command} {\\if}, \l{else-command} {\\else}, \l
+ {defines-variable} {defines} and \l {falsehoods-variable}
+ {falsehoods}.
\target else-command
\section1 \\else
@@ -3728,9 +3744,9 @@
The \\else command specifies an alternative if the
condition in the \l {if-command} {\\if} command is false.
- The \\else command can only be used within \l
- {if-command} {\\if...\\endif} commands, but is useful when there is
- only two alternatives. For example:
+ The \\else command can only be used within \l {if-command}
+ {\\if...\\endif} commands, but is useful when there is only two
+ alternatives. For example:
\code
/ *!
@@ -3765,8 +3781,8 @@
* /
\endcode
- If the \c QT3_SUPPORT is defined, the comment will be rendered
- as
+ If the \c QT3_SUPPORT is defined, the comment will be rendered
+ like this:
\quotation
The Qt 3 support library is provided to keep old source
@@ -3777,8 +3793,8 @@
API to cohabit with the new one.
\endquotation
- If \c QT3_SUPPORT isn't defined but \c QT3_SUPPORT_WARNINGS
- is, the comment QDoc renders this as:
+ If \c QT3_SUPPORT is not defined but \c QT3_SUPPORT_WARNINGS is
+ defined, the comment will be rendered like this:
\quotation
The Qt 3 support library is provided to keep old source
@@ -3821,31 +3837,27 @@
{defines-variable} {defines} and \l {falsehoods-variable}
{falsehoods}.
-
\target include-command
\section1 \\include
The \\include command expands to the contents of the
file specified by the command's argument.
- \warning This is preliminary functionality. For more
- information, see the \l
- {26-qdoc-commands-compatibility.html#include-versus-input}
- {compatibility} section.
-
- The command takes a file name as an argument, and is
- useful when some piece of the documentation is used
- repeatedly: Move the repetetive text into a separate file,
- and use the \\include command whenever you want to insert
- the separate documentation.
+ \warning This is preliminary functionality. For more information,
+ see the \l
+ {26-qdoc-commands-compatibility.html#include-versus-input}
+ {compatibility} section.
- The contents of such a file should follow QDoc syntax,
- excluding the enclosing \c{/}\c{*!} ... \c{*}\c{/} marks.
- To ensure that QDoc won't attempt to read the file as a
- stand-alone piece of documentation, we recommend that you
- use the \c .qdocinc extension.
+ The command takes a file name as an argument, and is useful when
+ some piece of the documentation is used repeatedly: Move the
+ repetetive text into a separate file, and use the \\include
+ command whenever you want to insert the separate documentation.
- For example:
+ The contents of such a file should follow QDoc syntax, excluding
+ the enclosing \c{/}\c{*!} ... \c{*}\c{/} marks. To ensure that
+ QDoc won't attempt to read the file as a stand-alone piece of
+ documentation, we recommend that you use the \c .qdocinc
+ extension. For example:
\code
/ *!
@@ -3858,7 +3870,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3870,10 +3882,8 @@
\input examples/layoutmanagement.qdocinc
\endquotation
- Here is the actual \c .qdocinc files: \l
- signalandslots.qdocinc, \l objectmodel.qdocinc, \l
- layoutmanagement.qdocinc
-
+ Here is the actual \c .qdocinc files: \l signalandslots.qdocinc,
+ \l objectmodel.qdocinc, \l layoutmanagement.qdocinc
\target meta-command
\section1 \\meta
@@ -3881,12 +3891,10 @@
The \\meta command is the QDoc equivalent to the HTML
\c meta tag.
- The command accepts two arguments: The first argument (the
- following word) is equivalent to the HTML meta tag's \e
- name variable, and the second argument (the rest of the
- line) is equivalent to the tag's \e contents variable.
-
- For example:
+ The command accepts two arguments: The first argument (the
+ following word) is equivalent to the HTML meta tag's \e name
+ variable, and the second argument (the rest of the line) is
+ equivalent to the tag's \e contents variable. For example:
\code
/ *!
@@ -3910,7 +3918,7 @@
* /
\endcode
- will be included in the generated HTML page as
+ QDoc renders this as:
\code
<head>
@@ -3920,15 +3928,12 @@
</head>
\endcode
-
\target omit-command
\section1 \\omit
- The \\omit command and the correspondning \\endomit
- command delimit parts of the documentation that
- you want QDoc to skip.
-
- For example:
+ The \\omit command and the correspondning \\endomit command
+ delimit parts of the documentation that you want QDoc to skip. For
+ example:
\code
/ *!
@@ -3952,7 +3957,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -3971,26 +3976,24 @@
</table>
\endraw
-
-
\target raw-command
\section1 \\raw \span {class="newStuff"} {(avoid)}
The \\raw command and the corresponding
\\endraw command delimit a block of raw mark-up language code.
- \note Avoid using this command if possible, because it generates
- DITA XML code that causes problems. If you are trying to generate
- special table or list behavior, try to get the behavior you want
- using the \l {span-command} {\\span} and \l {div-command} {\\div}
- commands in your \l {table-command} {\\table} or \l {list-command}
- {\\list}.
+ \note Avoid using this command if possible, because it generates
+ DITA XML code that causes problems. If you are trying to generate
+ special table or list behavior, try to get the behavior you want
+ using the \l {span-command} {\\span} and \l {div-command} {\\div}
+ commands in your \l {table-command} {\\table} or \l {list-command}
+ {\\list}.
- The command takes an argument specifying the code's format;
- currently the only supported format is HTML.
+ The command takes an argument specifying the code's format;
+ currently the only supported format is HTML.
- The \\raw command is useful if you want some special HTML
- effects in your documentation. For example:
+ The \\raw command is useful if you want some special HTML effects
+ in your documentation. For example:
\code
/ *!
@@ -4012,7 +4015,7 @@
* /
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
Qt has some predefined QColor objects. For example:
@@ -4032,9 +4035,9 @@
\endraw
\endquotation
- \note But you can achieve the exact same thing using qdoc
- commands. In this case, all you have to do is include the
- color styles in your style.css file. Then you can write:
+ \note But you can achieve the exact same thing using qdoc
+ commands. In this case, all you have to do is include the color
+ styles in your style.css file. Then you can write:
\code
\tt {\span {id="color-blue"} {Blue(#0000ff)}},
@@ -4048,17 +4051,16 @@
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
-
\target unicode-command
\section1 \\unicode
- The \\unicode command allows you to insert an
- arbitrary Unicode character in the document.
+ The \\unicode command allows you to insert an arbitrary Unicode
+ character in the document.
- The command takes an argument specifying the character as
- an integer. By default, base 10 is assumed, unless a '0x'
- or '0' prefix is specified (for base 16 and 8,
- respectively). For example:
+ The command takes an argument specifying the character as an
+ integer. By default, base 10 is assumed, unless a '0x' or '0'
+ prefix is specified (for base 16 and 8, respectively). For
+ example:
\code
O G\unicode{0xEA}nio e as Rosas
@@ -4068,7 +4070,7 @@
\unicode 0x3A3 \e{a}\sub{\e{i}}
\endcode
- QDoc renders this as:
+ QDoc renders this as:
\quotation
O G\unicode{0xEA}nio e as Rosas
@@ -4077,7 +4079,6 @@
\unicode 0x3A3 \e{a}\sub{\e{i}}
\endquotation
-
*/
/*!
--
cgit v0.12
From 733e0df1a79ff2856395d343c7dd46061b00faef Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 10:17:15 +0100
Subject: qdoc: More updating command descriptions.
---
doc/src/overviews.qdoc | 2 +-
tools/qdoc3/doc/qdoc-manual.qdoc | 346 +++++++++++++++++++--------------------
2 files changed, 170 insertions(+), 178 deletions(-)
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index b9bd3b4..e5d2aac 100644
--- a/doc/src/overviews.qdoc
+++ b/doc/src/overviews.qdoc
@@ -62,7 +62,7 @@
/*!
\group qt-graphics
- \ingroup qt-basic-concepts
+ \ingroup qt-basic-concepts
\title Qt Graphics and Printing
\brief The Qt components for doing graphics.
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index a81d15a..69151ca 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4184,225 +4184,220 @@
\target class-command
\section1 \\class
- The \\class command tells QDoc that a class is
- part of the public API, and lets you enter a detailed
+ The \\class command is for documenting a C++ class. The argument
+ is the complete name of the class. The command tells QDoc that a
+ class is part of the public API, and lets you enter a detailed
description.
- The command follows \l {topic argument} {the general
- topic command convention} for the argument, and supports
- nested classes, for example:
+ \code
+ / *!
+ \class QMap::iterator
- \code
- / *!
- \class QMap::iterator
+ \brief The QMap::iterator class provides an STL-style
+ non-const iterator for QMap and QMultiMap.
- \brief The QMap::iterator class provides an STL-style
- non-const iterator for QMap and QMultiMap.
+ QMap features both \l{STL-style iterators} and
+ \l{Java-style iterators}. The STL-style iterators ...
+ * /
+ \endcode
- QMap features both \l{STL-style iterators} and
- \l{Java-style iterators}. The STL-style iterators ...
- * /
- \endcode
+ The HTML documentation for the named class is written to a
+ \c{.html} file named from the class name, in lower case, and with
+ the double colon qulifier(s) replaced with '-'. For example, the
+ documentation for the \c QMap::Iterator class is written to \c
+ qmap-iterator.html.
- The generated HTML documentation for the specified class is
- put in \c <lower-case>classname.html. For example, the
- documentation for the \c PreviewWindow class is located in
- \c previewwindow.html.
+ \target framework
- \target framework
+ The file contains the class description from the \\class comment,
+ plus the documentation generated from QDoc comments for all the
+ class members, i.e. a list of the class's types, properties,
+ functions, signals, and slots.
- In addition to render the detailed description, the \\class
- comand will generate the documentation framework, i.e. a
- list of the class's types, properties, functions, signals
- and slots with empty documentation.
+ In addition to the detailed description of the class, the \\class
+ comment typically contains a \l {brief-command} {\\brief} command
+ and one or more \l{Markup Commands}. See the \\class command for
+ any of the Qt class for examples. Here is a very simple example:
- The command is typically accompanied with a \l
- {brief-command} {\\brief} command, a \l {mainclass-command} {\\mainclass}
- command, an \l {ingroup-command} {\\ingroup} command and a \l
- {sa-command} {\\sa} command. For example:
+ \code
+ / *!
+ \class PreviewWindow
+ \brief The PreviewWindow class is a custom widget
+ displaying the names of its currently set
+ window flags in a read-only text editor.
- \code
- / *!
- \class PreviewWindow
- \brief The PreviewWindow class is a custom widget
- displaying the names of its currently set
- window flags in a read-only text editor.
+ \ingroup miscellaneous
- \mainclass
- \ingroup miscellaneous
+ The PreviewWindow class inherits QWidget. The widget
+ displays the names of its window flags set with the \l
+ {function} {setWindowFlags()} function. It is also
+ provided with a QPushButton that closes the window.
- The PreviewWindow class inherits QWidget. The widget
- displays the names of its window flags set with the \l
- {function} {setWindowFlags()} function. It is also
- provided with a QPushButton that closes the window.
-
- ...
-
- \sa QWidget
- * /
- \endcode
+ ...
- QDoc renders this as:
+ \sa QWidget
+ * /
+ \endcode
- \quotation
- \raw HTML
- <h1>PreviewWindow Class Reference</h1>
- \endraw
+ The way QDoc renders this \\class will depend a lot on your \c
+ {style.css} file, but the general outline of the class reference
+ page will look like this:
- The PreviewWindow class is a custom widget displaying
- the names of its currently set window flags in a
- read-only text editor. \l {preview window} {More...}
+ \quotation
+ \raw HTML
+ <h1>PreviewWindow Class Reference</h1>
+ \endraw
- \raw HTML
- <h3>Properties</h3>
- \endraw
+ The PreviewWindow class is a custom widget displaying
+ the names of its currently set window flags in a
+ read-only text editor. \l {preview window} {More...}
- \list
- \o 52 properties inherited from QWidget
- \o 1 property inherited from QObject
- \endlist
+ \raw HTML
+ <h3>Properties</h3>
+ \endraw
- \raw HTML
- <h3>Public Functions</h3>
- \endraw
+ \list
+ \o 52 properties inherited from QWidget
+ \o 1 property inherited from QObject
+ \endlist
- \list
- \o \l {constructor} {PreviewWindow}(QWidget *parent = 0)
- \o void \l {function} {setWindowFlags}(Qt::WindowFlags flags)
- \endlist
+ \raw HTML
+ <h3>Public Functions</h3>
+ \endraw
- \list
- \o 183 public functions inherited from QWidget
- \o 28 public functions inherited from QObject
- \endlist
+ \list
+ \o \l {constructor} {PreviewWindow}(QWidget *parent = 0)
+ \o void \l {function} {setWindowFlags}(Qt::WindowFlags flags)
+ \endlist
- \raw HTML
- <h3>Public Slots</h3>
- \endraw
+ \list
+ \o 183 public functions inherited from QWidget
+ \o 28 public functions inherited from QObject
+ \endlist
- \list
- \o 17 public slots inherited from QWidget
- \o 1 public slot inherited from QObject
- \endlist
+ \raw HTML
+ <h3>Public Slots</h3>
+ \endraw
- \raw HTML
- <h3>Additional Inherited Members</h3>
- \endraw
+ \list
+ \o 17 public slots inherited from QWidget
+ \o 1 public slot inherited from QObject
+ \endlist
- \list
- \o 1 signal inherited from QWidget
- \o 1 signal inherited from QObject
- \o 4 static public members inherited from QWidget
- \o 4 static public members inherited from QObject
- \o 39 protected functions inherited from QWidget
- \o 7 protected functions inherited from QObject
- \endlist
+ \raw HTML
+ <h3>Additional Inherited Members</h3>
+ \endraw
- \target preview window
+ \list
+ \o 1 signal inherited from QWidget
+ \o 1 signal inherited from QObject
+ \o 4 static public members inherited from QWidget
+ \o 4 static public members inherited from QObject
+ \o 39 protected functions inherited from QWidget
+ \o 7 protected functions inherited from QObject
+ \endlist
- \raw HTML
- <hr />
- <h2>Detailed Description</h2>
- \endraw
+ \target preview window
- The PreviewWindow class is a custom widget displaying
- the names of its currently set window flags in a
- read-only text editor.
+ \raw HTML
+ <hr />
+ <h2>Detailed Description</h2>
+ \endraw
- The PreviewWindow class inherits QWidget. The widget
- displays the names of its window flags set with the \l
- {function} {setWindowFlags()} function. It is also
- provided with a QPushButton that closes the window.
+ The PreviewWindow class is a custom widget displaying
+ the names of its currently set window flags in a
+ read-only text editor.
- ...
+ The PreviewWindow class inherits QWidget. The widget
+ displays the names of its window flags set with the \l
+ {function} {setWindowFlags()} function. It is also
+ provided with a QPushButton that closes the window.
- See also QWidget.
+ ...
- \raw HTML
- <hr />
- <h2>Member Function Documentation</h2>
- \endraw
+ See also QWidget.
- \target constructor
- \raw HTML
- <h3>PreviewWindow(QWidget *parent = 0)</h3>
- \endraw
+ \raw HTML
+ <hr />
+ <h2>Member Function Documentation</h2>
+ \endraw
- Constructs a preview window widget with \e parent.
+ \target constructor
+ \raw HTML
+ <h3>PreviewWindow(QWidget *parent = 0)</h3>
+ \endraw
- \target function
- \raw HTML
- <h3>setWindowFlags(Qt::WindowFlags flags)</h3>
- \endraw
+ Constructs a preview window widget with \e parent.
- Sets the widgets flags using the
- QWidget::setWindowFlags() function.
+ \target function
+ \raw HTML
+ <h3>setWindowFlags(Qt::WindowFlags flags)</h3>
+ \endraw
- Then runs through the available window flags,
- creating a text that contains the names of the flags
- that matches the flags parameter, displaying
- the text in the widgets text editor.
- \endquotation
+ Sets the widgets flags using the
+ QWidget::setWindowFlags() function.
+ Then runs through the available window flags,
+ creating a text that contains the names of the flags
+ that matches the flags parameter, displaying
+ the text in the widgets text editor.
+ \endquotation
\target enum-command
\section1 \\enum
- The \\enum command allows you to document a C++ enum.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- The enum items are documented using the \l {value-command} {\\value}
- command. If an item isn't documented, QDoc will emit a
- warning. This can be avoided using the \l
- {omitvalue-command} {\\omitvalue} command excluding an item from the
- documentation. The enum documentation will be located in
- the associated class, header file or namespace
- documentation.
+ The \\enum command is for documenting a C++ enum type. The
+ argument is the full name of the enum type.
- For example:
+ The enum values are documented in the \\enum comment using the \l
+ {value-command} {\\value} command. If an enum value is not
+ documented with \\value, QDoc emits a warning. These warnings can
+ be avoided using the \l {omitvalue-command} {\\omitvalue} command
+ to tell QDoc that an enum value should not be documented. The enum
+ documentation will be included on the class reference page, header
+ file page, or namespace page where the enum type is defined. For
+ example, consider the enum type \c {Corner} in the Qt namespace:
- \code
- enum Corner {
- TopLeftCorner = 0x00000,
- TopRightCorner = 0x00001,
- BottomLeftCorner = 0x00002,
- BottomRightCorner = 0x00003
- #if defined(QT3_SUPPORT) && !defined(Q_MOC_RUN)
- ,TopLeft = TopLeftCorner,
- TopRight = TopRightCorner,
- BottomLeft = BottomLeftCorner,
- BottomRight = BottomRightCorner
- #endif
- };
- \endcode
+ \code
+ enum Corner {
+ TopLeftCorner = 0x00000,
+ TopRightCorner = 0x00001,
+ BottomLeftCorner = 0x00002,
+ BottomRightCorner = 0x00003
+ #if defined(QT3_SUPPORT) && !defined(Q_MOC_RUN)
+ ,TopLeft = TopLeftCorner,
+ TopRight = TopRightCorner,
+ BottomLeft = BottomLeftCorner,
+ BottomRight = BottomRightCorner
+ #endif
+ };
+ \endcode
- In case of the Qt::Corner enum,
+ This enum can be cocumented this way:
- \code
- / *!
- \enum Qt::Corner
-
- This enum type specifies a corner in a rectangle:
-
- \value TopLeftCorner
- The top-left corner of the rectangle.
- \value TopRightCorner
- The top-right corner of the rectangle.
- \value BottomLeftCorner
- The bottom-left corner of the rectangle.
- \value BottomRightCorner
- The bottom-right corner of the rectangle.
-
- \omitvalue TopLeft
- \omitvalue TopRight
- \omitvalue BottomLeft
- \omitvalue BottomRight
- * /
- \endcode
+ \code
+ / *!
+ \enum Qt::Corner
+
+ This enum type specifies a corner in a rectangle:
+
+ \value TopLeftCorner
+ The top-left corner of the rectangle.
+ \value TopRightCorner
+ The top-right corner of the rectangle.
+ \value BottomLeftCorner
+ The bottom-left corner of the rectangle.
+ \value BottomRightCorner
+ The bottom-right corner of the rectangle.
+
+ \omitvalue TopLeft
+ \omitvalue TopRight
+ \omitvalue BottomLeft
+ \omitvalue BottomRight
+ * /
+ \endcode
- this associated QDoc comment QDoc renders this as:
+ QDoc renders this enum type in \c {qt.html} something like this:
\quotation
\raw HTML
@@ -4445,10 +4440,7 @@
\endraw
\endquotation
- in qt.html.
-
- See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
-
+ See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
\target example-command
\section1 \\example
--
cgit v0.12
From d94188fa8ce1dc67c3c9d6155baf78a2b6ac65a4 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 10:44:13 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 158 ++++++++++++++++++---------------------
1 file changed, 72 insertions(+), 86 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 69151ca..9729944 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4397,7 +4397,8 @@
* /
\endcode
- QDoc renders this enum type in \c {qt.html} something like this:
+ Note the inclusion of the namespace qualifier. QDoc will render
+ this enum type in \c {qt.html} something like this:
\quotation
\raw HTML
@@ -4445,109 +4446,94 @@
\target example-command
\section1 \\example
- The \\example command allows you to document an example.
+ The \\example command is for documenting an example. The argument
+ is the example's path relative to omne of the paths listed in the
+ \l {exampledirs-variable} {exampledirs} variable in the QDoc
+ configuration file.
- The command follows \l {topic argument} {the general
- topic command convention} for the argument. In particular
- the command's argument is the example's path relative to
- the paths listed in the \l {exampledirs-variable}
- {exampledirs} configuration variable.
-
- The documentation will be located in \e
- {path-to-example}.html, and QDoc will add a list of all the
- example files at the top of this documentation page.
+ The documentation page will be output to \c {path-to-example}.html.
+ QDoc will add a list of all the example's source files at the top
+ of the page.
- For example, if \l {exampledirs-variable} {exampledirs}
- contains \c $QTDIR/examples/widgets/imageviewer, then
+ For example, if \l {exampledirs-variable} {exampledirs} contains
+ \c $QTDIR/examples/widgets/imageviewer, then
- \code
- / *!
- \example widgets/imageviewer
- \title ImageViewer Example
- \subtitle
-
- The example shows how to combine QLabel and QScrollArea
- to display an image.
-
- ...
- * /
- \endcode
+ \code
+ / *!
+ \example widgets/imageviewer
+ \title ImageViewer Example
+ \subtitle
- QDoc renders this as:
+ The example shows how to combine QLabel and QScrollArea
+ to display an image.
- \quotation
- \raw HTML
- <center><h1>Image Viewer Example</h1></center>
- \endraw
+ ...
+ * /
+ \endcode
- Files:
- \list
- \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-imageviewer-cpp.html}
- {widgets/imageviewer/imageviewer.cpp}
- \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-imageviewer-h.html}
- {widgets/imageviewer/imageviewer.h}
- \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-main-cpp.html}
- {widgets/imageviewer/main.cpp}
- \endlist
+ QDoc renders this example in widgets-imageviewer.html:
- The example shows how to combine QLabel and QScrollArea
- to display an image.
+ \quotation
+ \raw HTML
+ <center><h1>Image Viewer Example</h1></center>
+ \endraw
- ...
- \endquotation
+ Files:
+ \list
+ \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-imageviewer-cpp.html}
+ {widgets/imageviewer/imageviewer.cpp}
+ \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-imageviewer-h.html}
+ {widgets/imageviewer/imageviewer.h}
+ \o \l{http://qt.nokia.com/doc/4.0/widgets-imageviewer-main-cpp.html}
+ {widgets/imageviewer/main.cpp}
+ \endlist
- in widgets-imageviewer.html.
+ The example shows how to combine QLabel and QScrollArea
+ to display an image.
+ ...
+ \endquotation
\target fn-command
- \section1 \\fn
-
- The \\fn command allows you to document a function.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument. In particular
- it is important that the return type of the function,
- whether it is \c const or not and the complete set of
- arguments with type are included in the argument. If the
- referenced function doesn't exist, QDoc will emit a
- warning.
-
- Also, the \\fn command is QDoc's default command, i.e. when
- no topic command can be found within a QDoc comment, QDoc
- tries to tie the documentation to the following code as if
- it was function documentation.
-
- This means that the command normally isn't necessary since
- the recommended style is to write the function
- documentation directly before the function implementation
- in the \c .cpp file. In fact, it should only be used for
- inline functions implemented in the \c .h file.
-
- For example:
+ \section1 \\fn (function)
+
+ The \\fn command is for documenting a function. The argument is
+ the function's signature, including its return type, const-ness,
+ and list of formal arguments with types. If the named function
+ doesn't exist, QDoc emits a warning.
+
+ \note The \\fn command is QDoc's default command, i.e. when no
+ topic command can be found in a QDoc comment, QDoc tries to tie
+ the documentation to the following code as if it is the
+ documentation for a function. Hence, it is normally not necessary
+ to include this command when documenting a function, if the
+ function's QDoc comment is written immediately above the function
+ implementation in the \c .cpp file. But it must be present when
+ documenting an inline function in the \c .cpp file that is
+ implemented in the \c .h file. For example:
- \code
- / *!
- \fn bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
-
- Returns true if this toolbar is dockable in the given
- \a area; otherwise returns false.
- * /
- \endcode
+ \code
+ / *!
+ \fn bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
- QDoc renders this as:
+ Returns true if this toolbar is dockable in the given
+ \a area; otherwise returns false.
+ * /
+ \endcode
- \quotation
- \raw HTML
- <h3>bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
- </h3>
- \endraw
+ QDoc renders this as:
- Returns true if this toolbar is dockable in the given
- \a area; otherwise returns false.
- \endquotation
+ \quotation
+ \raw HTML
+ <h3>bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
+ </h3>
+ \endraw
- See also \l {overload-command} {\\overload}.
+ Returns true if this toolbar is dockable in the given
+ \a area; otherwise returns false.
+ \endquotation
+ See also \l {overload-command} {\\overload}.
\target group-command
\section1 \\group
--
cgit v0.12
From d89d932c08b2841253b66e2c140807de824185eb Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 11:53:12 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 160 +++++++++++++++++++--------------------
1 file changed, 77 insertions(+), 83 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 9729944..f1aa8c4 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4538,103 +4538,97 @@
\target group-command
\section1 \\group
- The \\group command creates a separate page that
- lists the classes belonging to the group specified by the
- command's argument.
+ The \\group command creates a separate page that lists the classes
+ belonging to the group. The argument is the group name.
- The command follows \l {topic argument} {the general
- topic command convention} for the argument. The \\group
- command is typically followed by a \l {title-command} {\\title}
- command and a short introduction to the group. The
- generated HTML documentation for the specified group is put
- in <lower-case>\e{group}.html.
-
- A class can be related to a group by using the \l
- {ingroup-command} {\\ingroup} command. In addition, overviews can be
- related to a group using the same command, but these must
- be listed explicitly using the \l
- {generatelist-command} {\\generatelist} command (see example below).
-
- Each class is listed with a link to the class reference
- page and a brief description based on the classes' \l
- {brief-command} {\\brief} texts. For example:
-
- \code
- / *!
- \group io
+ A class is included in a group by using the \l {ingroup-command}
+ {\\ingroup} command. Overview pages can also be related to a group
+ using the same command, but the list of overview pages must be
+ requested explicitly using the \l {generatelist-command}
+ {\\generatelist} command (see example below).
- \title Input/Output and Networking
+ The \\group command is typically followed by a \l {title-command}
+ {\\title} command and a short introduction to the group. The
+ HTML page for the group is written to a \c {.html} file put in
+ <lower-case>\e{group}.html.
- These classes are used to handle input and output to
- and from external devices, processes, files etc. as
- well as manipulating files and directories.
- * /
- \endcode
+ Each class name is listed as a link to the class reference page
+ followed by the text from the class's \l {brief-command} {\\brief}
+ texts. For example:
- QDoc renders this as:
+ \code
+ / *!
+ \group io
- \quotation
- \raw HTML
+ \title Input/Output and Networking
- <h1>Input/Output and Networking</h1>
-
- <p>These classes are used to handle input and output
- to and from external devices, processes, files etc. as
- well as manipulating files and directories.</p>
-
- <p>
- <table width="100%">
- <tr valign="top" bgcolor="#e0e0e0">
- <td><b>
- <a href="http://qt.nokia.com/doc/4.0/qabstractsocket.html">QAbstractSocket</a>
- </b></td>
- <td>
- The base functionality common to all socket types
- </td></tr>
-
- <tr valign="top" bgcolor="#e0e0e0">
- <td><b>
- <a href="http://qt.nokia.com/doc/4.0/qbuffer.html">QBuffer</a>
- </b></td>
- <td>
- QIODevice interface for a QByteArray
- </td></tr>
-
- <tr valign="top" bgcolor="#e0e0e0">
- <td><b>
- <a href="http://qt.nokia.com/doc/4.0/qclipboard.html">QClipboard</a>
- </b></td>
- <td>
- Access to the window system clipboard
- </td></tr>
- </table>
- \endraw
- \endquotation
+ These classes are used to handle input and output to
+ and from external devices, processes, files etc. as
+ well as manipulating files and directories.
+ * /
+ \endcode
- in io.html.
+ QDoc generates a group page in \c{io.html} that will look
+ something like this:
- Note that overviews related to the given group, must be
- listed explicitly using the \l
- {generatelist-command} {\\generatelist} command with the \c related
- argument. For example:
+ \quotation
+ \raw HTML
+
+ <h1>Input/Output and Networking</h1>
+
+ <p>These classes are used to handle input and output
+ to and from external devices, processes, files etc. as
+ well as manipulating files and directories.</p>
+
+ <p>
+ <table width="100%">
+ <tr valign="top" bgcolor="#e0e0e0">
+ <td><b>
+ <a href="http://qt.nokia.com/doc/4.0/qabstractsocket.html">QAbstractSocket</a>
+ </b></td>
+ <td>
+ The base functionality common to all socket types
+ </td></tr>
+
+ <tr valign="top" bgcolor="#e0e0e0">
+ <td><b>
+ <a href="http://qt.nokia.com/doc/4.0/qbuffer.html">QBuffer</a>
+ </b></td>
+ <td>
+ QIODevice interface for a QByteArray
+ </td></tr>
+
+ <tr valign="top" bgcolor="#e0e0e0">
+ <td><b>
+ <a href="http://qt.nokia.com/doc/4.0/qclipboard.html">QClipboard</a>
+ </b></td>
+ <td>
+ Access to the window system clipboard
+ </td></tr>
+ </table>
+ \endraw
+ \endquotation
- \code
- / *!
- \group architecture
+ Note that overview pages related to the group, must be listed
+ explicitly using the \l {generatelist-command} {\\generatelist}
+ command with the \c related argument. For example:
- \title Architecture
+ \code
+ / *!
+ \group architecture
- These documents describe aspects of Qt's architecture
- and design, including overviews of core Qt features and
- technologies.
+ \title Architecture
- \generatelist{related}
- * /
- \endcode
+ These documents describe aspects of Qt's architecture
+ and design, including overviews of core Qt features and
+ technologies.
- See also \l {ingroup-command} {\\ingroup} and \l
- {generatelist-command} {\\generatelist}.
+ \generatelist{related}
+ * /
+ \endcode
+ See also \l {ingroup-command} {\\ingroup} and \l
+ {generatelist-command} {\\generatelist}.
\target headerfile-command
\section1 \\headerfile
--
cgit v0.12
From f0eadbc92d06706fee765796408a9bfca077e0d2 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 12:12:57 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 35 +++++++++++++++--------------------
1 file changed, 15 insertions(+), 20 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index f1aa8c4..d6acc29 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4633,22 +4633,19 @@
\target headerfile-command
\section1 \\headerfile
- The \\headerfile command allows you to document
- global functions, types and macros declared in a header file.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument, and the
- generated HTML documentation for the specified header file
- is put in <lower-case>\e{headerfilename}.html.
-
- A function, type or macro can be associated with a
- headerfile using the \l {relates-command} {\\relates} command.
-
- If the referenced header file doesn't exist, the
- \\headerfile command will still create a documentation page
- for a header file with the referenced file's name.
-
- For example:
+ The \\headerfile command is for documenting the global functions,
+ types and macros that are declared in a header file but not in a
+ namespace. The argument is the name of the header file. The HTML
+ page is written to a \c {.html} file constructed from the header
+ file aregument.
+
+ The documentation for a function, type, or macro that is declared
+ in the header file being documented is included in the header file
+ page using the \l {relates-command} {\\relates} command.
+
+ If the argument doesn't exist as a header file, the \\headerfile
+ command creates a documentation page for the header file anyway.
+ For example:
\code
/ *!
@@ -4665,7 +4662,8 @@
* /
\endcode
- QDoc renders this as:
+ QDoc generates a header file page \c{qtalgorithms.html} that looks
+ something like this:
\quotation
\raw HTML
@@ -4701,9 +4699,6 @@
...
\endquotation
- in qtalgorithms.html.
-
-
\target macro-command
\section1 \\macro
--
cgit v0.12
From 9c93c18d8b5eb2df5fa8feb1bc4d076071501e68 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 12:24:29 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 160 +++++++++++++++++----------------------
1 file changed, 71 insertions(+), 89 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index d6acc29..db2a976 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4702,120 +4702,102 @@
\target macro-command
\section1 \\macro
- The \\macro command allows you to document a C++ macro.
+ The \\macro command is for documententin a C++ macro. The argument
+ is the macro in one of three styles: function-like macros like
+ Q_ASSERT(), declaration-style macros like Q_PROPERTY(), and macros
+ without parentheses like Q_OBJECT.
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- QDoc recognizes three different macro syntax: function-like
- macros like Q_ASSERT(), declaration-style macros like
- Q_PROPERTY() and macros without parentheses like Q_OBJECT.
-
- The \\macro command must be followed by a \l
- {relates-command} {\\relates} command which attaches the
- documentation to that of a related class, header file. or
- namespace. Otherwise the documentation will be lost.
-
- For example:
-
- \code
- / *!
- \macro void Q_ASSERT(bool test)
- \relates <QtGlobal>
-
- Prints a warning message containing the source code
- file name and line number if \a test is false.
+ The \\macro comment must contain a \l {relates-command}
+ {\\relates} command that attaches the macro comment to a class,
+ header file, or namespace. Otherwise, the documentation will be
+ lost. Here are three example macro comments followed by what they
+ might look like in \c {qtglobal.html} or \c {qobject.html}:
- ...
-
- \sa Q_ASSERT_X(), qFatal(), {Debugging Techniques}
- * /
- \endcode
-
- QDoc renders this as:
-
- \quotation
- \raw HTML
- <h3>void Q_ASSERT ( bool <i>test</i> )</h3>
- \endraw
-
- Prints a warning message containing the source code
- file name and line number if \a test is false.
-
- ...
+ \code
+ / *!
+ \macro void Q_ASSERT(bool test)
+ \relates <QtGlobal>
- See also Q_ASSERT_X(), qFatal() and \l {Debugging
- Techniques}.
- \endquotation
+ Prints a warning message containing the source code
+ file name and line number if \a test is false.
- in qtglobal.html. And
+ ...
- \code
- / *!
- \macro Q_PROPERTY(...)
- \relates QObject
+ \sa Q_ASSERT_X(), qFatal(), {Debugging Techniques}
+ * /
+ \endcode
- This macro declares a QObject property. The syntax is:
+ \quotation
+ \raw HTML
+ <h3>void Q_ASSERT ( bool <i>test</i> )</h3>
+ \endraw
- ...
+ Prints a warning message containing the source code
+ file name and line number if \a test is false.
- \sa {Qt's Property System}
- * /
- \endcode
+ ...
- QDoc renders this as:
+ See also Q_ASSERT_X(), qFatal() and \l {Debugging Techniques}.
+
+ \endquotation
- \quotation
- \raw HTML
- <h3>Q_PROPERTY ( ... )</h3>
- \endraw
+ \code
+ / *!
+ \macro Q_PROPERTY(...)
+ \relates QObject
- This macro declares a QObject property. The syntax is:
+ This macro declares a QObject property. The syntax is:
- ...
+ ...
- See also \l {Qt's Property System}.
- \endquotation
+ \sa {Qt's Property System}
+ * /
+ \endcode
- in qobject.html. And
+ \quotation
+ \raw HTML
+ <h3>Q_PROPERTY ( ... )</h3>
+ \endraw
- \code
- / *!
- \macro Q_OBJECT
- \relates QObject
+ This macro declares a QObject property. The syntax is:
- The Q_OBJECT macro must appear in the private section
- of a class definition that declares its own signals and
- slots or that uses other services provided by Qt's
- meta-object system.
+ ...
- ...
+ See also \l {Qt's Property System}.
+ \endquotation
- \sa {Meta-Object System}, {Signals and Slots}, {Qt's
- Property System}
- * /
- \endcode
+ \code
+ / *!
+ \macro Q_OBJECT
+ \relates QObject
- QDoc renders this as:
+ The Q_OBJECT macro must appear in the private section
+ of a class definition that declares its own signals and
+ slots or that uses other services provided by Qt's
+ meta-object system.
- \quotation
- \raw HTML
- <h3>Q_OBJECT</h3>
- \endraw
+ ...
- The Q_OBJECT macro must appear in the private section
- of a class definition that declares its own signals and
- slots or that uses other services provided by Qt's
- meta-object system.
+ \sa {Meta-Object System}, {Signals and Slots}, {Qt's
+ Property System}
+ * /
+ \endcode
- ...
+ \quotation
+ \raw HTML
+ <h3>Q_OBJECT</h3>
+ \endraw
- See also \l {Meta-Object System}, \l {Signals &
- Slots} and \l {Qt's Property System}.
- \endquotation
+ The Q_OBJECT macro must appear in the private section
+ of a class definition that declares its own signals and
+ slots or that uses other services provided by Qt's
+ meta-object system.
- in qobject.html.
+ ...
+ See also \l {Meta-Object System}, \l {Signals &
+ Slots} and \l {Qt's Property System}.
+ \endquotation
\target module-command
\section1 \\module
--
cgit v0.12
From 276ae3c231a80b5cf64ae431e9386ac63d48a278 Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Tue, 22 Feb 2011 14:44:52 +0100
Subject: qdoc: More updating command descriptions.
---
tools/qdoc3/doc/qdoc-manual.qdoc | 191 ++++++++++++++++-----------------------
1 file changed, 80 insertions(+), 111 deletions(-)
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index db2a976..5945aea 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4802,43 +4802,36 @@
\target module-command
\section1 \\module
- The \\module creates a separate page that lists the
- classes belonging to the module specified by the command's
- argument.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- A class can be related to a module using the \l
- {inmodule-command} {\\inmodule} command.
-
- The \\module command is typically followed by the \l
- {title-command} {\\title} and \l {brief-command} {\\brief}
- commands. Each class is listed with a link to the class
- reference page and a brief description based on the
- classes' \l {brief-command} {\\brief} texts.
-
- For example:
+ The \\module creates a page that lists the classes belonging to
+ the module specified by the command's argument. A class included
+ in the module by including the \l {inmodule-command} {\\inmodule}
+ command in the \\class comment.
+
+ The \\module command is typically followed by a \l {title-command}
+ {\\title} and a \l {brief-command} {\\brief} command. Each class
+ is listed as a link to the class reference page followed by the
+ text from the class's \l {brief-command} {\\brief} command. For
+ example:
- \code
- / *!
- \module QtNetwork
+ \code
+ / *!
+ \module QtNetwork
- \title QtNetwork Module
+ \title QtNetwork Module
- \brief The QtNetwork module offers classes that allow
- you to write TCP/IP clients and servers.
+ \brief The QtNetwork module offers classes that allow
+ you to write TCP/IP clients and servers.
- The network module provides classes to make network
- programming easier and portable. It offers both
- high-level classes such as QHttp and QFtp that
- implement specific application-level protocols, and
- lower-level classes such as QTcpSocket, QTcpServer, and
- QUdpSocket.
- * /
- \endcode
+ The network module provides classes to make network
+ programming easier and portable. It offers both
+ high-level classes such as QHttp and QFtp that
+ implement specific application-level protocols, and
+ lower-level classes such as QTcpSocket, QTcpServer, and
+ QUdpSocket.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this in \c {qtnetwork.html} something like this:
\quotation
\raw HTML
@@ -4901,37 +4894,26 @@
\endquotation
- in qtnetwork.html.
-
- See also \l {inmodule-command} {\\inmodule}
-
+ See also \l {inmodule-command} {\\inmodule}
\target namespace-command
\section1 \\namespace
- The \\namespace command allows you to document a C++ namespace.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
+ The \\namespace command is for documenting the contents of the C++
+ namespace named as its argument. The documentation outline QDoc
+ generates for a namespace is similar to the outline it generates
+ for a C++ class. For example:
- QDoc will generate the same additional links and
- documentation for all the members of the namespace as it
- does for \l {framework} {classes}. The documentation for
- the specified namespace is put in <lower-case>\e
- {namespace}.html.
-
- For example:
-
- \code
- / *!
- \namespace Qt
+ \code
+ / *!
+ \namespace Qt
- \brief The Qt namespace contains miscellaneous
- identifiers used throughout the Qt library.
- * /
- \endcode
+ \brief The Qt namespace contains miscellaneous
+ identifiers used throughout the Qt library.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this in \c{qt.html} something like this:
\quotation
\raw HTML
@@ -4968,19 +4950,13 @@
...
\endquotation
- in qt.html.
-
-
\target page-command
\section1 \\page
- The \\page command allows you to create a stand-alone documentation page.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- The page's title can be set using the \l {title-command} {\\title}
- command. For example:
+ The \\page command is for creating a stand-alone documentation
+ page. The argument is the name of the file where QDoc should
+ store the page. The page title is set using the \l {title-command}
+ {\\title} command. For example:
\code
/ *!
@@ -5005,63 +4981,56 @@
* /
\endcode
- will be rendered in its own HTML file: \l{About Qt}.
-
+ QDoc renders this page in \c {aboutqt.html}.
\target externalpage-command
\section1 \\externalpage
- The \\externalpage command gives a title to an external URL.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- For example:
-
- \code
- / *!
- \externalpage http://www.trolltech.com/products/embedded/index.html
- \title Qtopia Core
- * /
- \endcode
+ The \\externalpage command assigns a title to an external URL.
+ For example:
- The QDoc comment above allows you to link to the Qtopia
- Core webpage by simply linking to the given title. For
- example:
+ \code
+ / *!
+ \externalpage http://doc.trolltech.com/4.3/qtopiacore.html
+ \title Qtopia Core
+ * /
+ \endcode
- \code
- / *!
- The broad scope of the \l {Qtopia Core} API enables it to
- be used across a wide variety of development projects.
- * /
- \endcode
+ This allows you to include a link to the external page in your
+ documentation this way:
- QDoc renders this as:
+ \code
+ / *!
+ The broad scope of the \l {Qtopia Core} API enables it to
+ be used across a wide variety of development projects.
+ * /
+ \endcode
- \quotation
- The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html} {Qtopia
- Core} API enables it to be used across a wide variety
- of development projects.
- \endquotation
+ QDoc renders this as:
- To achieve the same result without using the
- \\externalpage command, you would have to hard code the
- adress into your documentation:
+ \quotation
+ The broad scope of the \l
+ {http://doc.trolltech.com/4.3/qtopiacore.html} {Qtopia
+ Core} API enables it to be used across a wide variety
+ of development projects.
+ \endquotation
- \code
- / *!
- The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html} {Qtopia
- Core} API enables it to be used across a wide variety
- of development projects.
- * /
- \endcode
+ To achieve the same result without using the \\externalpage
+ command, you would have to hard code the adress into your
+ documentation:
- The \\externalpage command makes it easier to maintain the
- documentation. If the adress changes, you only need to change the
- argument of the \\externalpage command.
+ \code
+ / *!
+ The broad scope of the \l
+ {http://doc.trolltech.com/4.3/qtopiacore.html} {Qtopia
+ Core} API enables it to be used across a wide variety
+ of development projects.
+ * /
+ \endcode
+ The \\externalpage command makes it easier to maintain the
+ documentation. If the adress changes, you only need to change the
+ argument of the \\externalpage command.
\target property-command
\section1 \\property
--
cgit v0.12