Add samples to doxygen group 'samples' and subgroups

refs #594

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