diff --git a/samples/blackmisc/main.cpp b/samples/blackmisc/main.cpp index 16f3ff57f..b1d055eaa 100644 --- a/samples/blackmisc/main.cpp +++ b/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; diff --git a/samples/blackmisc/sampleblackmisc.h b/samples/blackmisc/sampleblackmisc.h new file mode 100644 index 000000000..9aee34f71 --- /dev/null +++ b/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 diff --git a/samples/blackmisc/samplesalgorithm.cpp b/samples/blackmisc/samplesalgorithm.cpp index 2467c40ae..6896718ef 100644 --- a/samples/blackmisc/samplesalgorithm.cpp +++ b/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" diff --git a/samples/blackmisc/samplesalgorithm.h b/samples/blackmisc/samplesalgorithm.h index 3e2121c32..d23fbe816 100644 --- a/samples/blackmisc/samplesalgorithm.h +++ b/samples/blackmisc/samplesalgorithm.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESALGORITHM_H #define BLACKSAMPLE_SAMPLESALGORITHM_H diff --git a/samples/blackmisc/sampleschangeobject.cpp b/samples/blackmisc/sampleschangeobject.cpp index ee851c7b0..7a290c5fd 100644 --- a/samples/blackmisc/sampleschangeobject.cpp +++ b/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" diff --git a/samples/blackmisc/sampleschangeobject.h b/samples/blackmisc/sampleschangeobject.h index 704835eb1..100843d90 100644 --- a/samples/blackmisc/sampleschangeobject.h +++ b/samples/blackmisc/sampleschangeobject.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESCHANGEDATA_H #define BLACKSAMPLE_SAMPLESCHANGEDATA_H diff --git a/samples/blackmisc/samplescontainer.cpp b/samples/blackmisc/samplescontainer.cpp index 1bf0e3f58..73ccfd134 100644 --- a/samples/blackmisc/samplescontainer.cpp +++ b/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" diff --git a/samples/blackmisc/samplescontainer.h b/samples/blackmisc/samplescontainer.h index 0eb2c1f1b..f73c49fea 100644 --- a/samples/blackmisc/samplescontainer.h +++ b/samples/blackmisc/samplescontainer.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESCONTAINER_H #define BLACKSAMPLE_SAMPLESCONTAINER_H diff --git a/samples/blackmisc/samplesjson.cpp b/samples/blackmisc/samplesjson.cpp index f6d4c37d7..7a526e607 100644 --- a/samples/blackmisc/samplesjson.cpp +++ b/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" diff --git a/samples/blackmisc/samplesjson.h b/samples/blackmisc/samplesjson.h index eb71b9f1e..230e5cef4 100644 --- a/samples/blackmisc/samplesjson.h +++ b/samples/blackmisc/samplesjson.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESJSON_H #define BLACKSAMPLE_SAMPLESJSON_H diff --git a/samples/blackmisc/samplesmetadata.cpp b/samples/blackmisc/samplesmetadata.cpp index 04d026671..5df78f683 100644 --- a/samples/blackmisc/samplesmetadata.cpp +++ b/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" diff --git a/samples/blackmisc/samplesmetadata.h b/samples/blackmisc/samplesmetadata.h index 7f92d3004..1fc4c815b 100644 --- a/samples/blackmisc/samplesmetadata.h +++ b/samples/blackmisc/samplesmetadata.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESMETADATA_H #define BLACKSAMPLE_SAMPLESMETADATA_H diff --git a/samples/blackmisc/samplesperformance.cpp b/samples/blackmisc/samplesperformance.cpp index 7684997a0..b33228f99 100644 --- a/samples/blackmisc/samplesperformance.cpp +++ b/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" diff --git a/samples/blackmisc/samplesperformance.h b/samples/blackmisc/samplesperformance.h index 22f1094bc..24f05eb07 100644 --- a/samples/blackmisc/samplesperformance.h +++ b/samples/blackmisc/samplesperformance.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmisc #ifndef BLACKSAMPLE_SAMPLESPERFORMANCE_H #define BLACKSAMPLE_SAMPLESPERFORMANCE_H diff --git a/samples/blackmiscdbus/main.cpp b/samples/blackmiscdbus/main.cpp index f6d1beb2b..07eac5a17 100644 --- a/samples/blackmiscdbus/main.cpp +++ b/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" diff --git a/samples/blackmiscdbus/sampleblackmiscdbus.h b/samples/blackmiscdbus/sampleblackmiscdbus.h new file mode 100644 index 000000000..907e9a36e --- /dev/null +++ b/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 diff --git a/samples/blackmiscdbus/servicetool.cpp b/samples/blackmiscdbus/servicetool.cpp index 27ceae36c..b852d76c1 100644 --- a/samples/blackmiscdbus/servicetool.cpp +++ b/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" diff --git a/samples/blackmiscdbus/servicetool.h b/samples/blackmiscdbus/servicetool.h index 59df12d2a..9930bf128 100644 --- a/samples/blackmiscdbus/servicetool.h +++ b/samples/blackmiscdbus/servicetool.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscdbus #ifndef BLACKSAMPLE_SERVICETOOL_H #define BLACKSAMPLE_SERVICETOOL_H diff --git a/samples/blackmiscdbus/testservice.cpp b/samples/blackmiscdbus/testservice.cpp index de18e0e79..bbe245022 100644 --- a/samples/blackmiscdbus/testservice.cpp +++ b/samples/blackmiscdbus/testservice.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup sampleblackmiscdbus + #include "testservice.h" #include "blackmisc/blackmiscfreefunctions.h" diff --git a/samples/blackmiscdbus/testservice.h b/samples/blackmiscdbus/testservice.h index 55d444282..e25f59e1c 100644 --- a/samples/blackmiscdbus/testservice.h +++ b/samples/blackmiscdbus/testservice.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscdbus #ifndef BLACKSAMPLE_TESTSERVICE_H #define BLACKSAMPLE_TESTSERVICE_H diff --git a/samples/blackmiscdbus/testserviceinterface.cpp b/samples/blackmiscdbus/testserviceinterface.cpp index 19297f02e..cd10db752 100644 --- a/samples/blackmiscdbus/testserviceinterface.cpp +++ b/samples/blackmiscdbus/testserviceinterface.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup sampleblackmiscdbus + #include "testserviceinterface.h" namespace BlackSample diff --git a/samples/blackmiscdbus/testserviceinterface.h b/samples/blackmiscdbus/testserviceinterface.h index 5a934c148..4743e4be8 100644 --- a/samples/blackmiscdbus/testserviceinterface.h +++ b/samples/blackmiscdbus/testserviceinterface.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscdbus #ifndef BLACKSAMPLE_TESTSERVICE_INTERFACE_H #define BLACKSAMPLE_TESTSERVICE_INTERFACE_H diff --git a/samples/blackmiscquantities/main.cpp b/samples/blackmiscquantities/main.cpp index bc1e1d1d3..28b42d6f1 100644 --- a/samples/blackmiscquantities/main.cpp +++ b/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" diff --git a/samples/blackmiscquantities/sampleblackmiscquantities.h b/samples/blackmiscquantities/sampleblackmiscquantities.h new file mode 100644 index 000000000..f9322703b --- /dev/null +++ b/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 diff --git a/samples/blackmiscquantities/samplesaviation.cpp b/samples/blackmiscquantities/samplesaviation.cpp index 968daec48..6abec65f2 100644 --- a/samples/blackmiscquantities/samplesaviation.cpp +++ b/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" diff --git a/samples/blackmiscquantities/samplesaviation.h b/samples/blackmiscquantities/samplesaviation.h index ba7683d96..302a77651 100644 --- a/samples/blackmiscquantities/samplesaviation.h +++ b/samples/blackmiscquantities/samplesaviation.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscquantities #ifndef BLACKSAMPLE_SAMPLESAVIATION_H #define BLACKSAMPLE_SAMPLESAVIATION_H diff --git a/samples/blackmiscquantities/samplesgeo.cpp b/samples/blackmiscquantities/samplesgeo.cpp index f7ec9f40f..7c38b6434 100644 --- a/samples/blackmiscquantities/samplesgeo.cpp +++ b/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" diff --git a/samples/blackmiscquantities/samplesgeo.h b/samples/blackmiscquantities/samplesgeo.h index ada215bca..cbb2a0d7f 100644 --- a/samples/blackmiscquantities/samplesgeo.h +++ b/samples/blackmiscquantities/samplesgeo.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscquantities #ifndef BLACKSAMPLE_SAMPLESGEO_H #define BLACKSAMPLE_SAMPLESGEO_H diff --git a/samples/blackmiscquantities/samplesphysicalquantities.cpp b/samples/blackmiscquantities/samplesphysicalquantities.cpp index 87fc08e99..ca261dfd8 100644 --- a/samples/blackmiscquantities/samplesphysicalquantities.cpp +++ b/samples/blackmiscquantities/samplesphysicalquantities.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup sampleblackmiscquantities + #include "samplesphysicalquantities.h" #include "blackmisc/variant.h" diff --git a/samples/blackmiscquantities/samplesphysicalquantities.h b/samples/blackmiscquantities/samplesphysicalquantities.h index 70418c1bf..47c272e2c 100644 --- a/samples/blackmiscquantities/samplesphysicalquantities.h +++ b/samples/blackmiscquantities/samplesphysicalquantities.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscquantities #ifndef BLACKSAMPLE_SAMPLESPHYSICALQUANTITIES_H #define BLACKSAMPLE_SAMPLESPHYSICALQUANTITIES_H diff --git a/samples/blackmiscsim/main.cpp b/samples/blackmiscsim/main.cpp index def4e8384..b328cb924 100644 --- a/samples/blackmiscsim/main.cpp +++ b/samples/blackmiscsim/main.cpp @@ -18,6 +18,9 @@ #include #include +//! \file +//! \ingroup sampleblackmiscsim + //! main int main(int argc, char *argv[]) { diff --git a/samples/blackmiscsim/sampleblackmiscsim.h b/samples/blackmiscsim/sampleblackmiscsim.h new file mode 100644 index 000000000..df4ccda3d --- /dev/null +++ b/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 diff --git a/samples/blackmiscsim/samplesfscommon.cpp b/samples/blackmiscsim/samplesfscommon.cpp index e134f9bf8..0888280d8 100644 --- a/samples/blackmiscsim/samplesfscommon.cpp +++ b/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" diff --git a/samples/blackmiscsim/samplesfscommon.h b/samples/blackmiscsim/samplesfscommon.h index 10d873709..4df9cefd6 100644 --- a/samples/blackmiscsim/samplesfscommon.h +++ b/samples/blackmiscsim/samplesfscommon.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscsim #ifndef BLACKSAMPLE_SAMPLESFSCOMMON_H #define BLACKSAMPLE_SAMPLESFSCOMMON_H diff --git a/samples/blackmiscsim/samplesfsx.cpp b/samples/blackmiscsim/samplesfsx.cpp index 5d5999e23..b4d097dca 100644 --- a/samples/blackmiscsim/samplesfsx.cpp +++ b/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" diff --git a/samples/blackmiscsim/samplesfsx.h b/samples/blackmiscsim/samplesfsx.h index 1ee983f8e..6e14338cd 100644 --- a/samples/blackmiscsim/samplesfsx.h +++ b/samples/blackmiscsim/samplesfsx.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscsim #ifndef BLACKSAMPLE_SAMPLESFSX_H #define BLACKSAMPLE_SAMPLESFSX_H diff --git a/samples/blackmiscsim/samplesmodelmapping.cpp b/samples/blackmiscsim/samplesmodelmapping.cpp index 79a9bbf30..1fc686889 100644 --- a/samples/blackmiscsim/samplesmodelmapping.cpp +++ b/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" diff --git a/samples/blackmiscsim/samplesmodelmapping.h b/samples/blackmiscsim/samplesmodelmapping.h index d0cc10b35..aca160336 100644 --- a/samples/blackmiscsim/samplesmodelmapping.h +++ b/samples/blackmiscsim/samplesmodelmapping.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscsim #ifndef BLACKSAMPLE_SAMPLESMODELMAPPING_H #define BLACKSAMPLE_SAMPLESMODELMAPPING_H diff --git a/samples/blackmiscsim/samplesvpilotrules.cpp b/samples/blackmiscsim/samplesvpilotrules.cpp index dd7f617f0..a95716525 100644 --- a/samples/blackmiscsim/samplesvpilotrules.cpp +++ b/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" diff --git a/samples/blackmiscsim/samplesvpilotrules.h b/samples/blackmiscsim/samplesvpilotrules.h index d45a6554b..75a3a1465 100644 --- a/samples/blackmiscsim/samplesvpilotrules.h +++ b/samples/blackmiscsim/samplesvpilotrules.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup sampleblackmiscsim #ifndef BLACKSAMPLE_SAMPLESVPILOTRULES_H #define BLACKSAMPLE_SAMPLESVPILOTRULES_H diff --git a/samples/cliclient/client.cpp b/samples/cliclient/client.cpp index 16129142d..16cee756d 100644 --- a/samples/cliclient/client.cpp +++ b/samples/cliclient/client.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup samplecliclient + #include "client.h" #include "blackcore/networkvatlib.h" #include diff --git a/samples/cliclient/client.h b/samples/cliclient/client.h index e545f4229..a349eb563 100644 --- a/samples/cliclient/client.h +++ b/samples/cliclient/client.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup samplecliclient #ifndef BLACKSAMPLE_CLICLIENT_CLIENT_H #define BLACKSAMPLE_CLICLIENT_CLIENT_H diff --git a/samples/cliclient/main.cpp b/samples/cliclient/main.cpp index c048f179e..bda493dcf 100644 --- a/samples/cliclient/main.cpp +++ b/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" diff --git a/samples/cliclient/reader.cpp b/samples/cliclient/reader.cpp index 16e072442..76371dbe8 100644 --- a/samples/cliclient/reader.cpp +++ b/samples/cliclient/reader.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup samplecliclient + #include "reader.h" #include diff --git a/samples/cliclient/reader.h b/samples/cliclient/reader.h index cee498835..172961d57 100644 --- a/samples/cliclient/reader.h +++ b/samples/cliclient/reader.h @@ -8,6 +8,7 @@ */ //! \file +//! \ingroup samplecliclient #ifndef BLACKSAMPLE_CLICLIENT_LINEREADER_H #define BLACKSAMPLE_CLICLIENT_LINEREADER_H diff --git a/samples/cliclient/samplecliclient.h b/samples/cliclient/samplecliclient.h new file mode 100644 index 000000000..e82b6234b --- /dev/null +++ b/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 diff --git a/samples/hotkey/main.cpp b/samples/hotkey/main.cpp index a061a0ea3..b3123f7ce 100644 --- a/samples/hotkey/main.cpp +++ b/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 diff --git a/samples/hotkey/samplehotkey.h b/samples/hotkey/samplehotkey.h new file mode 100644 index 000000000..9d7b757ea --- /dev/null +++ b/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 diff --git a/samples/hotkey/samplehotkey.pro b/samples/hotkey/samplehotkey.pro index f43df5358..ebd9d2c67 100644 --- a/samples/hotkey/samplehotkey.pro +++ b/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 diff --git a/samples/weatherdata/main.cpp b/samples/weatherdata/main.cpp index 3db83edb3..01163ffb8 100644 --- a/samples/weatherdata/main.cpp +++ b/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" diff --git a/samples/weatherdata/reader.cpp b/samples/weatherdata/reader.cpp index 938a0fa21..daf54d26b 100644 --- a/samples/weatherdata/reader.cpp +++ b/samples/weatherdata/reader.cpp @@ -7,6 +7,9 @@ * contained in the LICENSE file. */ +//! \file +//! \ingroup sampleweatherdata + #include "reader.h" #include #include diff --git a/samples/weatherdata/reader.h b/samples/weatherdata/reader.h index 5de5f8f1c..0c7eeda1c 100644 --- a/samples/weatherdata/reader.h +++ b/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 diff --git a/samples/weatherdata/sampleweatherdata.h b/samples/weatherdata/sampleweatherdata.h new file mode 100644 index 000000000..20fde0425 --- /dev/null +++ b/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 diff --git a/samples/weatherdata/weatherdataprinter.cpp b/samples/weatherdata/weatherdataprinter.cpp index 8d619929b..0f489795a 100644 --- a/samples/weatherdata/weatherdataprinter.cpp +++ b/samples/weatherdata/weatherdataprinter.cpp @@ -2,6 +2,9 @@ #include "blackmisc/logmessage.h" #include +//! \file +//! \ingroup sampleweatherdata + using namespace BlackMisc; using namespace BlackMisc::Weather; using namespace BlackMisc::Geo; diff --git a/samples/weatherdata/weatherdataprinter.h b/samples/weatherdata/weatherdataprinter.h index e6475d0e2..02c5dfa28 100644 --- a/samples/weatherdata/weatherdataprinter.h +++ b/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"