qdoc: properly omit comments for enums marked with omitvalue
When a value is omitted with \omitvalue, the comment must be either deleted or omitted with \omit .. \endomit. Otherwise the comment is merged into the comment for the previous value Change-Id: Ic5cfb20d36853526ae939529b4609712cd0eb341 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Christian Ehrlicher
parent
acc629c1e8
commit
e3fa4af68e
@ -1889,7 +1889,7 @@ bool QCoreApplication::event(QEvent *e)
|
||||
|
||||
\value UnicodeUTF8 UTF-8.
|
||||
\omitvalue Latin1
|
||||
\omitvalue DefaultCodec UTF-8.
|
||||
\omitvalue DefaultCodec \omit UTF-8. \endomit
|
||||
\omitvalue CodecForTr
|
||||
|
||||
\sa QObject::tr(), QString::fromUtf8()
|
||||
|
||||
@ -313,7 +313,7 @@ struct DefinedTypesFilter {
|
||||
\omitvalue WeakPointerToQObject
|
||||
\omitvalue TrackingPointerToQObject
|
||||
\omitvalue WasDeclaredAsMetaType
|
||||
\omitvalue IsGadget This type is a Q_GADGET and it's corresponding QMetaObject can be accessed with QMetaType::metaObject Since 5.5.
|
||||
\omitvalue IsGadget \omit This type is a Q_GADGET and it's corresponding QMetaObject can be accessed with QMetaType::metaObject Since 5.5. \endomit
|
||||
\omitvalue PointerToGadget
|
||||
*/
|
||||
|
||||
|
||||
@ -202,7 +202,7 @@ Q_LOGGING_CATEGORY(lcAccessibilityCore, "qt.accessibility.core");
|
||||
|
||||
This enum type defines accessible event types.
|
||||
|
||||
\omitvalue InvalidEvent Internal: Used when creating subclasses of QAccessibleEvent.
|
||||
\omitvalue InvalidEvent \omit Internal: Used when creating subclasses of QAccessibleEvent. \endomit
|
||||
\value AcceleratorChanged The keyboard accelerator for an action has been changed.
|
||||
\value ActionChanged An action has been changed.
|
||||
\value ActiveDescendantChanged
|
||||
@ -273,27 +273,27 @@ Q_LOGGING_CATEGORY(lcAccessibilityCore, "qt.accessibility.core");
|
||||
\value SelectionWithin Several changes to a selection has occurred in an item
|
||||
view.
|
||||
\value SoundPlayed A sound has been played by an object
|
||||
\omitvalue StateChanged The QAccessible::State of an object has changed.
|
||||
This value is used internally for the QAccessibleStateChangeEvent.
|
||||
\omitvalue StateChanged \omit The QAccessible::State of an object has changed.
|
||||
This value is used internally for the QAccessibleStateChangeEvent. \endomit
|
||||
\value TableCaptionChanged A table caption has been changed.
|
||||
\value TableColumnDescriptionChanged The description of a table column, typically found in
|
||||
the column's header, has been changed.
|
||||
\value TableColumnHeaderChanged A table column header has been changed.
|
||||
\omitvalue TableModelChanged The model providing data for a table has been changed.
|
||||
\omitvalue TableModelChanged \omit The model providing data for a table has been changed. \endomit
|
||||
\value TableRowDescriptionChanged The description of a table row, typically found in the
|
||||
row's header, has been changed.
|
||||
\value TableRowHeaderChanged A table row header has been changed.
|
||||
\value TableSummaryChanged The summary of a table has been changed.
|
||||
\omitvalue TextAttributeChanged
|
||||
\omitvalue TextCaretMoved The caret has moved in an editable widget.
|
||||
\omitvalue TextCaretMoved \omit The caret has moved in an editable widget.
|
||||
The caret represents the cursor position in an editable
|
||||
widget with the input focus.
|
||||
widget with the input focus. \endomit
|
||||
\value TextColumnChanged A text column has been changed.
|
||||
\omitvalue TextInserted Text has been inserted into an editable widget.
|
||||
\omitvalue TextRemoved Text has been removed from an editable widget.
|
||||
\omitvalue TextSelectionChanged The selected text has changed in an editable widget.
|
||||
\omitvalue TextUpdated The text has been update in an editable widget.
|
||||
\omitvalue ValueChanged The QAccessible::Value of an object has changed.
|
||||
\omitvalue TextInserted \omit Text has been inserted into an editable widget. \endomit
|
||||
\omitvalue TextRemoved \omit Text has been removed from an editable widget. \endomit
|
||||
\omitvalue TextSelectionChanged \omit The selected text has changed in an editable widget. \endomit
|
||||
\omitvalue TextUpdated \omit The text has been update in an editable widget. \endomit
|
||||
\omitvalue ValueChanged \omit The QAccessible::Value of an object has changed. \endomit
|
||||
\value VisibleDataChanged
|
||||
|
||||
The values for this enum are defined to be the same as those defined in the
|
||||
@ -441,10 +441,10 @@ Q_LOGGING_CATEGORY(lcAccessibilityCore, "qt.accessibility.core");
|
||||
\note When subclassing one of these interfaces, \l QAccessibleInterface::interface_cast() needs to be implemented.
|
||||
|
||||
\value TextInterface For text that supports selections or is more than one line. Simple labels do not need to implement this interface.
|
||||
\omitvalue EditableTextInterface For text that can be edited by the user.
|
||||
\omitvalue EditableTextInterface \omit For text that can be edited by the user. \endomit
|
||||
\value ValueInterface For objects that are used to manipulate a value, for example slider or scroll bar.
|
||||
\value ActionInterface For interactive objects that allow the user to trigger an action. Basically everything that allows for example mouse interaction.
|
||||
\omitvalue ImageInterface For objects that represent an image. This interface is generally less important.
|
||||
\omitvalue ImageInterface \omit For objects that represent an image. This interface is generally less important. \endomit
|
||||
\value TableInterface For lists, tables and trees.
|
||||
\value TableCellInterface For cells in a TableInterface object.
|
||||
|
||||
|
||||
@ -514,7 +514,7 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt)
|
||||
\value BlockFormat The object formats a text block
|
||||
\value CharFormat The object formats a single character
|
||||
\value ListFormat The object formats a list
|
||||
\omitvalue TableFormat Unused Value, a table's FormatType is FrameFormat.
|
||||
\omitvalue TableFormat \omit Unused Value, a table's FormatType is FrameFormat. \endomit
|
||||
\value FrameFormat The object formats a frame
|
||||
|
||||
\value UserFormat
|
||||
|
||||
@ -2104,17 +2104,17 @@ struct DDSFormat {
|
||||
would mirror the image and automatically generate mipmaps. This
|
||||
option helps preserve this default behavior.
|
||||
|
||||
\omitvalue CanFlipNativePixmapBindOption Used by x11 from pixmap to choose
|
||||
whether or not it can bind the pixmap upside down or not.
|
||||
\omitvalue CanFlipNativePixmapBindOption \omit Used by x11 from pixmap to choose
|
||||
whether or not it can bind the pixmap upside down or not. \endomit
|
||||
|
||||
\omitvalue MemoryManagedBindOption Used by paint engines to
|
||||
\omitvalue MemoryManagedBindOption \omit Used by paint engines to
|
||||
indicate that the pixmap should be memory managed along side with
|
||||
the pixmap/image that it stems from, e.g. installing destruction
|
||||
hooks in them.
|
||||
hooks in them. \endomit
|
||||
|
||||
\omitvalue TemporarilyCachedBindOption Used by paint engines on some
|
||||
\omitvalue TemporarilyCachedBindOption \omit Used by paint engines on some
|
||||
platforms to indicate that the pixmap or image texture is possibly
|
||||
cached only temporarily and must be destroyed immediately after the use.
|
||||
cached only temporarily and must be destroyed immediately after the use. \endomit
|
||||
|
||||
\omitvalue InternalBindOption
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user