summaryrefslogtreecommitdiffstats
path: root/src/gui/text
diff options
context:
space:
mode:
authorGunnar Sletta <gunnar.sletta@nokia.com>2012-06-13 21:45:44 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-28 06:21:46 +0200
commit50eed2d068138e30d508f8b230cfaaeb116e659c (patch)
tree766786bdcbfd024376f3b1c5594150b20e30d438 /src/gui/text
parent894e9ce66dcb85b9af4e5bded492fda33c59c435 (diff)
Get started with patching up the Qt GUI docs
Primary goal, make the front page of the Qt GUI module a bit more clarifying and avoid downstream references inside the Qt GUI docs. Change-Id: Icbcfbb64b93963add889bf83711daa9575885c02 Reviewed-by: Samuel Rødal <samuel.rodal@nokia.com>
Diffstat (limited to 'src/gui/text')
-rw-r--r--src/gui/text/qabstracttextdocumentlayout.cpp4
-rw-r--r--src/gui/text/qfont.cpp2
-rw-r--r--src/gui/text/qfontdatabase.cpp1
-rw-r--r--src/gui/text/qfontmetrics.cpp2
-rw-r--r--src/gui/text/qglyphrun.cpp1
-rw-r--r--src/gui/text/qplatformfontdatabase_qpa.cpp1
-rw-r--r--src/gui/text/qrawfont.cpp1
-rw-r--r--src/gui/text/qstatictext.cpp1
-rw-r--r--src/gui/text/qsyntaxhighlighter.cpp1
-rw-r--r--src/gui/text/qtextcursor.cpp1
-rw-r--r--src/gui/text/qtextdocument.cpp1
-rw-r--r--src/gui/text/qtextdocumentfragment.cpp1
-rw-r--r--src/gui/text/qtextdocumentwriter.cpp1
-rw-r--r--src/gui/text/qtextformat.cpp9
-rw-r--r--src/gui/text/qtextlayout.cpp4
-rw-r--r--src/gui/text/qtextlist.cpp1
-rw-r--r--src/gui/text/qtextobject.cpp8
-rw-r--r--src/gui/text/qtextoption.cpp2
-rw-r--r--src/gui/text/qtexttable.cpp2
19 files changed, 44 insertions, 0 deletions
diff --git a/src/gui/text/qabstracttextdocumentlayout.cpp b/src/gui/text/qabstracttextdocumentlayout.cpp
index 45903f678c..9c523f15e1 100644
--- a/src/gui/text/qabstracttextdocumentlayout.cpp
+++ b/src/gui/text/qabstracttextdocumentlayout.cpp
@@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE
\brief The QAbstractTextDocumentLayout class is an abstract base
class used to implement custom layouts for QTextDocuments.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -80,6 +81,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextObjectInterface class allows drawing of
custom text objects in \l{QTextDocument}s.
\since 4.5
+ \inmodule QtGui
A text object describes the structure of one or more elements in a
text document; for instance, images imported from HTML are
@@ -289,6 +291,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QAbstractTextDocumentLayout::PaintContext
\reentrant
+ \inmodule QtGui
\brief The QAbstractTextDocumentLayout::PaintContext class is a convenience
class defining the parameters used when painting a document's layout.
@@ -353,6 +356,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QAbstractTextDocumentLayout::Selection
\reentrant
+ \inmodule QtGui
\brief The QAbstractTextDocumentLayout::Selection class is a convenience
class defining the parameters of a selection.
diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp
index 7b2288cbc6..2144930f70 100644
--- a/src/gui/text/qfont.cpp
+++ b/src/gui/text/qfont.cpp
@@ -344,6 +344,7 @@ QFontEngineData::~QFontEngineData()
\ingroup appearance
\ingroup shared
\ingroup richtext-processing
+ \inmodule QtGui
When you create a QFont object you specify various attributes that
@@ -2208,6 +2209,7 @@ QDataStream &operator>>(QDataStream &s, QFont &font)
\reentrant
\brief The QFontInfo class provides general information about fonts.
+ \inmodule QtGui
\ingroup appearance
\ingroup shared
diff --git a/src/gui/text/qfontdatabase.cpp b/src/gui/text/qfontdatabase.cpp
index 4b8a18d491..1d4eaa5576 100644
--- a/src/gui/text/qfontdatabase.cpp
+++ b/src/gui/text/qfontdatabase.cpp
@@ -1157,6 +1157,7 @@ QString QFontDatabase::styleString(const QFontInfo &fontInfo)
/*!
\class QFontDatabase
\threadsafe
+ \inmodule QtGui
\brief The QFontDatabase class provides information about the fonts available in the underlying window system.
diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp
index e5ddcb80d5..22b9038524 100644
--- a/src/gui/text/qfontmetrics.cpp
+++ b/src/gui/text/qfontmetrics.cpp
@@ -65,6 +65,7 @@ extern void qt_format_text(const QFont& font, const QRectF &_r,
/*!
\class QFontMetrics
\reentrant
+ \inmodule QtGui
\brief The QFontMetrics class provides font metrics information.
@@ -937,6 +938,7 @@ int QFontMetrics::lineWidth() const
/*!
\class QFontMetricsF
\reentrant
+ \inmodule QtGui
\brief The QFontMetricsF class provides font metrics information.
diff --git a/src/gui/text/qglyphrun.cpp b/src/gui/text/qglyphrun.cpp
index 673dd8f03b..c298893002 100644
--- a/src/gui/text/qglyphrun.cpp
+++ b/src/gui/text/qglyphrun.cpp
@@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE
\class QGlyphRun
\brief The QGlyphRun class provides direct access to the internal glyphs in a font.
\since 4.8
+ \inmodule QtGui
\ingroup text
\mainclass
diff --git a/src/gui/text/qplatformfontdatabase_qpa.cpp b/src/gui/text/qplatformfontdatabase_qpa.cpp
index 3531202eff..7e2b890483 100644
--- a/src/gui/text/qplatformfontdatabase_qpa.cpp
+++ b/src/gui/text/qplatformfontdatabase_qpa.cpp
@@ -226,6 +226,7 @@ bool QSupportedWritingSystems::supported(QFontDatabase::WritingSystem writingSys
\brief The QSupportedWritingSystems class is used when registering fonts with the internal Qt
fontdatabase
\ingroup painting
+ \inmodule QtGui
Its to provide an easy to use interface for indicating what writing systems a specific font
supports.
diff --git a/src/gui/text/qrawfont.cpp b/src/gui/text/qrawfont.cpp
index ae14f1c798..468ab4e8cb 100644
--- a/src/gui/text/qrawfont.cpp
+++ b/src/gui/text/qrawfont.cpp
@@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE
\class QRawFont
\brief The QRawFont class provides access to a single physical instance of a font.
\since 4.8
+ \inmodule QtGui
\ingroup text
\mainclass
diff --git a/src/gui/text/qstatictext.cpp b/src/gui/text/qstatictext.cpp
index faee6d2b76..534ba8345e 100644
--- a/src/gui/text/qstatictext.cpp
+++ b/src/gui/text/qstatictext.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
\brief The QStaticText class enables optimized drawing of text when the text and its layout
is updated rarely.
\since 4.7
+ \inmodule QtGui
\ingroup multimedia
\ingroup text
diff --git a/src/gui/text/qsyntaxhighlighter.cpp b/src/gui/text/qsyntaxhighlighter.cpp
index c372071019..f76bb51ce1 100644
--- a/src/gui/text/qsyntaxhighlighter.cpp
+++ b/src/gui/text/qsyntaxhighlighter.cpp
@@ -230,6 +230,7 @@ void QSyntaxHighlighterPrivate::reformatBlock(const QTextBlock &block)
/*!
\class QSyntaxHighlighter
\reentrant
+ \inmodule QtGui
\brief The QSyntaxHighlighter class allows you to define syntax
highlighting rules, and in addition you can use the class to query
diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp
index 048f1a5ca0..1beff17e8d 100644
--- a/src/gui/text/qtextcursor.cpp
+++ b/src/gui/text/qtextcursor.cpp
@@ -880,6 +880,7 @@ QTextLayout *QTextCursorPrivate::blockLayout(QTextBlock &block) const{
/*!
\class QTextCursor
\reentrant
+ \inmodule QtGui
\brief The QTextCursor class offers an API to access and modify QTextDocuments.
diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp
index 0c5194e9c6..5961ad1e8c 100644
--- a/src/gui/text/qtextdocument.cpp
+++ b/src/gui/text/qtextdocument.cpp
@@ -217,6 +217,7 @@ QTextCodec *Qt::codecForHtml(const QByteArray &ba)
/*!
\class QTextDocument
\reentrant
+ \inmodule QtGui
\brief The QTextDocument class holds formatted text that can be
viewed and edited using a QTextEdit.
diff --git a/src/gui/text/qtextdocumentfragment.cpp b/src/gui/text/qtextdocumentfragment.cpp
index d1147339f6..dab269331c 100644
--- a/src/gui/text/qtextdocumentfragment.cpp
+++ b/src/gui/text/qtextdocumentfragment.cpp
@@ -255,6 +255,7 @@ void QTextDocumentFragmentPrivate::insert(QTextCursor &_cursor) const
\class QTextDocumentFragment
\reentrant
+ \inmodule QtGui
\brief The QTextDocumentFragment class represents a piece of formatted text
from a QTextDocument.
diff --git a/src/gui/text/qtextdocumentwriter.cpp b/src/gui/text/qtextdocumentwriter.cpp
index 2894c280e8..5795a72ce7 100644
--- a/src/gui/text/qtextdocumentwriter.cpp
+++ b/src/gui/text/qtextdocumentwriter.cpp
@@ -75,6 +75,7 @@ public:
\class QTextDocumentWriter
\brief The QTextDocumentWriter class provides a format-independent interface for writing a QTextDocument to files or other devices.
+ \inmodule QtGui
\ingroup richtext-processing
\ingroup io
diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp
index a7f9de04d8..d8c7a4c52f 100644
--- a/src/gui/text/qtextformat.cpp
+++ b/src/gui/text/qtextformat.cpp
@@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextLength class encapsulates the different types of length
used in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -465,6 +466,7 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt)
\brief The QTextFormat class provides formatting information for a
QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
\ingroup shared
@@ -1256,6 +1258,7 @@ bool QTextFormat::operator==(const QTextFormat &rhs) const
\brief The QTextCharFormat class provides formatting information for
characters in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -1894,6 +1897,7 @@ QFont QTextCharFormat::font() const
\brief The QTextBlockFormat class provides formatting information for
blocks of text in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -2256,6 +2260,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
\brief The QTextListFormat class provides formatting information for
lists in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -2416,6 +2421,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
\brief The QTextFrameFormat class provides formatting information for
frames in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -2742,6 +2748,7 @@ qreal QTextFrameFormat::rightMargin() const
\brief The QTextTableFormat class provides formatting information for
tables in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -2948,6 +2955,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
\brief The QTextImageFormat class provides formatting information for
images in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -3259,6 +3267,7 @@ QTextTableCellFormat::QTextTableCellFormat(const QTextFormat &fmt)
\brief The QTextTableCellFormat class provides formatting information for
table cells in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
diff --git a/src/gui/text/qtextlayout.cpp b/src/gui/text/qtextlayout.cpp
index fb495dc821..b8be991fa1 100644
--- a/src/gui/text/qtextlayout.cpp
+++ b/src/gui/text/qtextlayout.cpp
@@ -74,6 +74,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextLayout::FormatRange structure is used to apply extra formatting information
for a specified area in the text layout's content.
+ \inmodule QtGui
\sa QTextLayout::setAdditionalFormats(), QTextLayout::draw()
*/
@@ -99,6 +100,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextInlineObject class represents an inline object in
a QTextLayout.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -254,6 +256,7 @@ Qt::LayoutDirection QTextInlineObject::textDirection() const
\reentrant
\brief The QTextLayout class is used to lay out and render text.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -1317,6 +1320,7 @@ void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition
\reentrant
\brief The QTextLine class represents a line of text inside a QTextLayout.
+ \inmodule QtGui
\ingroup richtext-processing
diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp
index cce442c4d7..dd1aa545b7 100644
--- a/src/gui/text/qtextlist.cpp
+++ b/src/gui/text/qtextlist.cpp
@@ -62,6 +62,7 @@ public:
\reentrant
\brief The QTextList class provides a decorated list of items in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
diff --git a/src/gui/text/qtextobject.cpp b/src/gui/text/qtextobject.cpp
index af98642abd..5643233994 100644
--- a/src/gui/text/qtextobject.cpp
+++ b/src/gui/text/qtextobject.cpp
@@ -60,6 +60,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextObject class is a base class for different kinds
of objects that can group parts of a QTextDocument together.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -182,6 +183,7 @@ QTextDocumentPrivate *QTextObject::docHandle() const
\brief The QTextBlockGroup class provides a container for text blocks within
a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -304,6 +306,7 @@ QTextFrameLayoutData::~QTextFrameLayoutData()
\reentrant
\brief The QTextFrame class represents a frame in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -599,6 +602,7 @@ void QTextFramePrivate::remove_me()
\brief The iterator class provides an iterator for reading
the contents of a QTextFrame.
+ \inmodule QtGui
\ingroup richtext-processing
A frame consists of an arbitrary sequence of \l{QTextBlock}s and
@@ -798,6 +802,7 @@ QTextFrame::iterator &QTextFrame::iterator::operator--()
\reentrant
\brief The QTextBlockUserData class is used to associate custom data with blocks of text.
+ \inmodule QtGui
\since 4.1
\ingroup richtext-processing
@@ -829,6 +834,7 @@ QTextBlockUserData::~QTextBlockUserData()
\brief The QTextBlock class provides a container for text fragments in a
QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -929,6 +935,7 @@ bool QTextBlock::isValid() const
\brief The QTextBlock::iterator class provides an iterator for reading
the contents of a QTextBlock.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -1577,6 +1584,7 @@ QTextBlock::iterator &QTextBlock::iterator::operator--()
\brief The QTextFragment class holds a piece of text in a
QTextDocument with a single QTextCharFormat.
+ \inmodule QtGui
\ingroup richtext-processing
diff --git a/src/gui/text/qtextoption.cpp b/src/gui/text/qtextoption.cpp
index 25760de0dc..377e33efd7 100644
--- a/src/gui/text/qtextoption.cpp
+++ b/src/gui/text/qtextoption.cpp
@@ -205,6 +205,7 @@ QList<QTextOption::Tab> QTextOption::tabs() const
\brief The QTextOption class provides a description of general rich text
properties.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -359,6 +360,7 @@ QList<QTextOption::Tab> QTextOption::tabs() const
/*!
\class QTextOption::Tab
\since 4.4
+ \inmodule QtGui
Each tab definition is represented by this struct.
*/
diff --git a/src/gui/text/qtexttable.cpp b/src/gui/text/qtexttable.cpp
index 5589ffeb71..61b62eba0a 100644
--- a/src/gui/text/qtexttable.cpp
+++ b/src/gui/text/qtexttable.cpp
@@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\brief The QTextTableCell class represents the properties of a
cell in a QTextTable.
+ \inmodule QtGui
\ingroup richtext-processing
@@ -498,6 +499,7 @@ void QTextTablePrivate::update() const
\reentrant
\brief The QTextTable class represents a table in a QTextDocument.
+ \inmodule QtGui
\ingroup richtext-processing