summaryrefslogtreecommitdiffstats
path: root/src/gui/text
diff options
context:
space:
mode:
authorMarius Storm-Olsen <marius.storm-olsen@nokia.com>2012-05-10 13:10:23 +0200
committerQt by Nokia <qt-info@nokia.com>2012-05-11 01:42:02 +0200
commitad97aba452ed7d3dbd3c9d437c59c14b2ae0661b (patch)
tree2a37426bc8e29f27d3b3a486693b484b2caa069c /src/gui/text
parent87d21127de4a361c7e76ba91a0ea336bbed32853 (diff)
Doc: Fix \sa usage
Ensure comma between elements (757 missing), single space and curly- braces around title elements, etc. Change-Id: Id16c3fda7fc47a12a0682f8720214f4990609a97 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/gui/text')
-rw-r--r--src/gui/text/qfont.cpp52
-rw-r--r--src/gui/text/qfontmetrics.cpp2
-rw-r--r--src/gui/text/qtextcursor.cpp30
-rw-r--r--src/gui/text/qtextdocument.cpp4
-rw-r--r--src/gui/text/qtextdocumentfragment.cpp2
-rw-r--r--src/gui/text/qtextformat.cpp92
-rw-r--r--src/gui/text/qtextlist.cpp2
-rw-r--r--src/gui/text/qtextobject.cpp34
-rw-r--r--src/gui/text/qtexttable.cpp18
9 files changed, 122 insertions, 114 deletions
diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp
index f64b3e823d..753fe5670f 100644
--- a/src/gui/text/qfont.cpp
+++ b/src/gui/text/qfont.cpp
@@ -607,7 +607,7 @@ QFontEngineData::~QFontEngineData()
Returns the family name that corresponds to the current style
hint.
- \sa StyleHint styleHint() setStyleHint()
+ \sa StyleHint, styleHint(), setStyleHint()
*/
/*!
@@ -629,7 +629,7 @@ QFontEngineData::~QFontEngineData()
happens. Please \link bughowto.html report it as a bug\endlink if
it does, preferably with a list of the fonts you have installed.
- \sa lastResortFamily() rawName()
+ \sa lastResortFamily(), rawName()
*/
/*!
@@ -702,7 +702,7 @@ QFont::QFont()
algorithm.
\sa Weight, setFamily(), setPointSize(), setWeight(), setItalic(),
- setStyleHint() QGuiApplication::font()
+ setStyleHint(), QGuiApplication::font()
*/
QFont::QFont(const QString &family, int pointSize, int weight, bool italic)
: d(new QFontPrivate()), resolve_mask(QFont::FamilyResolved)
@@ -758,7 +758,7 @@ QFont &QFont::operator=(const QFont &font)
Returns the requested font family name, i.e. the name set in the
constructor or the last setFont() call.
- \sa setFamily() substitutes() substitute()
+ \sa setFamily(), substitutes(), substitute()
*/
QString QFont::family() const
{
@@ -796,7 +796,7 @@ void QFont::setFamily(const QString &family)
Mac OS X and X11 so far. On Windows irregular styles will be added
as separate font families so there is no need for this.
- \sa setFamily() setStyle()
+ \sa setFamily(), setStyle()
*/
QString QFont::styleName() const
{
@@ -823,7 +823,7 @@ void QFont::setStyleName(const QString &styleName)
Returns the point size of the font. Returns -1 if the font size
was specified in pixels.
- \sa setPointSize() pointSizeF()
+ \sa setPointSize(), pointSizeF()
*/
int QFont::pointSize() const
{
@@ -933,7 +933,7 @@ QFont::HintingPreference QFont::hintingPreference() const
Sets the point size to \a pointSize. The point size must be
greater than zero.
- \sa pointSize() setPointSizeF()
+ \sa pointSize(), setPointSizeF()
*/
void QFont::setPointSize(int pointSize)
{
@@ -955,7 +955,7 @@ void QFont::setPointSize(int pointSize)
greater than zero. The requested precision may not be achieved on
all platforms.
- \sa pointSizeF() setPointSize() setPixelSize()
+ \sa pointSizeF(), setPointSize(), setPixelSize()
*/
void QFont::setPointSizeF(qreal pointSize)
{
@@ -976,7 +976,7 @@ void QFont::setPointSizeF(qreal pointSize)
Returns the point size of the font. Returns -1 if the font size was
specified in pixels.
- \sa pointSize() setPointSizeF() pixelSize() QFontInfo::pointSize() QFontInfo::pixelSize()
+ \sa pointSize(), setPointSizeF(), pixelSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()
*/
qreal QFont::pointSizeF() const
{
@@ -1012,7 +1012,7 @@ void QFont::setPixelSize(int pixelSize)
setPixelSize(). Returns -1 if the size was set with setPointSize()
or setPointSizeF().
- \sa setPixelSize() pointSize() QFontInfo::pointSize() QFontInfo::pixelSize()
+ \sa setPixelSize(), pointSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()
*/
int QFont::pixelSize() const
{
@@ -1024,7 +1024,7 @@ int QFont::pixelSize() const
Returns true if the style() of the font is not QFont::StyleNormal
- \sa setItalic() style()
+ \sa setItalic(), style()
*/
/*!
@@ -1033,7 +1033,7 @@ int QFont::pixelSize() const
Sets the style() of the font to QFont::StyleItalic if \a enable is true;
otherwise the style is set to QFont::StyleNormal.
- \sa italic() QFontInfo
+ \sa italic(), QFontInfo
*/
/*!
@@ -1254,7 +1254,7 @@ void QFont::setKerning(bool enable)
The style strategy affects the \l{QFont}{font matching} algorithm.
See \l QFont::StyleStrategy for the list of available strategies.
- \sa setStyleHint() QFont::StyleHint
+ \sa setStyleHint(), QFont::StyleHint
*/
QFont::StyleStrategy QFont::styleStrategy() const
{
@@ -1267,7 +1267,7 @@ QFont::StyleStrategy QFont::styleStrategy() const
The style hint affects the \l{QFont}{font matching} algorithm.
See \l QFont::StyleHint for the list of available hints.
- \sa setStyleHint(), QFont::StyleStrategy QFontInfo::styleHint()
+ \sa setStyleHint(), QFont::StyleStrategy, QFontInfo::styleHint()
*/
QFont::StyleHint QFont::styleHint() const
{
@@ -1407,7 +1407,7 @@ void QFont::setStyleStrategy(StyleStrategy s)
\value ExtraExpanded 150
\value UltraExpanded 200
- \sa setStretch() stretch()
+ \sa setStretch(), stretch()
*/
/*!
@@ -1436,7 +1436,7 @@ int QFont::stretch() const
X11, the stretch factor is matched against a predefined set of
values for the SETWIDTH_NAME field of the XLFD.
- \sa stretch() QFont::Stretch
+ \sa stretch(), QFont::Stretch
*/
void QFont::setStretch(int factor)
{
@@ -1647,7 +1647,7 @@ bool QFont::exactMatch() const
equal. If rawMode() is enabled for both fonts, only the family
fields are compared.
- \sa operator!=() isCopyOf()
+ \sa operator!=(), isCopyOf()
*/
bool QFont::operator==(const QFont &f) const
{
@@ -1675,7 +1675,7 @@ bool QFont::operator==(const QFont &f) const
This function is useful in some circumstances, for example if you
want to use QFont objects as keys in a QMap.
- \sa operator==() operator!=() isCopyOf()
+ \sa operator==(), operator!=(), isCopyOf()
*/
bool QFont::operator<(const QFont &f) const
{
@@ -1731,7 +1731,7 @@ QFont::operator QVariant() const
one of them was created as a copy of the other and neither has
been modified since. This is much stricter than equality.
- \sa operator=() operator==()
+ \sa operator=(), operator==()
*/
bool QFont::isCopyOf(const QFont & f) const
{
@@ -1742,7 +1742,7 @@ bool QFont::isCopyOf(const QFont & f) const
Returns true if raw mode is used for font name matching; otherwise
returns false.
- \sa setRawMode() rawName()
+ \sa setRawMode(), rawName()
*/
bool QFont::rawMode() const
{
@@ -1797,7 +1797,7 @@ Q_GLOBAL_STATIC(QFontSubst, globalFontSubst)
To obtain a list of substitutions use substitutes().
- \sa setFamily() insertSubstitutions() insertSubstitution() removeSubstitutions()
+ \sa setFamily(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()
*/
QString QFont::substitute(const QString &familyName)
{
@@ -1818,7 +1818,7 @@ QString QFont::substitute(const QString &familyName)
If there is no substitution for \a familyName, an empty list is
returned.
- \sa substitute() insertSubstitutions() insertSubstitution() removeSubstitutions()
+ \sa substitute(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()
*/
QStringList QFont::substitutes(const QString &familyName)
{
@@ -1832,7 +1832,7 @@ QStringList QFont::substitutes(const QString &familyName)
Inserts \a substituteName into the substitution
table for the family \a familyName.
- \sa insertSubstitutions() removeSubstitutions() substitutions() substitute() substitutes()
+ \sa insertSubstitutions(), removeSubstitutions(), substitutions(), substitute(), substitutes()
*/
void QFont::insertSubstitution(const QString &familyName,
const QString &substituteName)
@@ -2266,7 +2266,7 @@ QDataStream &operator>>(QDataStream &s, QFont &font)
info object is \e not updated.
\endlist
- \sa QFont QFontMetrics QFontDatabase
+ \sa QFont, QFontMetrics, QFontDatabase
*/
/*!
@@ -2343,7 +2343,7 @@ QString QFontInfo::styleName() const
/*!
Returns the point size of the matched window system font.
- \sa pointSizeF() QFont::pointSize()
+ \sa pointSizeF(), QFont::pointSize()
*/
int QFontInfo::pointSize() const
{
@@ -2492,7 +2492,7 @@ bool QFontInfo::fixedPitch() const
Currently only returns the style hint set in QFont.
- \sa QFont::styleHint() QFont::StyleHint
+ \sa QFont::styleHint(), QFont::StyleHint
*/
QFont::StyleHint QFontInfo::styleHint() const
{
diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp
index cc6fa4bfee..141ef64e53 100644
--- a/src/gui/text/qfontmetrics.cpp
+++ b/src/gui/text/qfontmetrics.cpp
@@ -978,7 +978,7 @@ int QFontMetrics::lineWidth() const
Example:
\snippet code/src_gui_text_qfontmetrics.cpp 1
- \sa QFont QFontInfo QFontDatabase
+ \sa QFont, QFontInfo, QFontDatabase
*/
/*!
diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp
index ce46ec2e59..048f1a5ca0 100644
--- a/src/gui/text/qtextcursor.cpp
+++ b/src/gui/text/qtextcursor.cpp
@@ -1138,7 +1138,7 @@ bool QTextCursor::isNull() const
\a pos using a \c MoveMode specified by \a m. The cursor is positioned
between characters.
- \sa position() movePosition() anchor()
+ \sa position(), movePosition(), anchor()
*/
void QTextCursor::setPosition(int pos, MoveMode m)
{
@@ -1169,7 +1169,7 @@ void QTextCursor::setPosition(int pos, MoveMode m)
Returns the absolute position of the cursor within the document.
The cursor is positioned between characters.
- \sa setPosition() movePosition() anchor() positionInBlock()
+ \sa setPosition(), movePosition(), anchor(), positionInBlock()
*/
int QTextCursor::position() const
{
@@ -1200,7 +1200,7 @@ int QTextCursor::positionInBlock() const
selection and anchor() marks the other end. Just like the cursor
position, the anchor position is between characters.
- \sa position() setPosition() movePosition() selectionStart() selectionEnd()
+ \sa position(), setPosition(), movePosition(), selectionStart(), selectionEnd()
*/
int QTextCursor::anchor() const
{
@@ -1388,7 +1388,7 @@ void QTextCursor::setKeepPositionOnInsert(bool b)
Any ASCII linefeed characters (\\n) in the inserted text are transformed
into unicode block separators, corresponding to insertBlock() calls.
- \sa charFormat() hasSelection()
+ \sa charFormat(), hasSelection()
*/
void QTextCursor::insertText(const QString &text)
{
@@ -1476,7 +1476,7 @@ void QTextCursor::insertText(const QString &text, const QTextCharFormat &_format
If there is no selected text, deletes the character \e at the
current cursor position; otherwise deletes the selected text.
- \sa deletePreviousChar() hasSelection() clearSelection()
+ \sa deletePreviousChar(), hasSelection(), clearSelection()
*/
void QTextCursor::deleteChar()
{
@@ -1500,7 +1500,7 @@ void QTextCursor::deleteChar()
If there is no selected text, deletes the character \e before the
current cursor position; otherwise deletes the selected text.
- \sa deleteChar() hasSelection() clearSelection()
+ \sa deleteChar(), hasSelection(), clearSelection()
*/
void QTextCursor::deletePreviousChar()
{
@@ -1623,7 +1623,7 @@ void QTextCursor::selectedTableCells(int *firstRow, int *numRows, int *firstColu
Note that it does \b{not} delete the text of the selection.
- \sa removeSelectedText() hasSelection()
+ \sa removeSelectedText(), hasSelection()
*/
void QTextCursor::clearSelection()
{
@@ -1654,7 +1654,7 @@ void QTextCursor::removeSelectedText()
Returns the start of the selection or position() if the
cursor doesn't have a selection.
- \sa selectionEnd() position() anchor()
+ \sa selectionEnd(), position(), anchor()
*/
int QTextCursor::selectionStart() const
{
@@ -1667,7 +1667,7 @@ int QTextCursor::selectionStart() const
Returns the end of the selection or position() if the cursor
doesn't have a selection.
- \sa selectionStart() position() anchor()
+ \sa selectionStart(), position(), anchor()
*/
int QTextCursor::selectionEnd() const
{
@@ -1770,7 +1770,7 @@ QTextBlock QTextCursor::block() const
/*!
Returns the block format of the block the cursor is in.
- \sa setBlockFormat() charFormat()
+ \sa setBlockFormat(), charFormat()
*/
QTextBlockFormat QTextCursor::blockFormat() const
{
@@ -2049,7 +2049,7 @@ void QTextCursor::insertBlock(const QTextBlockFormat &format, const QTextCharFor
list item of a newly created list with the given \a format. Returns
the created list.
- \sa currentList() createList() insertBlock()
+ \sa currentList(), createList(), insertBlock()
*/
QTextList *QTextCursor::insertList(const QTextListFormat &format)
{
@@ -2076,7 +2076,7 @@ QTextList *QTextCursor::insertList(QTextListFormat::Style style)
Creates and returns a new list with the given \a format, and makes the
current paragraph the cursor is in the first list item.
- \sa insertList() currentList()
+ \sa insertList(), currentList()
*/
QTextList *QTextCursor::createList(const QTextListFormat &format)
{
@@ -2098,7 +2098,7 @@ QTextList *QTextCursor::createList(const QTextListFormat &format)
The style to be used is defined by the QTextListFormat::Style enum.
- \sa insertList() currentList()
+ \sa insertList(), currentList()
*/
QTextList *QTextCursor::createList(QTextListFormat::Style style)
{
@@ -2111,7 +2111,7 @@ QTextList *QTextCursor::createList(QTextListFormat::Style style)
Returns the current list if the cursor position() is inside a
block that is part of a list; otherwise returns 0.
- \sa insertList() createList()
+ \sa insertList(), createList()
*/
QTextList *QTextCursor::currentList() const
{
@@ -2509,7 +2509,7 @@ void QTextCursor::endEditBlock()
one of them was created as a copy of the other and neither has moved since.
This is much stricter than equality.
- \sa operator=() operator==()
+ \sa operator=(), operator==()
*/
bool QTextCursor::isCopyOf(const QTextCursor &other) const
{
diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp
index f0546566d4..d0a15859ee 100644
--- a/src/gui/text/qtextdocument.cpp
+++ b/src/gui/text/qtextdocument.cpp
@@ -272,7 +272,7 @@ QTextCodec *Qt::codecForHtml(const QByteArray &ba)
\li Text block group format changes.
\endlist
- \sa QTextCursor, QTextEdit, \link richtext.html Rich Text Processing\endlink , {Text Object Example}
+ \sa QTextCursor, QTextEdit, {Rich Text Processing}, {Text Object Example}
*/
/*!
@@ -432,7 +432,7 @@ void QTextDocument::redo(QTextCursor *cursor)
signals are emitted, QTextDocument::undoAvailable() or
QTextDocument::redoAvailable().
- \sa QTextDocument::undoAvailable() QTextDocument::redoAvailable()
+ \sa QTextDocument::undoAvailable(), QTextDocument::redoAvailable()
*/
void QTextDocument::clearUndoRedoStacks(Stacks stacksToClear)
{
diff --git a/src/gui/text/qtextdocumentfragment.cpp b/src/gui/text/qtextdocumentfragment.cpp
index 72113bc977..d1147339f6 100644
--- a/src/gui/text/qtextdocumentfragment.cpp
+++ b/src/gui/text/qtextdocumentfragment.cpp
@@ -303,7 +303,7 @@ QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document)
Creates a QTextDocumentFragment from the \a{cursor}'s selection.
If the cursor doesn't have a selection, the created fragment is empty.
- \sa isEmpty() QTextCursor::selection()
+ \sa isEmpty(), QTextCursor::selection()
*/
QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &cursor)
: d(0)
diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp
index bb3d897ebe..6d9eeab660 100644
--- a/src/gui/text/qtextformat.cpp
+++ b/src/gui/text/qtextformat.cpp
@@ -908,7 +908,8 @@ QTextTableCellFormat QTextFormat::toTableCellFormat() const
Returns the value of the property specified by \a propertyId. If the
property isn't of QTextFormat::Bool type, false is returned instead.
- \sa setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
bool QTextFormat::boolProperty(int propertyId) const
{
@@ -924,7 +925,8 @@ bool QTextFormat::boolProperty(int propertyId) const
Returns the value of the property specified by \a propertyId. If the
property is not of QTextFormat::Integer type, 0 is returned instead.
- \sa setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), doubleProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
int QTextFormat::intProperty(int propertyId) const
{
@@ -944,7 +946,8 @@ int QTextFormat::intProperty(int propertyId) const
property isn't of QVariant::Double or QMetaType::Float type, 0 is
returned instead.
- \sa setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
qreal QTextFormat::doubleProperty(int propertyId) const
{
@@ -961,7 +964,8 @@ qreal QTextFormat::doubleProperty(int propertyId) const
property isn't of QVariant::String type, an empty string is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QString QTextFormat::stringProperty(int propertyId) const
{
@@ -996,7 +1000,8 @@ QColor QTextFormat::colorProperty(int propertyId) const
property isn't of QVariant::Pen type, Qt::NoPen is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QPen QTextFormat::penProperty(int propertyId) const
{
@@ -1013,7 +1018,8 @@ QPen QTextFormat::penProperty(int propertyId) const
property isn't of QVariant::Brush type, Qt::NoBrush is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QBrush QTextFormat::brushProperty(int propertyId) const
{
@@ -1028,7 +1034,8 @@ QBrush QTextFormat::brushProperty(int propertyId) const
/*!
Returns the value of the property given by \a propertyId.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ colorProperty(), lengthVectorProperty(), Property
*/
QTextLength QTextFormat::lengthProperty(int propertyId) const
{
@@ -1042,7 +1049,8 @@ QTextLength QTextFormat::lengthProperty(int propertyId) const
property isn't of QTextFormat::LengthVector type, an empty length
vector is returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ colorProperty(), lengthProperty(), Property
*/
QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const
{
@@ -1091,7 +1099,7 @@ void QTextFormat::setProperty(int propertyId, const QVariant &value)
/*!
Sets the value of the property given by \a propertyId to \a value.
- \sa lengthVectorProperty() Property
+ \sa lengthVectorProperty(), Property
*/
void QTextFormat::setProperty(int propertyId, const QVector<QTextLength> &value)
{
@@ -1173,7 +1181,7 @@ void QTextFormat::setObjectIndex(int o)
Returns true if the text format has a property with the given \a
propertyId; otherwise returns false.
- \sa properties() Property
+ \sa properties(), Property
*/
bool QTextFormat::hasProperty(int propertyId) const
{
@@ -1183,7 +1191,7 @@ bool QTextFormat::hasProperty(int propertyId) const
/*
Returns the property type for the given \a propertyId.
- \sa hasProperty() allPropertyIds() Property
+ \sa hasProperty(), allPropertyIds(), Property
*/
/*!
@@ -1267,7 +1275,7 @@ bool QTextFormat::operator==(const QTextFormat &rhs) const
setAnchorHref() and setAnchorNames() functions are used to specify the
information about the hyperlink's destination and the anchor's name.
- \sa QTextFormat QTextBlockFormat QTextTableFormat QTextListFormat
+ \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextListFormat
*/
/*!
@@ -1638,7 +1646,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
Sets the foreground brush to the specified \a brush. The foreground
brush is mostly used to render text.
- \sa foreground() clearForeground() setBackground()
+ \sa foreground(), clearForeground(), setBackground()
*/
@@ -1648,7 +1656,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
Returns the brush used to render foreground details, such as text,
frame outlines, and table borders.
- \sa setForeground() clearForeground() background()
+ \sa setForeground(), clearForeground(), background()
*/
/*!
@@ -1657,7 +1665,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
Clears the brush used to paint the document's foreground. The default
brush will be used.
- \sa foreground() setForeground() clearBackground()
+ \sa foreground(), setForeground(), clearBackground()
*/
@@ -1683,7 +1691,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
Returns true if the text is formatted as an anchor; otherwise
returns false.
- \sa setAnchor() setAnchorHref() setAnchorNames()
+ \sa setAnchor(), setAnchorHref(), setAnchorNames()
*/
@@ -2044,7 +2052,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Sets the paragraph's top \a margin.
- \sa topMargin() setBottomMargin() setLeftMargin() setRightMargin()
+ \sa topMargin(), setBottomMargin(), setLeftMargin(), setRightMargin()
*/
@@ -2053,7 +2061,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Returns the paragraph's top margin.
- \sa setTopMargin() bottomMargin()
+ \sa setTopMargin(), bottomMargin()
*/
@@ -2062,7 +2070,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Sets the paragraph's bottom \a margin.
- \sa bottomMargin() setTopMargin() setLeftMargin() setRightMargin()
+ \sa bottomMargin(), setTopMargin(), setLeftMargin(), setRightMargin()
*/
@@ -2071,7 +2079,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Returns the paragraph's bottom margin.
- \sa setBottomMargin() topMargin()
+ \sa setBottomMargin(), topMargin()
*/
@@ -2081,7 +2089,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Sets the paragraph's left \a margin. Indentation can be applied separately
with setIndent().
- \sa leftMargin() setRightMargin() setTopMargin() setBottomMargin()
+ \sa leftMargin(), setRightMargin(), setTopMargin(), setBottomMargin()
*/
@@ -2090,7 +2098,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Returns the paragraph's left margin.
- \sa setLeftMargin() rightMargin() indent()
+ \sa setLeftMargin(), rightMargin(), indent()
*/
@@ -2099,7 +2107,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Sets the paragraph's right \a margin.
- \sa rightMargin() setLeftMargin() setTopMargin() setBottomMargin()
+ \sa rightMargin(), setLeftMargin(), setTopMargin(), setBottomMargin()
*/
@@ -2108,7 +2116,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Returns the paragraph's right margin.
- \sa setRightMargin() leftMargin()
+ \sa setRightMargin(), leftMargin()
*/
@@ -2119,7 +2127,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
line of a paragraph to be indented differently to the other lines,
enhancing the readability of the text.
- \sa textIndent() setLeftMargin() setRightMargin() setTopMargin() setBottomMargin()
+ \sa textIndent(), setLeftMargin(), setRightMargin(), setTopMargin(), setBottomMargin()
*/
@@ -2140,7 +2148,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
The \a indentation is an integer that is multiplied with the document-wide
standard indent, resulting in the actual indent of the paragraph.
- \sa indent() QTextDocument::indentWidth()
+ \sa indent(), QTextDocument::indentWidth()
*/
@@ -2325,7 +2333,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
Sets the list format's \a style.
- \sa style() Style
+ \sa style(), Style
*/
/*!
@@ -2333,7 +2341,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
Returns the list format's style.
- \sa setStyle() Style
+ \sa setStyle(), Style
*/
@@ -2432,7 +2440,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
The validity of a QTextFrameFormat object can be determined with the
isValid() function.
- \sa QTextFrame QTextBlockFormat
+ \sa QTextFrame, QTextBlockFormat
*/
/*!
@@ -2444,7 +2452,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
\value FloatLeft
\value FloatRight
- \sa position() CssFloat
+ \sa position(), CssFloat
*/
/*!
@@ -2465,7 +2473,7 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
\value BorderStyle_Inset
\value BorderStyle_Outset
- \sa borderStyle() FrameBorderStyle
+ \sa borderStyle(), FrameBorderStyle
*/
/*!
@@ -2768,7 +2776,7 @@ qreal QTextFrameFormat::rightMargin() const
with a vector containing new constraints. If no constraints are
required, clearColumnWidthConstraints() can be used to remove them.
- \sa QTextTable QTextTableCell QTextLength
+ \sa QTextTable, QTextTableCell, QTextLength
*/
/*!
@@ -2825,7 +2833,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
Clears the column width constraints for the table.
- \sa columnWidthConstraints() setColumnWidthConstraints()
+ \sa columnWidthConstraints(), setColumnWidthConstraints()
*/
/*!
@@ -2833,7 +2841,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
Sets the column width \a constraints for the table.
- \sa columnWidthConstraints() clearColumnWidthConstraints()
+ \sa columnWidthConstraints(), clearColumnWidthConstraints()
*/
/*!
@@ -2913,7 +2921,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
Sets the brush use to paint the document's background to the
\a brush specified.
- \sa background() clearBackground() setForeground()
+ \sa background(), clearBackground(), setForeground()
*/
/*!
@@ -2921,7 +2929,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
Returns the brush used to paint the document's background.
- \sa setBackground() clearBackground() foreground()
+ \sa setBackground(), clearBackground(), foreground()
*/
/*!
@@ -2930,7 +2938,7 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
Clears the brush used to paint the document's background. The default
brush will be used.
- \sa background() setBackground() clearForeground()
+ \sa background(), setBackground(), clearForeground()
*/
@@ -3006,7 +3014,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt)
Sets the \a width of the rectangle occupied by the image.
- \sa width() setHeight()
+ \sa width(), setHeight()
*/
@@ -3015,7 +3023,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt)
Returns the width of the rectangle occupied by the image.
- \sa height() setWidth()
+ \sa height(), setWidth()
*/
@@ -3024,7 +3032,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt)
Sets the \a height of the rectangle occupied by the image.
- \sa height() setWidth()
+ \sa height(), setWidth()
*/
@@ -3033,7 +3041,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt)
Returns the height of the rectangle occupied by the image.
- \sa width() setHeight()
+ \sa width(), setHeight()
*/
/*!
@@ -3262,7 +3270,7 @@ QTextTableCellFormat::QTextTableCellFormat(const QTextFormat &fmt)
setRightPadding(), setTopPadding(), and setBottomPadding(). All the paddings
can be set at once using setPadding().
- \sa QTextFormat QTextBlockFormat QTextTableFormat QTextCharFormat
+ \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextCharFormat
*/
// ------------------------------------------------------
diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp
index 82d744d654..cce442c4d7 100644
--- a/src/gui/text/qtextlist.cpp
+++ b/src/gui/text/qtextlist.cpp
@@ -139,7 +139,7 @@ int QTextList::count() const
/*!
Returns the \a{i}-th text block in the list.
- \sa count() itemText()
+ \sa count(), itemText()
*/
QTextBlock QTextList::item(int i) const
{
diff --git a/src/gui/text/qtextobject.cpp b/src/gui/text/qtextobject.cpp
index d4e9c7d12c..af98642abd 100644
--- a/src/gui/text/qtextobject.cpp
+++ b/src/gui/text/qtextobject.cpp
@@ -115,7 +115,7 @@ QTextObject::~QTextObject()
/*!
Returns the text object's format.
- \sa setFormat() document()
+ \sa setFormat(), document()
*/
QTextFormat QTextObject::format() const
{
@@ -201,7 +201,7 @@ QTextDocumentPrivate *QTextObject::docHandle() const
for example, the top-level items in a multi-level list will be separated
by the items in lower levels of the list.
- \sa QTextBlock QTextDocument
+ \sa QTextBlock, QTextDocument
*/
void QTextBlockGroupPrivate::markBlocksDirty()
@@ -343,7 +343,7 @@ QTextFrameLayoutData::~QTextFrameLayoutData()
QTextFrame::iterator class: this provides read-only access to its
internal list of text blocks and child frames.
- \sa QTextCursor QTextDocument
+ \sa QTextCursor, QTextDocument
*/
/*!
@@ -357,7 +357,7 @@ QTextFrameLayoutData::~QTextFrameLayoutData()
Returns the parent frame of the current frame.
- \sa currentFrame() QTextFrame::parentFrame()
+ \sa currentFrame(), QTextFrame::parentFrame()
*/
/*!
@@ -447,7 +447,7 @@ QList<QTextFrame *> QTextFrame::childFrames() const
Returns the frame's parent frame. If the frame is the root frame of a
document, this will return 0.
- \sa childFrames() QTextDocument::rootFrame()
+ \sa childFrames(), QTextDocument::rootFrame()
*/
QTextFrame *QTextFrame::parentFrame() const
{
@@ -459,7 +459,7 @@ QTextFrame *QTextFrame::parentFrame() const
/*!
Returns the first cursor position inside the frame.
- \sa lastCursorPosition() firstPosition() lastPosition()
+ \sa lastCursorPosition(), firstPosition(), lastPosition()
*/
QTextCursor QTextFrame::firstCursorPosition() const
{
@@ -470,7 +470,7 @@ QTextCursor QTextFrame::firstCursorPosition() const
/*!
Returns the last cursor position inside the frame.
- \sa firstCursorPosition() firstPosition() lastPosition()
+ \sa firstCursorPosition(), firstPosition(), lastPosition()
*/
QTextCursor QTextFrame::lastCursorPosition() const
{
@@ -481,7 +481,7 @@ QTextCursor QTextFrame::lastCursorPosition() const
/*!
Returns the first document position inside the frame.
- \sa lastPosition() firstCursorPosition() lastCursorPosition()
+ \sa lastPosition(), firstCursorPosition(), lastCursorPosition()
*/
int QTextFrame::firstPosition() const
{
@@ -494,7 +494,7 @@ int QTextFrame::firstPosition() const
/*!
Returns the last document position inside the frame.
- \sa firstPosition() firstCursorPosition() lastCursorPosition()
+ \sa firstPosition(), firstCursorPosition(), lastCursorPosition()
*/
int QTextFrame::lastPosition() const
{
@@ -718,7 +718,7 @@ QTextBlock QTextFrame::iterator::currentBlock() const
/*!
Moves the iterator to the next frame or block.
- \sa currentBlock() currentFrame()
+ \sa currentBlock(), currentFrame()
*/
QTextFrame::iterator &QTextFrame::iterator::operator++()
{
@@ -756,7 +756,7 @@ QTextFrame::iterator &QTextFrame::iterator::operator++()
/*!
Moves the iterator to the previous frame or block.
- \sa currentBlock() currentFrame()
+ \sa currentBlock(), currentFrame()
*/
QTextFrame::iterator &QTextFrame::iterator::operator--()
{
@@ -864,7 +864,7 @@ QTextBlockUserData::~QTextBlockUserData()
\img qtextblock-sequence.png
- \sa QTextBlockFormat QTextCharFormat QTextFragment
+ \sa QTextBlockFormat, QTextCharFormat, QTextFragment
*/
/*!
@@ -1027,7 +1027,7 @@ int QTextBlock::position() const
\note The length returned includes all formatting characters,
for example, newline.
- \sa text() charFormat() blockFormat()
+ \sa text(), charFormat(), blockFormat()
*/
int QTextBlock::length() const
{
@@ -1195,7 +1195,7 @@ Qt::LayoutDirection QTextBlock::textDirection() const
/*!
Returns the block's contents as plain text.
- \sa length() charFormat() blockFormat()
+ \sa length(), charFormat(), blockFormat()
*/
QString QTextBlock::text() const
{
@@ -1468,7 +1468,7 @@ QTextBlock::iterator QTextBlock::begin() const
Returns a text block iterator pointing to the end of the text
block.
- \sa begin() next() previous()
+ \sa begin(), next(), previous()
*/
QTextBlock::iterator QTextBlock::end() const
{
@@ -1489,7 +1489,7 @@ QTextBlock::iterator QTextBlock::end() const
Note that the next block may be in a different frame or table to this block.
- \sa previous() begin() end()
+ \sa previous(), begin(), end()
*/
QTextBlock QTextBlock::next() const
{
@@ -1505,7 +1505,7 @@ QTextBlock QTextBlock::next() const
Note that the next block may be in a different frame or table to this block.
- \sa next() begin() end()
+ \sa next(), begin(), end()
*/
QTextBlock QTextBlock::previous() const
{
diff --git a/src/gui/text/qtexttable.cpp b/src/gui/text/qtexttable.cpp
index a9866187d3..5589ffeb71 100644
--- a/src/gui/text/qtexttable.cpp
+++ b/src/gui/text/qtexttable.cpp
@@ -76,7 +76,7 @@ QT_BEGIN_NAMESPACE
contents. The firstCursorPosition() and lastCursorPosition() functions
are used to obtain the extent of the cell in the document.
- \sa QTextTable QTextTableFormat
+ \sa QTextTable, QTextTableFormat
*/
/*!
@@ -583,7 +583,7 @@ QTextTable::~QTextTable()
Returns the table cell at the given \a row and \a column in the table.
- \sa columns() rows()
+ \sa columns(), rows()
*/
QTextTableCell QTextTable::cellAt(int row, int col) const
{
@@ -639,7 +639,7 @@ QTextTableCell QTextTable::cellAt(const QTextCursor &c) const
Resizes the table to contain the required number of \a rows and \a columns.
- \sa insertRows() insertColumns() removeRows() removeColumns()
+ \sa insertRows(), insertColumns(), removeRows(), removeColumns()
*/
void QTextTable::resize(int rows, int cols)
{
@@ -673,7 +673,7 @@ void QTextTable::resize(int rows, int cols)
Inserts a number of \a rows before the row with the specified \a index.
- \sa resize() insertColumns() removeRows() removeColumns() appendRows() appendColumns()
+ \sa resize(), insertColumns(), removeRows(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::insertRows(int pos, int num)
{
@@ -735,7 +735,7 @@ void QTextTable::insertRows(int pos, int num)
Inserts a number of \a columns before the column with the specified \a index.
- \sa insertRows() resize() removeRows() removeColumns() appendRows() appendColumns()
+ \sa insertRows(), resize(), removeRows(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::insertColumns(int pos, int num)
{
@@ -816,7 +816,7 @@ void QTextTable::insertColumns(int pos, int num)
\since 4.5
Appends \a count rows at the bottom of the table.
- \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendColumns()
+ \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendColumns()
*/
void QTextTable::appendRows(int count)
{
@@ -827,7 +827,7 @@ void QTextTable::appendRows(int count)
\since 4.5
Appends \a count columns at the right side of the table.
- \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendRows()
+ \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendRows()
*/
void QTextTable::appendColumns(int count)
{
@@ -839,7 +839,7 @@ void QTextTable::appendColumns(int count)
Removes a number of \a rows starting with the row at the specified \a index.
- \sa insertRows(), insertColumns(), resize(), removeColumns() appendRows() appendColumns()
+ \sa insertRows(), insertColumns(), resize(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::removeRows(int pos, int num)
{
@@ -901,7 +901,7 @@ void QTextTable::removeRows(int pos, int num)
Removes a number of \a columns starting with the column at the specified
\a index.
- \sa insertRows() insertColumns() removeRows() resize() appendRows() appendColumns()
+ \sa insertRows(), insertColumns(), removeRows(), resize(), appendRows(), appendColumns()
*/
void QTextTable::removeColumns(int pos, int num)
{