Add samples to doxygen group 'samples' and subgroups

refs #594

samples/blackmisc/main.cpp

@@ -18,6 +18,9 @@
 #include "blackmisc/registermetadata.h"
 #include "blackmisc/pq/pq.h"
 
+//! \file
+//! \ingroup sampleblackmisc
+
 using namespace BlackMisc;
 using namespace BlackSample;
 

samples/blackmisc/sampleblackmisc.h

@@ -0,0 +1,26 @@
+/* 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_BLACKMISC_H
+#define BLACKSAMPLE_BLACKMISC_H
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup sampleblackmisc Sample BlackMisc
+ * \ingroup samples
+ * \brief Sample demonstrating how use some of the BlackMisc classes
+ *        - Algorithms
+ *        - Containers
+ *        - Json
+ *        - Metadata
+ *        - Performance
+ */
+
+#endif

samples/blackmisc/samplesalgorithm.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmisc
+
 #include "samplesalgorithm.h"
 #include "blackmisc/algorithm.h"
 #include "blackmisc/sequence.h"

samples/blackmisc/samplesalgorithm.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESALGORITHM_H
 #define BLACKSAMPLE_SAMPLESALGORITHM_H

samples/blackmisc/sampleschangeobject.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmisc
+
 #include "sampleschangeobject.h"
 #include "blackmisc/pq/constants.h"
 #include "blackmisc/aviation/heading.h"

samples/blackmisc/sampleschangeobject.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESCHANGEDATA_H
 #define BLACKSAMPLE_SAMPLESCHANGEDATA_H

samples/blackmisc/samplescontainer.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmisc
+
 #include "samplescontainer.h"
 #include "blackmisc/blackmiscfreefunctions.h"
 #include "blackmisc/aviation/atcstationlist.h"

samples/blackmisc/samplescontainer.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESCONTAINER_H
 #define BLACKSAMPLE_SAMPLESCONTAINER_H

samples/blackmisc/samplesjson.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmisc
+
 #include "samplesjson.h"
 #include "blackmisc/aviation/atcstationlist.h"
 #include "blackmisc/simulation/simulatedaircraft.h"

samples/blackmisc/samplesjson.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESJSON_H
 #define BLACKSAMPLE_SAMPLESJSON_H

samples/blackmisc/samplesmetadata.cpp

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

samples/blackmisc/samplesmetadata.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESMETADATA_H
 #define BLACKSAMPLE_SAMPLESMETADATA_H

samples/blackmisc/samplesperformance.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmisc
+
 #include "samplesperformance.h"
 #include "blackmisc/aviation/aircraftsituationlist.h"
 #include "blackmisc/geo/coordinategeodetic.h"

samples/blackmisc/samplesperformance.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmisc
 
 #ifndef BLACKSAMPLE_SAMPLESPERFORMANCE_H
 #define BLACKSAMPLE_SAMPLESPERFORMANCE_H

samples/blackmiscdbus/main.cpp

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

samples/blackmiscdbus/sampleblackmiscdbus.h

@@ -0,0 +1,22 @@
+/* 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_BLACKMISCDBUS_H
+#define BLACKSAMPLE_BLACKMISCDBUS_H
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup sampleblackmiscdbus Sample BlackMisc DBus
+ * \ingroup samples
+ * DBus tests, tests marshalling / unmarshalling of many value classes.
+ * Forks two processes and sends data via DBus among them.
+ */
+
+#endif

samples/blackmiscdbus/servicetool.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscdbus
+
 #include "servicetool.h"
 #include "testservice.h"
 #include "testserviceinterface.h"

samples/blackmiscdbus/servicetool.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscdbus
 
 #ifndef BLACKSAMPLE_SERVICETOOL_H
 #define BLACKSAMPLE_SERVICETOOL_H

samples/blackmiscdbus/testservice.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscdbus
+
 #include "testservice.h"
 #include "blackmisc/blackmiscfreefunctions.h"
 

samples/blackmiscdbus/testservice.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscdbus
 
 #ifndef BLACKSAMPLE_TESTSERVICE_H
 #define BLACKSAMPLE_TESTSERVICE_H

samples/blackmiscdbus/testserviceinterface.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscdbus
+
 #include "testserviceinterface.h"
 
 namespace BlackSample

samples/blackmiscdbus/testserviceinterface.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscdbus
 
 #ifndef BLACKSAMPLE_TESTSERVICE_INTERFACE_H
 #define BLACKSAMPLE_TESTSERVICE_INTERFACE_H

samples/blackmiscquantities/main.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscquantities
+
 #include "samplesphysicalquantities.h"
 #include "samplesaviation.h"
 #include "samplesgeo.h"

samples/blackmiscquantities/sampleblackmiscquantities.h

@@ -0,0 +1,24 @@
+/* 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_BLACKMISCQUANTITIES_H
+#define BLACKSAMPLE_BLACKMISCQUANTITIES_H
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup sampleblackmiscquantities Sample BlackMisc Quantities
+ * \ingroup samples
+ * \brief Sample demonstrating how use some of the BlackMisc classes
+ *        - Aviation
+ *        - Geo
+ *        - PhysicalQuantities
+ */
+
+#endif

samples/blackmiscquantities/samplesaviation.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscquantities
+
 #include "samplesaviation.h"
 #include "blackmisc/pq/constants.h"
 #include "blackmisc/aviation/heading.h"

samples/blackmiscquantities/samplesaviation.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscquantities
 
 #ifndef BLACKSAMPLE_SAMPLESAVIATION_H
 #define BLACKSAMPLE_SAMPLESAVIATION_H

samples/blackmiscquantities/samplesgeo.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscquantities
+
 #include "samplesgeo.h"
 #include "blackmisc/geo/coordinategeodetic.h"
 #include "blackmisc/aviation/altitude.h"

samples/blackmiscquantities/samplesgeo.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscquantities
 
 #ifndef BLACKSAMPLE_SAMPLESGEO_H
 #define BLACKSAMPLE_SAMPLESGEO_H

samples/blackmiscquantities/samplesphysicalquantities.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscquantities
+
 #include "samplesphysicalquantities.h"
 #include "blackmisc/variant.h"
 

samples/blackmiscquantities/samplesphysicalquantities.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscquantities
 
 #ifndef BLACKSAMPLE_SAMPLESPHYSICALQUANTITIES_H
 #define BLACKSAMPLE_SAMPLESPHYSICALQUANTITIES_H

samples/blackmiscsim/main.cpp

@@ -18,6 +18,9 @@
 #include <QDebug>
 #include <QTime>
 
+//! \file
+//! \ingroup sampleblackmiscsim
+
 //! main
 int main(int argc, char *argv[])
 {

samples/blackmiscsim/sampleblackmiscsim.h

@@ -0,0 +1,25 @@
+/* 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_BLACKMISCSIM_H
+#define BLACKSAMPLE_BLACKMISCSIM_H
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup sampleblackmiscsim Sample BlackMisc Sim
+ * \ingroup samples
+ * \brief Sample demonstrating how use some of the BlackMisc classes
+ *        - FsCommon
+ *        - FSX
+ *        - Modelmapping
+ *        - VPilotRules
+ */
+
+#endif

samples/blackmiscsim/samplesfscommon.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscsim
+
 #include "samplesfscommon.h"
 #include "blackmisc/sampleutils.h"
 #include "blackmisc/simulation/fscommon/aircraftcfgentrieslist.h"

samples/blackmiscsim/samplesfscommon.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscsim
 
 #ifndef BLACKSAMPLE_SAMPLESFSCOMMON_H
 #define BLACKSAMPLE_SAMPLESFSCOMMON_H

samples/blackmiscsim/samplesfsx.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscsim
+
 #include "samplesfsx.h"
 #include "blackmisc/simulation/fsx/simconnectutilities.h"
 #include "blackmisc/registermetadata.h"

samples/blackmiscsim/samplesfsx.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscsim
 
 #ifndef BLACKSAMPLE_SAMPLESFSX_H
 #define BLACKSAMPLE_SAMPLESFSX_H

samples/blackmiscsim/samplesmodelmapping.cpp

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

samples/blackmiscsim/samplesmodelmapping.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscsim
 
 #ifndef BLACKSAMPLE_SAMPLESMODELMAPPING_H
 #define BLACKSAMPLE_SAMPLESMODELMAPPING_H

samples/blackmiscsim/samplesvpilotrules.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup sampleblackmiscsim
+
 #include "samplesvpilotrules.h"
 #include "blackmisc/simulation/fscommon/vpilotrulesreader.h"
 #include "blackmisc/blackmiscfreefunctions.h"

samples/blackmiscsim/samplesvpilotrules.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup sampleblackmiscsim
 
 #ifndef BLACKSAMPLE_SAMPLESVPILOTRULES_H
 #define BLACKSAMPLE_SAMPLESVPILOTRULES_H

samples/cliclient/client.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup samplecliclient
+
 #include "client.h"
 #include "blackcore/networkvatlib.h"
 #include <iostream>

samples/cliclient/client.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup samplecliclient
 
 #ifndef BLACKSAMPLE_CLICLIENT_CLIENT_H
 #define BLACKSAMPLE_CLICLIENT_CLIENT_H

samples/cliclient/main.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup samplecliclient
+
 #include "blackcore/networkvatlib.h"
 #include "blackmisc/loghandler.h"
 #include "client.h"

samples/cliclient/reader.cpp

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

samples/cliclient/reader.h

@@ -8,6 +8,7 @@
  */
 
 //! \file
+//! \ingroup samplecliclient
 
 #ifndef BLACKSAMPLE_CLICLIENT_LINEREADER_H
 #define BLACKSAMPLE_CLICLIENT_LINEREADER_H

samples/cliclient/samplecliclient.h

@@ -0,0 +1,21 @@
+/* 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_HOTKEY_H
+#define BLACKSAMPLE_HOTKEY_H
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup samplecliclient Sample Cli Client
+ * \ingroup samples
+ * \brief Command line interface client
+ */
+
+#endif

samples/hotkey/main.cpp

@@ -7,6 +7,9 @@
  * contained in the LICENSE file.
  */
 
+//! \file
+//! \ingroup samplehotkey
+
 #include "blackgui/components/settingshotkeycomponent.h"
 #include "blackmisc/registermetadata.h"
 #include <QApplication>

samples/hotkey/samplehotkey.h

@@ -0,0 +1,21 @@
+/* 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
+
+// just a dummy header, documentation will go here
+
+/*!
+ * \defgroup samplehotkey Sample Hotkey
+ * \ingroup samples
+ * \brief TBW
+ */
+
+#endif

samples/hotkey/samplehotkey.pro

@@ -13,6 +13,7 @@ CONFIG   += blackmisc blackinput blackcore blackgui
 DEPENDPATH += . $$SourceRoot/src
 INCLUDEPATH += . $$SourceRoot/src
 
+HEADERS += *.h
 SOURCES += *.cpp
 
 DESTDIR = $$DestRoot/bin

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"