Add samples to doxygen group 'samples' and subgroups

refs #594

samples/weatherdata/main.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleweatherdata
+
 #include "reader.h"
 #include "weatherdataprinter.h"
 #include "blackmisc/registermetadata.h"

samples/weatherdata/reader.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleweatherdata
+
 #include "reader.h"
 #include <QFile>
 #include <QRegularExpression>

samples/weatherdata/reader.h

@@ -7,11 +7,12 @@
  * contained in the LICENSE file.
  */
 
-//! \file
-
 #ifndef BLACKSAMPLE_WEATHERDATA_LINEREADER_H
 #define BLACKSAMPLE_WEATHERDATA_LINEREADER_H
 
+//! \file
+//! \ingroup sampleweatherdata
+
 #include "blackmisc/geo/latitude.h"
 #include "blackmisc/geo/longitude.h"
 #include <QThread>

samples/weatherdata/sampleweatherdata.h

@@ -0,0 +1,29 @@
+/* Copyright (C) 2014
+ * swift Project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+#ifndef BLACKSAMPLE_WEATHERDATA_H
+#define BLACKSAMPLE_WEATHERDATA_H
+
+//! \file
+//! \ingroup sampleweatherdata
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup sampleweatherdata Sample Weather Data
+ * \ingroup samples
+ * \brief Sample demonstrating how to download and use weather data
+ *        through the IWeatherData plugins.
+ *
+ *        After startup it will accept input by latitude and longitude
+ *        and print the current weather status received from all installed
+ *        and loaded weather plugins.
+ */
+
+#endif

samples/weatherdata/weatherdataprinter.cpp

@@ -2,6 +2,9 @@
 #include "blackmisc/logmessage.h"
 #include <QTextStream>
 
+//! \file
+//! \ingroup sampleweatherdata
+
 using namespace BlackMisc;
 using namespace BlackMisc::Weather;
 using namespace BlackMisc::Geo;

samples/weatherdata/weatherdataprinter.h

@@ -10,6 +10,9 @@
 #ifndef BLACKSAMPLE_WEATERDATA_WEATHERDATAPRINTER_H
 #define BLACKSAMPLE_WEATERDATA_WEATHERDATAPRINTER_H
 
+//! \file
+//! \ingroup sampleweatherdata
+
 #include "blackcore/pluginmanagerweatherdata.h"
 #include "blackcore/weatherdata.h"
 #include "blackmisc/geo/latitude.h"