Issue #77 Convert doxygen dummy headers to .dox files

Doxygen will treat them the same,
and it helps unclutter the C++ code.
This commit is contained in:
Mat Sutcliffe
2020-08-23 19:47:31 +01:00
parent 2dc86652c2
commit d8ae23c2c5
3 changed files with 7 additions and 16 deletions

View File

@@ -0,0 +1,61 @@
/* Copyright (C) 2013
* 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. 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.
*/
//! \file
/*!
* \namespace BlackMisc
* \brief Base and utility classes available in all other projects.
*/
/*!
* \namespace BlackMisc::GeoPosition
* \brief Position handling as geo locations and coordinates systems.
*/
/*!
* \namespace BlackMisc::Settings
* \brief Classes related to configuration settings.
*/
/*!
* \namespace BlackMisc::SharedState
* \brief Utilities for sharing state between multiple objects.
* \ingroup SharedState
*/
/*!
* \namespace BlackMisc::SharedState::DBus
* \brief Implementation detail classes used by SharedState::CDataLinkDBus.
* \ingroup SharedState
*/
/*!
* \namespace BlackMisc::Predicates
* \brief Functor classes for evaluating predicate calculus expressions.
*/
/*!
* \namespace BlackMisc::Predicates::Private
* \private
*/
/*!
* \namespace BlackMisc::Private
* \private
*/
/*!
* \namespace BlackMisc::Iterators
* \brief Iterator classes for the containers.
*/
/*!
* \namespace BlackMisc::Mixin
* \brief Mixin classes which implement common operations for value classes.
*/