Add samples to doxygen group 'samples' and subgroups

refs #594

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