aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Tapsell <john.tapsell.ext@basyskom.de>2010-08-30 21:50:23 +0900
committerSergiy Dubovik <sergiy.dubovik@nokia.com>2010-08-31 10:50:50 +0300
commit2048d5fe3b5ae84c38c18ccacd39ebc88c610619 (patch)
treed5c1b925eb36360f26074b0ea313baf24232542c
parent2da98f2e263c6751b4587d496fa4fc9cf2d0b5e6 (diff)
Changes: Doxygen syntax fixes
RevBy: TrustMe Details: Fix incorrect doxygen tag usage.
-rw-r--r--examples/layout/layout_inside_layout/layout_inside_layout.dox12
-rw-r--r--src/corelib/animation/widget/mwidgetfadeanimation.h2
-rw-r--r--src/corelib/i18n/mlocale.cpp2
-rw-r--r--src/corelib/i18n/mlocale.h8
-rw-r--r--src/corelib/layout/mlayout.h9
-rw-r--r--src/corelib/layout/mlinearlayoutpolicy.h4
-rw-r--r--src/corelib/scene/mscenelayereffect.h2
-rw-r--r--src/corelib/servicefwif/include/mservicefwproxy.h1
-rw-r--r--src/corelib/style/mstylesheet.h2
-rw-r--r--src/corelib/theme/mtheme.h2
-rw-r--r--src/corelib/widgets/core/mwidget.h1
-rw-r--r--src/corelib/widgets/core/mwidgetcontroller.h2
-rw-r--r--src/views/msliderview.h4
-rw-r--r--src/views/mspinnerview.h4
-rw-r--r--src/views/style/mbubbleitembackgroundstyle.h6
-rw-r--r--src/views/style/mbubbleitemstyle.h6
-rw-r--r--src/views/style/mcontainerheaderstyle.h5
17 files changed, 26 insertions, 46 deletions
diff --git a/examples/layout/layout_inside_layout/layout_inside_layout.dox b/examples/layout/layout_inside_layout/layout_inside_layout.dox
index 578cd4dc..986656ef 100644
--- a/examples/layout/layout_inside_layout/layout_inside_layout.dox
+++ b/examples/layout/layout_inside_layout/layout_inside_layout.dox
@@ -1,9 +1,9 @@
/**
-\page layout-inside-layout Hiding a QGraphicsLayout or DuiLayout
+\page layout-inside-layout Hiding a QGraphicsLayout or MLayout
-Source code for a simple example showing how do hide a DuiLayout or QGraphicsLayout.
+Source code for a simple example showing how do hide a MLayout or QGraphicsLayout.
-A DuiLayout or QGraphicsLayout should always be attached to QGraphicsWidget (or DuiWidget) or inside another layout.
+A MLayout or QGraphicsLayout should always be attached to QGraphicsWidget (or MWidget) or inside another layout.
If you place a layout inside of another layout, the inner layout cannot be hidden, because a layout by
itself cannot be hidden (There is no hide() function in QGraphicsLayout). Likewise if you remove the inner layout,
it will remain visible because it needs to be attached to something.
@@ -17,12 +17,12 @@ a QGraphicsWidget, then place that QGraphicsWidget inside of the outer layout.
\image html layout_inside_layout_portrait.png
Source code of layout_inside_layout.cpp:
-\include examples/layout_inside_layout/layout_inside_layout.cpp
+\include layout_inside_layout/layout_inside_layout.cpp
Styled with the following layout_inside_layout.css file:
-\include examples/layout_inside_layout/layout_inside_layout.css
+\include layout_inside_layout/layout_inside_layout.css
And compiled with the following layout_inside_layout.pro file:
-\include examples/layout_inside_layout/layout_inside_layout.pro
+\include layout_inside_layout/layout_inside_layout.pro
*/
diff --git a/src/corelib/animation/widget/mwidgetfadeanimation.h b/src/corelib/animation/widget/mwidgetfadeanimation.h
index dcff20a2..2aac8efe 100644
--- a/src/corelib/animation/widget/mwidgetfadeanimation.h
+++ b/src/corelib/animation/widget/mwidgetfadeanimation.h
@@ -68,6 +68,6 @@ protected:
virtual void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState);
//! \reimp_end
};
-//! \internal
+//! \internal_end
#endif
diff --git a/src/corelib/i18n/mlocale.cpp b/src/corelib/i18n/mlocale.cpp
index fcd64947..ab6bdf9c 100644
--- a/src/corelib/i18n/mlocale.cpp
+++ b/src/corelib/i18n/mlocale.cpp
@@ -157,7 +157,7 @@ public:
private:
MTranslationCatalog &operator=(const MTranslationCatalog &other);
};
-//! \endinternal
+//! \internal_end
// //////
// MTranslationCatalog implementation
diff --git a/src/corelib/i18n/mlocale.h b/src/corelib/i18n/mlocale.h
index 2eec708d..912c1920 100644
--- a/src/corelib/i18n/mlocale.h
+++ b/src/corelib/i18n/mlocale.h
@@ -294,7 +294,7 @@ public:
* <td></td>
* <td>Finnish language in Finland, default sorting order</td>
* <tr>
- * <td>fi_FI@collation=phonebook</td>
+ * <td>fi_FI\@collation=phonebook</td>
* <td>fi</td>
* <td></td>
* <td>FI</td>
@@ -303,7 +303,7 @@ public:
* <td>Finnish language in Finland, phonebook sorting order</td>
* </tr>
* <tr>
- * <td>zh_CN@collation=stroke;calendar=chinese</td>
+ * <td>zh_CN\@collation=stroke;calendar=chinese</td>
* <td>zh</td>
* <td></td>
* <td>CN</td>
@@ -535,8 +535,8 @@ public:
* an empty string is returned.
*
* Example:
- * If the locale name is “sr_Latn_RS_REVISED@currency=USD”
- * this will return “REVISED”.
+ * If the locale name is <code>sr_Latn_RS_REVISED\@currency=USD</code>
+ * this will return <code>REVISED</code>.
*
* \sa name()
* \sa language()
diff --git a/src/corelib/layout/mlayout.h b/src/corelib/layout/mlayout.h
index 27056375..702ab317 100644
--- a/src/corelib/layout/mlayout.h
+++ b/src/corelib/layout/mlayout.h
@@ -190,14 +190,9 @@ public:
*/
virtual void invalidate();
- /*!
- * \deprecate Policies should use MAbstractLayoutPolicy::invalidate instead. Since 0.19
- * \brief Invalidate the current layout information for the layout only - not the policy.
- *
- * This is used by policies to invalidate the layout without causing the layout to then invalidate the policy
- * and causing an infinite recursion.
- */
+ /*! \internal */
void Q_DECL_DEPRECATED invalidateLayoutOnly();
+ /*! \internal_end */
// QGraphicsLayoutItem:
/*!
diff --git a/src/corelib/layout/mlinearlayoutpolicy.h b/src/corelib/layout/mlinearlayoutpolicy.h
index d85992db..0076ddfd 100644
--- a/src/corelib/layout/mlinearlayoutpolicy.h
+++ b/src/corelib/layout/mlinearlayoutpolicy.h
@@ -163,7 +163,6 @@ public:
* Note that the order of the items in the policy is independent of the order of the items
* in the MLayout.
*
- * @param item The item to add.
*/
void addItem(QGraphicsLayoutItem *item, Qt::Alignment alignment);
@@ -186,9 +185,6 @@ public:
*
* Note that the order of the items in the policy is independent of the order of the items
* in the MLayout.
- *
- * @param item The item to insert.
- * @param index The index to place the item
*/
void insertItem(int index, QGraphicsLayoutItem *item, Qt::Alignment alignment);
diff --git a/src/corelib/scene/mscenelayereffect.h b/src/corelib/scene/mscenelayereffect.h
index 5e064c3e..9cb6e641 100644
--- a/src/corelib/scene/mscenelayereffect.h
+++ b/src/corelib/scene/mscenelayereffect.h
@@ -48,5 +48,5 @@ private:
Q_DECLARE_PRIVATE(MSceneLayerEffect)
};
-//! \internal
+//! \internal_end
#endif
diff --git a/src/corelib/servicefwif/include/mservicefwproxy.h b/src/corelib/servicefwif/include/mservicefwproxy.h
index 18a3c0ef..d54bcc5a 100644
--- a/src/corelib/servicefwif/include/mservicefwproxy.h
+++ b/src/corelib/servicefwif/include/mservicefwproxy.h
@@ -75,4 +75,3 @@ namespace com
}
}
#endif
-//! \endcond
diff --git a/src/corelib/style/mstylesheet.h b/src/corelib/style/mstylesheet.h
index c827899d..0eeaa4d9 100644
--- a/src/corelib/style/mstylesheet.h
+++ b/src/corelib/style/mstylesheet.h
@@ -87,7 +87,7 @@ public:
/*!
* \brief Cleans up the cache
- * \param output If true, outputs warnings from remaining cached styles and deletes them
+ * \param outputAndDelete If true, outputs warnings from remaining cached styles and deletes them
*/
static void cleanup(bool outputAndDelete);
};
diff --git a/src/corelib/theme/mtheme.h b/src/corelib/theme/mtheme.h
index 15bbcb0e..322e79f2 100644
--- a/src/corelib/theme/mtheme.h
+++ b/src/corelib/theme/mtheme.h
@@ -275,7 +275,7 @@ public:
Loads the requested CSS file to the current active theme.
Either appends to or replaces the existing theme CSS using the style
- sheet located by \a filename, depending on the \mode. The method
+ sheet located by \a filename, depending on the \a mode. The method
returns true if the CSS file was successfully loaded.
Note that CSS files should be loaded before constructing the style objects.
diff --git a/src/corelib/widgets/core/mwidget.h b/src/corelib/widgets/core/mwidget.h
index 57a6f631..b01476fc 100644
--- a/src/corelib/widgets/core/mwidget.h
+++ b/src/corelib/widgets/core/mwidget.h
@@ -237,7 +237,6 @@ protected:
be handled.
*/
virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
- /*! \reimp_end */
/*!
This virtual function is called when this widget received a
diff --git a/src/corelib/widgets/core/mwidgetcontroller.h b/src/corelib/widgets/core/mwidgetcontroller.h
index 915958e7..3a02f410 100644
--- a/src/corelib/widgets/core/mwidgetcontroller.h
+++ b/src/corelib/widgets/core/mwidgetcontroller.h
@@ -72,7 +72,7 @@ public:
/*!
Creates a new MWidgetController with the given \a model and \a parent.
- If \model is 0, a MWidgetModel will be created.
+ If \a model is 0, a MWidgetModel will be created.
*/
explicit MWidgetController(MWidgetModel *model, QGraphicsItem *parent = 0);
diff --git a/src/views/msliderview.h b/src/views/msliderview.h
index ca9e07ba..953b2b12 100644
--- a/src/views/msliderview.h
+++ b/src/views/msliderview.h
@@ -63,7 +63,7 @@ class M_EXPORT MSliderView : public MWidgetView
public:
/*!
\brief Constructs toolbar view.
- \param Pointer to the controller.
+ \param controller Pointer to the controller.
*/
MSliderView(MSlider *controller);
@@ -128,7 +128,7 @@ protected:
/*!
\brief Updates MSliderView class instance when some component
of underlying model is modified.
- \param List containing the names of modified model components.
+ \param modifications List containing the names of modified model components.
Called when some field of underlying MSliderModel (MSeekBarModel)
class instance is modified and view shuold reflect that modification.
diff --git a/src/views/mspinnerview.h b/src/views/mspinnerview.h
index ee965ccf..97572f33 100644
--- a/src/views/mspinnerview.h
+++ b/src/views/mspinnerview.h
@@ -35,8 +35,6 @@ class QTimerEvent;
\ingroup views
- \tableofcontents
-
\section SpinnerOverview Overview
Spinner rotates clockwise indefinitely until the process is finished or interrupted. Spinner is
used only for unknown durations. It can can be placed anywhere in UI and also on top of other UI
@@ -105,7 +103,7 @@ protected Q_SLOTS:
/*!
\brief Updates MSpinnerView class instance when some component
of underlying model is modified.
- \param List containing the names of modified model components.
+ \param modifications List containing the names of modified model components.
*/
virtual void updateData(const QList<const char *>& modifications);
diff --git a/src/views/style/mbubbleitembackgroundstyle.h b/src/views/style/mbubbleitembackgroundstyle.h
index 1611c530..f0264e7d 100644
--- a/src/views/style/mbubbleitembackgroundstyle.h
+++ b/src/views/style/mbubbleitembackgroundstyle.h
@@ -34,10 +34,6 @@ class M_EXPORT MBubbleItemBackgroundStyle : public MWidgetStyle
M_STYLE_ATTRIBUTE(QString, mirroredObjectName, MirroredObjectName)
};
-/*!
- * \internal
- */
-
class M_EXPORT MBubbleItemBackgroundStyleContainer : public MWidgetStyleContainer
{
M_STYLE_CONTAINER(MBubbleItemBackgroundStyle)
@@ -48,5 +44,7 @@ class M_EXPORT MBubbleItemBackgroundStyleContainer : public MWidgetStyleContaine
M_STYLE_MODE(IncomingPressed)
};
+/*! \internal_end */
+
#endif
diff --git a/src/views/style/mbubbleitemstyle.h b/src/views/style/mbubbleitemstyle.h
index af3ad2f0..7bdcd205 100644
--- a/src/views/style/mbubbleitemstyle.h
+++ b/src/views/style/mbubbleitemstyle.h
@@ -41,10 +41,6 @@ class M_EXPORT MBubbleItemStyle : public MWidgetStyle
M_STYLE_ATTRIBUTE(QString, bubbleObjectName, BubbleObjectName)
};
-/*!
- * \internal
- */
-
class M_EXPORT MBubbleItemStyleContainer : public MWidgetStyleContainer
{
M_STYLE_CONTAINER(MBubbleItemStyle)
@@ -52,4 +48,6 @@ class M_EXPORT MBubbleItemStyleContainer : public MWidgetStyleContainer
M_STYLE_MODE(Outgoing)
};
+/*! \internal_end */
+
#endif // MBUBBLEITEMSTYLE_H
diff --git a/src/views/style/mcontainerheaderstyle.h b/src/views/style/mcontainerheaderstyle.h
index 24cd1d18..9840acba 100644
--- a/src/views/style/mcontainerheaderstyle.h
+++ b/src/views/style/mcontainerheaderstyle.h
@@ -34,15 +34,12 @@ class M_EXPORT MContainerHeaderStyle : public MWidgetStyle
M_STYLE(MContainerHeaderStyle)
};
-/*!
- * \internal
- */
-
class M_EXPORT MContainerHeaderStyleContainer : public MWidgetStyleContainer
{
M_STYLE_CONTAINER(MContainerHeaderStyle)
M_STYLE_MODE(Pressed)
};
+/*! \internal_end */
#endif // MCONTAINERHEADERSTYLE_H