Doxymentation

Author: m-kuhn

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

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
 

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