diff options
author | Marius Storm-Olsen <marius.storm-olsen@nokia.com> | 2012-05-10 13:10:23 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-11 01:42:02 +0200 |
commit | ad97aba452ed7d3dbd3c9d437c59c14b2ae0661b (patch) | |
tree | 2a37426bc8e29f27d3b3a486693b484b2caa069c /src/widgets/itemviews | |
parent | 87d21127de4a361c7e76ba91a0ea336bbed32853 (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/widgets/itemviews')
-rw-r--r-- | src/widgets/itemviews/qabstractitemdelegate.cpp | 2 | ||||
-rw-r--r-- | src/widgets/itemviews/qabstractitemview.cpp | 26 | ||||
-rw-r--r-- | src/widgets/itemviews/qcolumnview.cpp | 2 | ||||
-rw-r--r-- | src/widgets/itemviews/qdirmodel.cpp | 3 | ||||
-rw-r--r-- | src/widgets/itemviews/qheaderview.cpp | 14 | ||||
-rw-r--r-- | src/widgets/itemviews/qlistwidget.cpp | 12 | ||||
-rw-r--r-- | src/widgets/itemviews/qproxymodel.cpp | 7 | ||||
-rw-r--r-- | src/widgets/itemviews/qstandarditemmodel.cpp | 10 | ||||
-rw-r--r-- | src/widgets/itemviews/qtableview.cpp | 12 | ||||
-rw-r--r-- | src/widgets/itemviews/qtablewidget.cpp | 14 | ||||
-rw-r--r-- | src/widgets/itemviews/qtreeview.cpp | 6 | ||||
-rw-r--r-- | src/widgets/itemviews/qtreewidget.cpp | 14 |
12 files changed, 62 insertions, 60 deletions
diff --git a/src/widgets/itemviews/qabstractitemdelegate.cpp b/src/widgets/itemviews/qabstractitemdelegate.cpp index 890eba3407..21c67cb297 100644 --- a/src/widgets/itemviews/qabstractitemdelegate.cpp +++ b/src/widgets/itemviews/qabstractitemdelegate.cpp @@ -232,7 +232,7 @@ QAbstractItemDelegate::~QAbstractItemDelegate() editor paints its own background (e.g., with \l{QWidget::}{setAutoFillBackground()}). - \sa destroyEditor() setModelData() setEditorData() + \sa destroyEditor(), setModelData(), setEditorData() */ QWidget *QAbstractItemDelegate::createEditor(QWidget *, const QStyleOptionViewItem &, diff --git a/src/widgets/itemviews/qabstractitemview.cpp b/src/widgets/itemviews/qabstractitemview.cpp index 777767ee70..a53f3f1465 100644 --- a/src/widgets/itemviews/qabstractitemview.cpp +++ b/src/widgets/itemviews/qabstractitemview.cpp @@ -1009,7 +1009,7 @@ QAbstractItemDelegate *QAbstractItemView::itemDelegate(const QModelIndex &index) and, in many-item selections, whether the selection must be a continuous range of items. - \sa SelectionMode SelectionBehavior + \sa SelectionMode, SelectionBehavior */ void QAbstractItemView::setSelectionMode(SelectionMode mode) { @@ -1030,7 +1030,7 @@ QAbstractItemView::SelectionMode QAbstractItemView::selectionMode() const This property holds whether selections are done in terms of single items, rows or columns. - \sa SelectionMode SelectionBehavior + \sa SelectionMode, SelectionBehavior */ void QAbstractItemView::setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior) @@ -1383,7 +1383,7 @@ bool QAbstractItemView::tabKeyNavigation() const \property QAbstractItemView::showDropIndicator \brief whether the drop indicator is shown when dragging items and dropping. - \sa dragEnabled DragDropMode dragDropOverwriteMode acceptDrops + \sa dragEnabled, DragDropMode, dragDropOverwriteMode, acceptDrops */ void QAbstractItemView::setDropIndicatorShown(bool enable) @@ -1402,7 +1402,7 @@ bool QAbstractItemView::showDropIndicator() const \property QAbstractItemView::dragEnabled \brief whether the view supports dragging of its own items - \sa showDropIndicator DragDropMode dragDropOverwriteMode acceptDrops + \sa showDropIndicator, DragDropMode, dragDropOverwriteMode, acceptDrops */ void QAbstractItemView::setDragEnabled(bool enable) @@ -1434,7 +1434,7 @@ bool QAbstractItemView::dragEnabled() const Note that the model used needs to provide support for drag and drop operations. - \sa setDragDropMode() {Using drag and drop with item views} + \sa setDragDropMode(), {Using drag and drop with item views} */ /*! @@ -1442,7 +1442,7 @@ bool QAbstractItemView::dragEnabled() const \brief the drag and drop event the view will act upon \since 4.2 - \sa showDropIndicator dragDropOverwriteMode + \sa showDropIndicator, dragDropOverwriteMode */ void QAbstractItemView::setDragDropMode(DragDropMode behavior) { @@ -1483,7 +1483,7 @@ QAbstractItemView::DragDropMode QAbstractItemView::dragDropMode() const actions support CopyAction. \since 4.6 - \sa showDropIndicator dragDropOverwriteMode + \sa showDropIndicator, dragDropOverwriteMode */ void QAbstractItemView::setDefaultDropAction(Qt::DropAction dropAction) { @@ -1905,7 +1905,7 @@ void QAbstractItemView::mouseDoubleClickEvent(QMouseEvent *event) the widget. If the drag is over a valid dropping place (e.g. over an item that accepts drops), the event is accepted; otherwise it is ignored. - \sa dropEvent() startDrag() + \sa dropEvent(), startDrag() */ void QAbstractItemView::dragEnterEvent(QDragEnterEvent *event) { @@ -1927,7 +1927,7 @@ void QAbstractItemView::dragEnterEvent(QDragEnterEvent *event) the user drags a selection to view's right or bottom edge. In this case, the event will be accepted; otherwise it will be ignored. - \sa dropEvent() startDrag() + \sa dropEvent(), startDrag() */ void QAbstractItemView::dragMoveEvent(QDragMoveEvent *event) { @@ -2863,7 +2863,7 @@ void QAbstractItemView::editorDestroyed(QObject *editor) Note that if the view has a horizontal header, the item steps will be ignored and the header section size will be used instead. - \sa horizontalStepsPerItem() setVerticalStepsPerItem() + \sa horizontalStepsPerItem(), setVerticalStepsPerItem() */ void QAbstractItemView::setHorizontalStepsPerItem(int steps) { @@ -2875,7 +2875,7 @@ void QAbstractItemView::setHorizontalStepsPerItem(int steps) \obsolete Returns the horizontal scroll bar's steps per item. - \sa setHorizontalStepsPerItem() verticalStepsPerItem() + \sa setHorizontalStepsPerItem(), verticalStepsPerItem() */ int QAbstractItemView::horizontalStepsPerItem() const { @@ -2892,7 +2892,7 @@ int QAbstractItemView::horizontalStepsPerItem() const Note that if the view has a vertical header, the item steps will be ignored and the header section size will be used instead. - \sa verticalStepsPerItem() setHorizontalStepsPerItem() + \sa verticalStepsPerItem(), setHorizontalStepsPerItem() */ void QAbstractItemView::setVerticalStepsPerItem(int steps) { @@ -2904,7 +2904,7 @@ void QAbstractItemView::setVerticalStepsPerItem(int steps) \obsolete Returns the vertical scroll bar's steps per item. - \sa setVerticalStepsPerItem() horizontalStepsPerItem() + \sa setVerticalStepsPerItem(), horizontalStepsPerItem() */ int QAbstractItemView::verticalStepsPerItem() const { diff --git a/src/widgets/itemviews/qcolumnview.cpp b/src/widgets/itemviews/qcolumnview.cpp index 6758aeb337..83cea4fd15 100644 --- a/src/widgets/itemviews/qcolumnview.cpp +++ b/src/widgets/itemviews/qcolumnview.cpp @@ -663,7 +663,7 @@ void QColumnViewPrivate::_q_clicked(const QModelIndex &index) Return the new view - \sa createColumn() setPreviewWidget() + \sa createColumn(), setPreviewWidget() \sa doLayout() */ QAbstractItemView *QColumnViewPrivate::createColumn(const QModelIndex &index, bool show) diff --git a/src/widgets/itemviews/qdirmodel.cpp b/src/widgets/itemviews/qdirmodel.cpp index 6ecf3c75aa..db2f437890 100644 --- a/src/widgets/itemviews/qdirmodel.cpp +++ b/src/widgets/itemviews/qdirmodel.cpp @@ -734,7 +734,8 @@ void QDirModel::setSorting(QDir::SortFlags sort) /*! Returns the sorting method used for the directory model. - \sa QDir::SortFlags */ + \sa QDir::SortFlags +*/ QDir::SortFlags QDirModel::sorting() const { diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp index 4ab984b53c..0a7f9de0b3 100644 --- a/src/widgets/itemviews/qheaderview.cpp +++ b/src/widgets/itemviews/qheaderview.cpp @@ -185,7 +185,7 @@ QDataStream &operator>>(QDataStream &in, QHeaderViewPrivate::SectionItem §io The following values are obsolete: \value Custom Use Fixed instead. - \sa setResizeMode() setSectionResizeMode() stretchLastSection minimumSectionSize + \sa setResizeMode(), setSectionResizeMode(), stretchLastSection, minimumSectionSize */ /*! @@ -1019,7 +1019,7 @@ void QHeaderView::setSectionHidden(int logicalIndex, bool hide) /*! Returns the number of sections in the header. - \sa sectionCountChanged(), length() + \sa sectionCountChanged(), length() */ int QHeaderView::count() const @@ -1334,7 +1334,7 @@ bool QHeaderView::isSortIndicatorShown() const and the model will return to its natural, unsorted order. Note that not all models support this and may even crash in this case. - \sa sortIndicatorSection() sortIndicatorOrder() + \sa sortIndicatorSection(), sortIndicatorOrder() */ void QHeaderView::setSortIndicator(int logicalIndex, Qt::SortOrder order) @@ -1370,7 +1370,7 @@ void QHeaderView::setSortIndicator(int logicalIndex, Qt::SortOrder order) Returns the logical index of the section that has a sort indicator. By default this is section 0. - \sa setSortIndicator() sortIndicatorOrder() setSortIndicatorShown() + \sa setSortIndicator(), sortIndicatorOrder(), setSortIndicatorShown() */ int QHeaderView::sortIndicatorSection() const @@ -1383,7 +1383,7 @@ int QHeaderView::sortIndicatorSection() const Returns the order for the sort indicator. If no section has a sort indicator the return value of this function is undefined. - \sa setSortIndicator() sortIndicatorSection() + \sa setSortIndicator(), sortIndicatorSection() */ Qt::SortOrder QHeaderView::sortIndicatorOrder() const @@ -1458,7 +1458,7 @@ void QHeaderView::setCascadingSectionResizes(bool enable) This property only affects sections that have \l Interactive or \l Fixed as their resize mode. - \sa setSectionResizeMode() minimumSectionSize + \sa setSectionResizeMode(), minimumSectionSize */ int QHeaderView::defaultSectionSize() const { @@ -1484,7 +1484,7 @@ void QHeaderView::setDefaultSectionSize(int size) This property is honored by all \l{ResizeMode}{resize modes}. - \sa setSectionResizeMode() defaultSectionSize + \sa setSectionResizeMode(), defaultSectionSize */ int QHeaderView::minimumSectionSize() const { diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp index 4a17b65328..23b7989634 100644 --- a/src/widgets/itemviews/qlistwidget.cpp +++ b/src/widgets/itemviews/qlistwidget.cpp @@ -853,7 +853,7 @@ QDataStream &operator>>(QDataStream &in, QListWidgetItem &item) Returns the list item's tooltip. - \sa setToolTip() statusTip() whatsThis() + \sa setToolTip(), statusTip(), whatsThis() */ /*! @@ -861,7 +861,7 @@ QDataStream &operator>>(QDataStream &in, QListWidgetItem &item) Returns the list item's "What's This?" help text. - \sa setWhatsThis() statusTip() toolTip() + \sa setWhatsThis(), statusTip(), toolTip() */ /*! @@ -891,7 +891,7 @@ QDataStream &operator>>(QDataStream &in, QListWidgetItem &item) Returns the brush used to display the list item's background. - \sa setBackground() foreground() + \sa setBackground(), foreground() */ /*! @@ -909,7 +909,7 @@ QDataStream &operator>>(QDataStream &in, QListWidgetItem &item) Returns the brush used to display the list item's foreground (e.g. text). - \sa setForeground() background() + \sa setForeground(), background() */ /*! @@ -1019,7 +1019,7 @@ void QListWidgetItem::setFlags(Qt::ItemFlags aflags) { Sets the background brush of the list item to the given \a brush. - \sa background() setForeground() + \sa background(), setForeground() */ /*! @@ -1035,7 +1035,7 @@ void QListWidgetItem::setFlags(Qt::ItemFlags aflags) { Sets the foreground brush of the list item to the given \a brush. - \sa foreground() setBackground() + \sa foreground(), setBackground() */ /*! diff --git a/src/widgets/itemviews/qproxymodel.cpp b/src/widgets/itemviews/qproxymodel.cpp index c004ccb19a..479212422b 100644 --- a/src/widgets/itemviews/qproxymodel.cpp +++ b/src/widgets/itemviews/qproxymodel.cpp @@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE representation, proxy models must create their own model indexes instead of supplying model indexes from their underlying models. - \sa \link model-view-programming.html Model/View Programming\endlink QAbstractItemModel + \sa {Model/View Programming}, QAbstractItemModel */ @@ -204,7 +204,7 @@ QVariant QProxyModel::data(const QModelIndex &index, int role) const The base class implementation returns false. This function and data() must be reimplemented for editable models. - \sa data() itemData() QAbstractItemModel::setData() + \sa data(), itemData(), QAbstractItemModel::setData() */ bool QProxyModel::setData(const QModelIndex &index, const QVariant &value, int role) { @@ -295,7 +295,8 @@ Qt::DropActions QProxyModel::supportedDropActions() const Returns true if the rows were successfully inserted; otherwise returns false. - \sa QAbstractItemModel::insertRows()*/ + \sa QAbstractItemModel::insertRows() +*/ bool QProxyModel::insertRows(int row, int count, const QModelIndex &parent) { Q_D(const QProxyModel); diff --git a/src/widgets/itemviews/qstandarditemmodel.cpp b/src/widgets/itemviews/qstandarditemmodel.cpp index 4f488993f8..17a7341b7c 100644 --- a/src/widgets/itemviews/qstandarditemmodel.cpp +++ b/src/widgets/itemviews/qstandarditemmodel.cpp @@ -992,7 +992,7 @@ Qt::ItemFlags QStandardItem::flags() const Sets the font used to display the item's text to the given \a font. - \sa font() setText() setForeground() + \sa font(), setText(), setForeground() */ /*! @@ -1000,7 +1000,7 @@ Qt::ItemFlags QStandardItem::flags() const Returns the brush used to render the item's background. - \sa foreground() setBackground() + \sa foreground(), setBackground() */ /*! @@ -1008,7 +1008,7 @@ Qt::ItemFlags QStandardItem::flags() const Sets the item's background brush to the specified \a brush. - \sa background() setForeground() + \sa background(), setForeground() */ /*! @@ -1016,7 +1016,7 @@ Qt::ItemFlags QStandardItem::flags() const Returns the brush used to render the item's foreground (e.g. text). - \sa setForeground() background() + \sa setForeground(), background() */ /*! @@ -1025,7 +1025,7 @@ Qt::ItemFlags QStandardItem::flags() const Sets the brush used to display the item's foreground (e.g. text) to the given \a brush. - \sa foreground() setBackground() setFont() + \sa foreground(), setBackground(), setFont() */ /*! diff --git a/src/widgets/itemviews/qtableview.cpp b/src/widgets/itemviews/qtableview.cpp index e997f7e9d6..b851907b08 100644 --- a/src/widgets/itemviews/qtableview.cpp +++ b/src/widgets/itemviews/qtableview.cpp @@ -1169,7 +1169,7 @@ QHeaderView *QTableView::verticalHeader() const /*! Sets the widget to use for the horizontal header to \a header. - \sa horizontalHeader() setVerticalHeader() + \sa horizontalHeader(), setVerticalHeader() */ void QTableView::setHorizontalHeader(QHeaderView *header) { @@ -1206,7 +1206,7 @@ void QTableView::setHorizontalHeader(QHeaderView *header) /*! Sets the widget to use for the vertical header to \a header. - \sa verticalHeader() setHorizontalHeader() + \sa verticalHeader(), setHorizontalHeader() */ void QTableView::setVerticalHeader(QHeaderView *header) { @@ -2876,7 +2876,7 @@ void QTableView::selectColumn(int column) /*! Hide the given \a row. - \sa showRow() hideColumn() + \sa showRow(), hideColumn() */ void QTableView::hideRow(int row) { @@ -2887,7 +2887,7 @@ void QTableView::hideRow(int row) /*! Hide the given \a column. - \sa showColumn() hideRow() + \sa showColumn(), hideRow() */ void QTableView::hideColumn(int column) { @@ -2898,7 +2898,7 @@ void QTableView::hideColumn(int column) /*! Show the given \a row. - \sa hideRow() showColumn() + \sa hideRow(), showColumn() */ void QTableView::showRow(int row) { @@ -2909,7 +2909,7 @@ void QTableView::showRow(int row) /*! Show the given \a column. - \sa hideColumn() showRow() + \sa hideColumn(), showRow() */ void QTableView::showColumn(int column) { diff --git a/src/widgets/itemviews/qtablewidget.cpp b/src/widgets/itemviews/qtablewidget.cpp index a50b6f3111..d9d377a548 100644 --- a/src/widgets/itemviews/qtablewidget.cpp +++ b/src/widgets/itemviews/qtablewidget.cpp @@ -1118,7 +1118,7 @@ void QTableWidgetItem::setFlags(Qt::ItemFlags aflags) Sets the item's text to the \a text specified. - \sa text() setFont() setForeground() + \sa text(), setFont(), setForeground() */ /*! @@ -1152,7 +1152,7 @@ void QTableWidgetItem::setFlags(Qt::ItemFlags aflags) \a statusTip. QTableWidget mouse tracking needs to be enabled for this feature to work. - \sa statusTip() setToolTip() setWhatsThis() + \sa statusTip(), setToolTip(), setWhatsThis() */ /*! @@ -1168,7 +1168,7 @@ void QTableWidgetItem::setFlags(Qt::ItemFlags aflags) Sets the item's tooltip to the string specified by \a toolTip. - \sa toolTip() setStatusTip() setWhatsThis() + \sa toolTip(), setStatusTip(), setWhatsThis() */ /*! @@ -1184,7 +1184,7 @@ void QTableWidgetItem::setFlags(Qt::ItemFlags aflags) Sets the item's "What's This?" help to the string specified by \a whatsThis. - \sa whatsThis() setStatusTip() setToolTip() + \sa whatsThis(), setStatusTip(), setToolTip() */ /*! @@ -1200,7 +1200,7 @@ void QTableWidgetItem::setFlags(Qt::ItemFlags aflags) Sets the font used to display the item's text to the given \a font. - \sa font() setText() setForeground() + \sa font(), setText(), setForeground() */ /*! @@ -1724,7 +1724,7 @@ void QTableWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, This signal is emitted whenever the selection changes. - \sa selectedItems() QTableWidgetItem::isSelected() + \sa selectedItems(), QTableWidgetItem::isSelected() */ @@ -1950,7 +1950,7 @@ QTableWidgetItem *QTableWidget::item(int row, int column) const you to use the same \a row argument for all items in the same row (i.e. setItem() will not move the row). - \sa item() takeItem() + \sa item(), takeItem() */ void QTableWidget::setItem(int row, int column, QTableWidgetItem *item) { diff --git a/src/widgets/itemviews/qtreeview.cpp b/src/widgets/itemviews/qtreeview.cpp index 44dd4b0761..510ae41d2d 100644 --- a/src/widgets/itemviews/qtreeview.cpp +++ b/src/widgets/itemviews/qtreeview.cpp @@ -2614,7 +2614,7 @@ void QTreeView::selectAll() Warning: if the model contains a large number of items, this function will take some time to execute. - \sa collapseAll() expand() collapse() setExpanded() + \sa collapseAll(), expand(), collapse(), setExpanded() */ void QTreeView::expandAll() { @@ -2631,7 +2631,7 @@ void QTreeView::expandAll() Collapses all expanded items. - \sa expandAll() expand() collapse() setExpanded() + \sa expandAll(), expand(), collapse(), setExpanded() */ void QTreeView::collapseAll() { @@ -2644,7 +2644,7 @@ void QTreeView::collapseAll() \since 4.3 Expands all expandable items to the given \a depth. - \sa expandAll() collapseAll() expand() collapse() setExpanded() + \sa expandAll(), collapseAll(), expand(), collapse(), setExpanded() */ void QTreeView::expandToDepth(int depth) { diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp index d9d6c1434c..d27eaf6805 100644 --- a/src/widgets/itemviews/qtreewidget.cpp +++ b/src/widgets/itemviews/qtreewidget.cpp @@ -1067,7 +1067,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) Sets the text to be displayed in the given \a column to the given \a text. - \sa text() setFont() setForeground() + \sa text(), setFont(), setForeground() */ /*! @@ -1100,7 +1100,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) Sets the status tip for the given \a column to the given \a statusTip. QTreeWidget mouse tracking needs to be enabled for this feature to work. - \sa statusTip() setToolTip() setWhatsThis() + \sa statusTip(), setToolTip(), setWhatsThis() */ /*! @@ -1116,7 +1116,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) Sets the tooltip for the given \a column to \a toolTip. - \sa toolTip() setStatusTip() setWhatsThis() + \sa toolTip(), setStatusTip(), setWhatsThis() */ /*! @@ -1132,7 +1132,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) Sets the "What's This?" help for the given \a column to \a whatsThis. - \sa whatsThis() setStatusTip() setToolTip() + \sa whatsThis(), setStatusTip(), setToolTip() */ /*! @@ -1149,7 +1149,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) Sets the font used to display the text in the given \a column to the given \a font. - \sa font() setText() setForeground() + \sa font(), setText(), setForeground() */ /*! @@ -1881,7 +1881,7 @@ QTreeWidgetItem &QTreeWidgetItem::operator=(const QTreeWidgetItem &other) /*! Appends the \a child item to the list of children. - \sa insertChild() takeChild() + \sa insertChild(), takeChild() */ void QTreeWidgetItem::addChild(QTreeWidgetItem *child) { @@ -1984,7 +1984,7 @@ QTreeWidgetItem *QTreeWidgetItem::takeChild(int index) Appends the given list of \a children to the item. - \sa insertChildren() takeChildren() + \sa insertChildren(), takeChildren() */ void QTreeWidgetItem::addChildren(const QList<QTreeWidgetItem*> &children) { |