Fix documentation generation

Task-number: QTBUG-36985
Change-Id: I9e6a6fdc3fa4802f690317782b054151a8f6087d
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

4 files changed, 33 insertions, 14 deletions

diff --git a/src/macextras/qmacfunctions.mm b/src/macextras/qmacfunctions.mm
index 8305ecc..5758cbb 100644
--- a/src/macextras/qmacfunctions.mm
+++ b/src/macextras/qmacfunctions.mm
@@ -52,15 +52,23 @@ QT_BEGIN_NAMESPACE
     \namespace QtMac
     \inmodule QtMacExtras
     \since 5.2
-    \brief The QtMac namespace contains miscellaneous functionality specific to the OS X operating system.
+    \brief The QtMac namespace contains miscellaneous functionality specific to the OS X and iOS operating systems.
     \inheaderfile QtMac
  */
+
+/*!
+    \fn CGContextRef QtMac::currentCGContext()
+
+    Returns the current CoreGraphics context.
+*/
+
 namespace QtMac
 {
 
 #if QT_DEPRECATED_SINCE(5,3)
 /*!
     \obsolete
+    \fn NSData* QtMac::toNSData(const QByteArray &data)
 
     Use QByteArray::toNSData() instead.
  */
@@ -71,6 +79,7 @@ NSData* toNSData(const QByteArray &data)
 
 /*!
     \obsolete
+    \fn QByteArray QtMac::fromNSData(const NSData *data)
 
     Use QByteArray::fromNSData() instead.
  */
@@ -84,7 +93,9 @@ QByteArray fromNSData(const NSData *data)
 #endif // QT_DEPRECATED_SINCE
 
 /*!
-    Creates a \c CGImageRef equivalent to the QPixmap. Returns the \c CGImageRef handle.
+    \fn CGImageRef QtMac::toCGImageRef(const QPixmap &pixmap)
+
+    Creates a \c CGImageRef equivalent to the QPixmap \a pixmap. Returns the \c CGImageRef handle.
 
     It is the caller's responsibility to release the \c CGImageRef data
     after use.
@@ -109,6 +120,8 @@ CGImageRef toCGImageRef(const QPixmap &pixmap)
 }
 
 /*!
+    \fn QPixmap QtMac::fromCGImageRef(CGImageRef image)
+
     Returns a QPixmap that is equivalent to the given \a image.
 
     This function is not available in Qt 5.x until 5.0.2 and will return a null pixmap in earlier versions.
diff --git a/src/macextras/qmacfunctions_ios.mm b/src/macextras/qmacfunctions_ios.mm
index 14b1cba..fe376a1 100644
--- a/src/macextras/qmacfunctions_ios.mm
+++ b/src/macextras/qmacfunctions_ios.mm
@@ -41,16 +41,15 @@ QT_BEGIN_NAMESPACE
 namespace QtMac
 {
 
-/*!
-    Returns the current CoreGraphics context.
-*/
 CGContextRef currentCGContext()
 {
     return UIGraphicsGetCurrentContext();
 }
 
 /*!
-    Sets the value shown on the application icon a.k.a badge.
+    \fn void QtMac::setApplicationIconBadgeNumber(int number)
+
+    Sets the value shown on the application icon a.k.a badge to \a number.
 
     Unlike its OS X counterpart, only numbers can be used.
 
@@ -62,6 +61,8 @@ void setApplicationIconBadgeNumber(int number)
 }
 
 /*!
+    \fn int QtMac::applicationIconBadgeNumber()
+
     Returns the value of the application icon a.k.a badge.
 
     \sa setApplicationIconBadgeNumber(), badgeLabelText()
diff --git a/src/macextras/qmacfunctions_mac.mm b/src/macextras/qmacfunctions_mac.mm
index 99515c1..6f471ad 100644
--- a/src/macextras/qmacfunctions_mac.mm
+++ b/src/macextras/qmacfunctions_mac.mm
@@ -52,7 +52,9 @@ namespace QtMac
 {
 
 /*!
-    Creates an \c NSImage equivalent to the QPixmap. Returns the \c NSImage handle.
+    \fn NSImage* QtMac::toNSImage(const QPixmap &pixmap)
+
+    Creates an \c NSImage equivalent to the QPixmap \a pixmap. Returns the \c NSImage handle.
 
     It is the caller's responsibility to release the \c NSImage data
     after use.
@@ -72,7 +74,9 @@ NSImage* toNSImage(const QPixmap &pixmap)
 
 #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
 /*!
-    Returns whether the given QWindow is the application's main window
+    \fn bool QtMac::isMainWindow(QWindow *window)
+
+    Returns whether the given QWindow \a window is the application's main window
 */
 bool isMainWindow(QWindow *window)
 {
@@ -85,16 +89,15 @@ bool isMainWindow(QWindow *window)
 }
 #endif
 
-/*!
-    Returns the current CoreGraphics context.
-*/
 CGContextRef currentCGContext()
 {
     return reinterpret_cast<CGContextRef>([[NSGraphicsContext currentContext] graphicsPort]);
 }
 
 /*!
-    Sets the text shown on the application icon a.k.a badge.
+    \fn void QtMac::setBadgeLabelText(const QString &text)
+
+    Sets the \a text shown on the application icon a.k.a badge.
 
     This is generally used with numbers (e.g. number of unread emails); it can also show a string.
 
@@ -106,9 +109,11 @@ void setBadgeLabelText(const QString &text)
 }
 
 /*!
+    \fn QString QtMac::badgeLabelText()
+
     Returns the text of the application icon a.k.a badge.
 
-    \sa setBadgeText()
+    \sa setBadgeLabelText()
 */
 QString badgeLabelText()
 {
diff --git a/src/macextras/qmactoolbar.mm b/src/macextras/qmactoolbar.mm
index 7e11c62..5c05876 100644
--- a/src/macextras/qmactoolbar.mm
+++ b/src/macextras/qmactoolbar.mm
@@ -196,7 +196,7 @@ QList<QMacToolBarItem *> QMacToolBar::items()
 }
 
 /*!
-    Sets the list of toolbar items shown on the the toolbar customization menu.
+    Sets the list of toolbar items shown on the toolbar customization menu to \a allowedItems.
 */
 void QMacToolBar::setAllowedItems(QList<QMacToolBarItem *> &allowedItems)
 {