From 9ea1fd86ef55b9672b2d3941b3145bc178e54bef Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Tue, 10 Jun 2014 01:54:07 +0200 Subject: [PATCH] Doxygen --- src/blackmisc/blackmisc.h | 5 ----- src/blackmisc/notificationsounds.h | 5 +++-- tests/blackmisc/blackmisctest.h | 2 ++ tests/blackmisc/testaviation.h | 2 ++ tests/blackmisc/testcontainers.h | 2 ++ tests/blackmisc/testgeo.h | 2 ++ 6 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/blackmisc/blackmisc.h b/src/blackmisc/blackmisc.h index 72bc34196..dfe9ab135 100644 --- a/src/blackmisc/blackmisc.h +++ b/src/blackmisc/blackmisc.h @@ -9,11 +9,6 @@ * \brief Base and utility classes available in all other projects. */ -/*! - * \namespace BlackMisctest - * \brief Tests and samples for namespace BlackMisc. - */ - /*! * \namespace BlackMisc::Aviation * \brief Aviation and Avionics classes such as CHeading or CTransponder . diff --git a/src/blackmisc/notificationsounds.h b/src/blackmisc/notificationsounds.h index ad04a7ce0..2e1448418 100644 --- a/src/blackmisc/notificationsounds.h +++ b/src/blackmisc/notificationsounds.h @@ -5,8 +5,9 @@ namespace BlackSound { /*! - * Simplified enums to play sound. Outside BlackSound as this allows - * to trigger sounds without using Multimedia libraries. + * Simplified enums to play sounds. + * \remarks Currently located in project BlackMisc (i.e. outside project BlackSound) + * as this allows to trigger sounds without using Multimedia libraries. */ struct CNotificationSounds { diff --git a/tests/blackmisc/blackmisctest.h b/tests/blackmisc/blackmisctest.h index 5edc9f1b7..03ce5fd3b 100644 --- a/tests/blackmisc/blackmisctest.h +++ b/tests/blackmisc/blackmisctest.h @@ -6,6 +6,8 @@ #ifndef BLACKMISCTEST_H #define BLACKMISCTEST_H +/*! \file */ + /*! * @namespace BlackMiscTest * Unit tests for BlackMisc. Unit tests do have their own namespace, so diff --git a/tests/blackmisc/testaviation.h b/tests/blackmisc/testaviation.h index f678bdce2..75360f12c 100644 --- a/tests/blackmisc/testaviation.h +++ b/tests/blackmisc/testaviation.h @@ -3,6 +3,8 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +/*! \file */ + #ifndef BLACKMISCTEST_TESTAVIATIONBASE_H #define BLACKMISCTEST_TESTAVIATIONBASE_H diff --git a/tests/blackmisc/testcontainers.h b/tests/blackmisc/testcontainers.h index b9c5a6730..64b9e504f 100644 --- a/tests/blackmisc/testcontainers.h +++ b/tests/blackmisc/testcontainers.h @@ -3,6 +3,8 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +/*! \file */ + #ifndef BLACKMISCTEST_TESTCONTAINERS_H #define BLACKMISCTEST_TESTCONTAINERS_H diff --git a/tests/blackmisc/testgeo.h b/tests/blackmisc/testgeo.h index 6f426fe5c..81d8ea391 100644 --- a/tests/blackmisc/testgeo.h +++ b/tests/blackmisc/testgeo.h @@ -3,6 +3,8 @@ * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +/*! \file */ + #ifndef BLACKMISCTEST_TESTGEO_H #define BLACKMISCTEST_TESTGEO_H