From 6075442439a1bd21d5a812a167dea2ef6b8526b7 Mon Sep 17 00:00:00 2001
From: Matthias Kuhn <matthias.kuhn@gmx.ch>
Date: Fri, 22 May 2015 10:27:14 +0200
Subject: [PATCH] Doxymentation

---
 src/core/qgswebframe.h |  6 ++++++
 src/core/qgswebpage.h  | 13 +++++++++++++
 src/core/qgswebview.h  | 12 ++++++++++++
 3 files changed, 31 insertions(+)

diff --git a/src/core/qgswebframe.h b/src/core/qgswebframe.h
index 5e17922ca8c..8643ef85179 100644
--- a/src/core/qgswebframe.h
+++ b/src/core/qgswebframe.h
@@ -24,8 +24,13 @@
 #include <QPainter>
 #include <QUrl>
 
+/**
+ * @brief The QWebFrame class is a collection of stubs to mimic the API of a QWebFrame on systems
+ * where QtWebkit is not available.
+ */
 class CORE_EXPORT QWebFrame : public QObject
 {
+/// @cond
     Q_OBJECT
 
   public:
@@ -69,6 +74,7 @@ class CORE_EXPORT QWebFrame : public QObject
 
   signals:
     void javaScriptWindowObjectCleared();
+/// @endcond
 };
 #endif
 #endif // QGSWEBFRAME_H
diff --git a/src/core/qgswebpage.h b/src/core/qgswebpage.h
index aa34958b317..7feb5b98953 100644
--- a/src/core/qgswebpage.h
+++ b/src/core/qgswebpage.h
@@ -28,8 +28,14 @@
 #include <QNetworkAccessManager>
 #include <QPalette>
 
+
+/**
+ * @brief The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems
+ * where QtWebkit is not available.
+ */
 class CORE_EXPORT QWebSettings : public QObject
 {
+/// @cond
     Q_OBJECT
 
   public:
@@ -83,10 +89,16 @@ class CORE_EXPORT QWebSettings : public QObject
     {
       Q_UNUSED( on );
     }
+/// @endcond
 };
 
+/**
+ * @brief The QWebPage class is a collection of stubs to mimic the API of a QWebPage on systems
+ * where QtWebkit is not available.
+ */
 class QWebPage : public QObject
 {
+/// @cond
     Q_OBJECT
 
   public:
@@ -166,6 +178,7 @@ class QWebPage : public QObject
   private:
     QWebSettings* mSettings;
     QWebFrame* mFrame;
+/// @endcond
 };
 #endif
 
diff --git a/src/core/qgswebview.h b/src/core/qgswebview.h
index ac55290618e..ca0fa6caec7 100644
--- a/src/core/qgswebview.h
+++ b/src/core/qgswebview.h
@@ -34,8 +34,18 @@ class CORE_EXPORT QgsWebView : public QWebView
 #else
 #include "qgswebpage.h"
 
+/**
+ * @brief The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real
+ * library is not available. It should be used instead of QWebView inside QGIS.
+ *
+ * If QGIS is compiled WITH_QTWEBKIT This will simply be a subclass of QWebView. If it is compiled with
+ * WITH_QTWEBKIT=OFF then this will be an empty QWidget. If you miss methods in here that you would like to use,
+ * please add additional stubs.
+ */
 class CORE_EXPORT QgsWebView : public QWidget
 {
+
+/// @cond
     Q_OBJECT
   public:
     explicit QgsWebView( QWidget *parent = 0 )
@@ -99,6 +109,8 @@ class CORE_EXPORT QgsWebView : public QWidget
   private:
     QWebSettings* mSettings;
     QWebPage* mPage;
+
+/// @endcond
 };
 #endif