more documentation; refs #115

src/browser.hxx

@@ -50,6 +50,9 @@
 #define LOG qDebug()<<__PRETTY_FUNCTION__
 #endif
 
+//! @addtogroup browser
+//! @{
+
 class Browser: public QMainWindow, protected Ui::Browser {
 
     Q_OBJECT;
@@ -1573,4 +1576,6 @@ class Browser: public QMainWindow, protected Ui::Browser {
     ButtonLineEdit* _search;
     QComboBox* _searchEngines;
 };
+
+//! @}
 #endif

src/designer/webviewwidgetifc.cxx

@@ -7,4 +7,9 @@
 
 #include <webviewwidgetifc.hxx>
 
+//! @defgroup designer
+//! @{
+
 Q_EXPORT_PLUGIN2(swisswebviewwidgetplugin, SwissWebViewWidgetIfc);
+
+//! @}

src/designer/webviewwidgetifc.hxx

@@ -11,7 +11,12 @@
 #include <qbrowserlib/swisswebview.hxx>
 #include <QtDesigner>
 
+#ifndef LOG
 #define LOG qDebug()<<__PRETTY_FUNCTION__
+#endif
+
+//! @defgroup designer
+//! @{
 
 //! WebView widget for Qt Designer
 class SwissWebViewWidgetIfc: public QObject,
@@ -68,4 +73,5 @@ class SwissWebViewWidgetIfc: public QObject,
     }
 };
 
+//! @}
 #endif

src/main.cxx

@@ -26,6 +26,23 @@
 
 #include <memory>
 
+/*! @mainpage The Secure Swiss PKCS#11 WebBrowser
+
+    The browser is divided into a library, qbrowserlib that implements
+    generic browsing utilities, the main browser page that collects
+    those features into a main window, a PKCS#11 Post-SuisseID
+    hardware token client authentication and a designer plugin for
+    flexible GUI creation.
+    */
+
+//! @defgroup browser The SwissBrowser Executable and Main Window
+//! @defgroup pkcs11 The PKCS#11 Client Authentication
+//! @defgroup qbrowserlib The Swiss Browser Library
+//! @defgroup designer Qt Designer Plugin for Browser Related Widgets
+
+//! @addtogroup browser
+//! @{
+
 const QByteArray SWISSSIGN_EV_GOLD_CA_2009_G2
     ("-----BEGIN CERTIFICATE-----\n"
      "MIIGvzCCBaegAwIBAgIQAPI39KUS4aGJo+mkR4+YuTANBgkqhkiG9w0BAQUFADBN\n"
@@ -413,3 +430,5 @@ int main(int argv, char** argc) try {
   std::cerr<<"**** Error"<<std::endl;
   return 1;
  }
+
+//! @}

src/qbrowserlib/pluginfactory.hxx

@@ -16,6 +16,9 @@
 #define LOG qDebug()<<__PRETTY_FUNCTION__
 #endif
 
+//! @addtogroup qbrowserlib
+//! @{
+
 class PluginFactory: public QWebPluginFactory {
   public:
     PluginFactory(QObject* p=0): QWebPluginFactory(p) {
@@ -53,4 +56,5 @@ class PluginFactory: public QWebPluginFactory {
     QList<Plugin> _plugins;
 };
 
+//! @}
 #endif

src/qbrowserlib/saveorrun.hxx

@@ -23,6 +23,9 @@
 #define LOG qDebug()<<__PRETTY_FUNCTION__
 #endif
 
+//! @addtogroup qbrowserlib
+//! @{
+
 class SaveOrRun: public QWidget, public Ui::SaveOrRun {
     Q_OBJECT;
 
@@ -206,4 +209,6 @@ class SaveOrRunDialog: public QDialog {
     
 };
 
+//! @}
+
 #endif

src/qbrowserlib/swisswebpage.hxx

@@ -18,6 +18,9 @@
 #define LOG qDebug()<<__PRETTY_FUNCTION__
 #endif
 
+//! @addtogroup qbrowserlib
+//! @{
+
 //! QWebPage with additional features and better default behaviour.
 /*! SwissWebPage is designed to be used by SwissWebView.
 
@@ -65,4 +68,5 @@ class SwissWebPage: public QWebPage {
     }
 };
 
+//! @}
 #endif

src/qbrowserlib/swisswebview.hxx

@@ -15,6 +15,9 @@
 
 #include <memory>
 
+//! @addtogroup qbrowserlib
+//! @{
+
 //! QWebViev class with additional features.
 /*! This QWebView class contains a @ref SwissWebPage and adds a new
     signal @refs newView that sends the view whenever the a new view
@@ -61,4 +64,5 @@ class QDESIGNER_WIDGET_EXPORT SwissWebView: public QWebView {
     }
 };
 
+//! @}
 #endif

src/sslclientnetworkmanager.hxx

@@ -4,6 +4,9 @@
 */
 //       1         2         3         4         5         6         7         8
 // 45678901234567890123456789012345678901234567890123456789012345678901234567890
+#ifndef SSLCLIENTNETWORKMANAGER_HXX
+#define SSLCLIENTNETWORKMANAGER_HXX
+
 #include <QtNetwork/QNetworkReply>
 #include <QtNetwork/QNetworkAccessManager>
 #include <smartcardauth.hxx>
@@ -13,6 +16,8 @@
 #define LOG qDebug()<<__PRETTY_FUNCTION__
 #endif
 
+//! @addtogroup pkcs11
+//! @{
 class SslClientAuthNetworkAccessManager: public QNetworkAccessManager {
     Q_OBJECT;
   public:
@@ -56,3 +61,6 @@ class SslClientAuthNetworkAccessManager: public QNetworkAccessManager {
     std::auto_ptr<SmartCardAuth> _scAuth;
 
 };
+
+//! @}
+#endif