From d8ae23c2c59083133105618819930890b691dc3d Mon Sep 17 00:00:00 2001 From: Mat Sutcliffe Date: Sun, 23 Aug 2020 19:47:31 +0100 Subject: [PATCH] Issue #77 Convert doxygen dummy headers to .dox files Doxygen will treat them the same, and it helps unclutter the C++ code. --- src/blackcore/{blackcore.h => blackcore.dox} | 11 +++++++---- src/blackgui/{blackgui.h => blackgui.dox} | 6 ------ src/blackmisc/{blackmisc.h => blackmisc.dox} | 6 ------ 3 files changed, 7 insertions(+), 16 deletions(-) rename src/blackcore/{blackcore.h => blackcore.dox} (67%) rename src/blackgui/{blackgui.h => blackgui.dox} (89%) rename src/blackmisc/{blackmisc.h => blackmisc.dox} (91%) diff --git a/src/blackcore/blackcore.h b/src/blackcore/blackcore.dox similarity index 67% rename from src/blackcore/blackcore.h rename to src/blackcore/blackcore.dox index 243a0d1a8..98f1b4324 100644 --- a/src/blackcore/blackcore.h +++ b/src/blackcore/blackcore.dox @@ -1,5 +1,10 @@ -#ifndef BLACKCORE_H -#define BLACKCORE_H +/* 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 @@ -38,5 +43,3 @@ * \defgroup dbus DBus related functions, classes, or definitions. * \ingroup blackcore */ - -#endif // guard diff --git a/src/blackgui/blackgui.h b/src/blackgui/blackgui.dox similarity index 89% rename from src/blackgui/blackgui.h rename to src/blackgui/blackgui.dox index f3c03a5ed..c9dc55b59 100644 --- a/src/blackgui/blackgui.h +++ b/src/blackgui/blackgui.dox @@ -6,10 +6,6 @@ * or distributed except according to the terms contained in the LICENSE file. */ -#ifndef BLACKGUI_NAMESPACES_H -#define BLACKGUI_NAMESPACES_H - -// just a dummy header, namespace documentation will go here //! \file /*! @@ -51,5 +47,3 @@ * \namespace BlackGui::Win * \brief Windows specific classes. */ - -#endif diff --git a/src/blackmisc/blackmisc.h b/src/blackmisc/blackmisc.dox similarity index 91% rename from src/blackmisc/blackmisc.h rename to src/blackmisc/blackmisc.dox index 5f1136b88..b24b63a10 100644 --- a/src/blackmisc/blackmisc.h +++ b/src/blackmisc/blackmisc.dox @@ -6,10 +6,6 @@ * or distributed except according to the terms contained in the LICENSE file. */ -#ifndef BLACKMISC_NAMESPACES_H -#define BLACKMISC_NAMESPACES_H - -// just a dummy header, namespace documentation will go here //! \file /*! @@ -63,5 +59,3 @@ * \namespace BlackMisc::Mixin * \brief Mixin classes which implement common operations for value classes. */ - -#endif