Issue #77 Style

src/blackcore/blackcoreexport.h

@@ -8,14 +8,14 @@
 
 //! \file
 
-#ifndef BLACKCORE_MACROS_H
+#ifndef BLACKCORE_BLACKCOREEXPORT_H
-#define BLACKCORE_MACROS_H
+#define BLACKCORE_BLACKCOREEXPORT_H
 
 #include <QtGlobal>
 
 /*!
  * \def BLACKCORE_EXPORT
- * BlackCore Export Macro
+ * Export a class or function from the library
  */
 
 #ifndef WITH_STATIC

src/blackgui/blackguiexport.h

@@ -8,14 +8,14 @@
 
 //! \file
 
-#ifndef BLACKGUI_MACROS_H
+#ifndef BLACKGUI_BLACKGUIEXPORT_H
-#define BLACKGUI_MACROS_H
+#define BLACKGUI_BLACKGUIEXPORT_H
 
 #include <QtGlobal>
 
 /*!
  * \def BLACKGUI_EXPORT
- * BlackGui Export Macro
+ * Export a class or function from the library
  */
 
 #ifndef WITH_STATIC
@@ -30,12 +30,12 @@
 
 /*!
  * \def BLACKGUI_EXPORT_DECLARE_TEMPLATE
- * BLACKGUI Export Explicit Template Declaration Macro
+ * BLACKGUI Export explicit template declaration
  */
 
 /*!
  * \def BLACKGUI_EXPORT_DEFINE_TEMPLATE
- * BLACKGUI Export Explicit Template Definition Macro
+ * BLACKGUI Export explicit template definition
  */
 #if defined(Q_OS_WIN) && defined(Q_CC_GNU)
 #  define BLACKGUI_EXPORT_DECLARE_TEMPLATE BLACKGUI_EXPORT

src/blackinput/blackinputexport.h

@@ -8,14 +8,14 @@
 
 //! \file
 
-#ifndef BLACKINPUT_MACROS_H
+#ifndef BLACKINPUT_BLACKINPUTEXPORT_H
-#define BLACKINPUT_MACROS_H
+#define BLACKINPUT_BLACKINPUTEXPORT_H
 
 #include <QtGlobal>
 
 /*!
  * \def BLACKINPUT_EXPORT
- * BlackInput Export Macro
+ * Export a class or function from the library
  */
 
 #ifndef WITH_STATIC
@@ -28,4 +28,4 @@
 #  define BLACKINPUT_EXPORT
 #endif
 
-#endif // BLACKINPUT_MACROS_H
+#endif // guard

src/blackmisc/algorithm.h

@@ -11,14 +11,14 @@
 #ifndef BLACKMISC_ALGORITHM_H
 #define BLACKMISC_ALGORITHM_H
 
-#include "blackmisc/integersequence.h"
-
 #include <QThreadStorage>
 #include <QRandomGenerator>
 #include <QtGlobal>
 #include <algorithm>
 #include <iterator>
+#include <utility>
 #include <random>
+#include <tuple>
 
 namespace BlackMisc
 {

src/blackmisc/blackmiscexport.h

@@ -8,14 +8,14 @@
 
 //! \file
 
-#ifndef BLACKMISC_MACROS_H
+#ifndef BLACKMISC_BLACKMISCEXPORT_H
-#define BLACKMISC_MACROS_H
+#define BLACKMISC_BLACKMISCEXPORT_H
 
 #include <QtGlobal>
 
 /*!
  * \def BLACKMISC_EXPORT
- * BlackMisc Export Macro
+ * Export a class or function from the library
  */
 #ifndef WITH_STATIC
 #  if defined(BUILD_BLACKMISC_LIB)
@@ -29,12 +29,12 @@
 
 /*!
  * \def BLACKMISC_EXPORT_DECLARE_TEMPLATE
- * BlackMisc Export Explicit Template Declaration Macro
+ * Export explicit template declaration
  */
 
 /*!
  * \def BLACKMISC_EXPORT_DEFINE_TEMPLATE
- * BlackMisc Export Explicit Template Definition Macro
+ * Export explicit template definition
  */
 #if defined(Q_OS_WIN) && defined(Q_CC_GNU)
 #  define BLACKMISC_EXPORT_DECLARE_TEMPLATE BLACKMISC_EXPORT

src/blackmisc/connectionguard.cpp

@@ -7,7 +7,9 @@
  */
 
 #include "blackmisc/connectionguard.h"
-#include "blackmisc/range.h"
+#include "blackmisc/range.h" // for as_const
+
+#include <QObject>
 
 namespace BlackMisc
 {

src/blackmisc/connectionguard.h

@@ -15,7 +15,6 @@
 
 #include <QList>
 #include <QMetaObject>
-#include <QObject>
 
 namespace BlackMisc
 {

src/blackmisc/crashhandler.cpp

@@ -7,7 +7,6 @@
  */
 
 #include "blackmisc/crashhandler.h"
-#include "blackmisc/appstarttime.h"
 #include "blackmisc/directoryutils.h"
 #include "blackmisc/logmessage.h"
 #include "blackmisc/filelogger.h"

src/blackmisc/icon.h

@@ -158,7 +158,7 @@ namespace BlackMisc
 
     namespace Private
     {
-        //! \private Needed so we can copy forward-declared CIcon.
+        //! \private Needed so CValueObjectMetaInfoHelper can copy forward-declared CIcon.
         inline void assign(CIcon &a, const CIcon &b) { a = b; }
     }
 

src/blackmisc/inheritancetraits.h

@@ -11,7 +11,7 @@
 #ifndef BLACKMISC_INHERITANCE_TRAITS_H
 #define BLACKMISC_INHERITANCE_TRAITS_H
 
-#include "blackmisc/typetraits.h"
+#include "blackmisc/typetraits.h" // for void_t
 #include <QMetaType>
 #include <type_traits>
 

src/blackmisc/metadatautils.h

@@ -21,7 +21,6 @@ class QTextStream;
 class QObject;
 struct QMetaObject;
 
-//! Metadata util functions
 namespace BlackMisc
 {
     //! Display all user metatypes

src/blackmisc/predicates.h

@@ -11,7 +11,6 @@
 #ifndef BLACKMISC_PREDICATES_H
 #define BLACKMISC_PREDICATES_H
 
-#include "blackmisc/integersequence.h"
 #include "blackmisc/algorithm.h"
 
 #include <QObject>

src/blackmisc/stringutils.h

@@ -36,7 +36,6 @@
 
 template <class T1, class T2> class QMap;
 
-//! Free functions in BlackMisc
 namespace BlackMisc
 {
     //! Return a string with characters removed that match the given predicate.

src/blackmisc/threadutils.h

@@ -8,11 +8,10 @@
 
 //! \file
 
-#ifndef BLACKMISC_CTHREADUTILS_H
+#ifndef BLACKMISC_THREADUTILS_H
-#define BLACKMISC_CTHREADUTILS_H
+#define BLACKMISC_THREADUTILS_H
 
 #include "blackmisc/blackmiscexport.h"
-
 #include <QThread>
 #include <functional>
 

src/blackmisc/variant.h

@@ -384,7 +384,7 @@ namespace BlackMisc
 {
     namespace Private
     {
-        //! \private Needed so we can copy forward-declared CVariant.
+        //! \private Needed so CValueObjectMetaInfoHelper can copy forward-declared CVariant.
         inline void assign(CVariant &a, const CVariant &b) { a = b; }
 
         //! \private

src/blackmisc/variantprivate.h

@@ -35,10 +35,10 @@ namespace BlackMisc
 
     namespace Private
     {
-        //! \private Needed so we can copy forward-declared CVariant.
+        //! \private Defined in variant.h
         void assign(CVariant &, const CVariant &);
 
-        //! \private Needed so we can copy forward-declared CIcon.
+        //! \private Defined in icon.h
         void assign(CIcon &, const CIcon &);
 
         //! \private Abstract base class representing the set of operations supported by a particular value type.

src/blackmisc/windllutils.h

@@ -13,6 +13,7 @@
 
 #include "blackmisc/blackmiscexport.h"
 #include <QString>
+#include <QList>
 
 namespace BlackMisc
 {

src/blacksound/blacksoundexport.h

@@ -8,14 +8,14 @@
 
 //! \file
 
-#ifndef BLACKSOUND_MACROS_H
+#ifndef BLACKSOUND_BLACKSOUNDEXPORT_H
-#define BLACKSOUND_MACROS_H
+#define BLACKSOUND_BLACKSOUNDEXPORT_H
 
 #include <QtGlobal>
 
 /*!
  * \def BLACKSOUND_EXPORT
- * BlackSound Export Macro
+ * Export a class or function from the library
  */
 
 #ifndef WITH_STATIC
@@ -28,4 +28,4 @@
 #  define BLACKSOUND_EXPORT
 #endif
 
-#endif // BLACKSOUND_MACROS_H
+#endif // guard

src/swiftcore/main.cpp

@@ -12,7 +12,6 @@
 #include "blackmisc/icons.h"
 #include "blackmisc/directoryutils.h"
 #include "blackmisc/crashhandler.h"
-#include "blackmisc/appstarttime.h"
 #include "swiftcore.h"
 
 #include <stdlib.h>

src/swiftdata/main.cpp

@@ -11,7 +11,6 @@
 #include "blackmisc/directoryutils.h"
 #include "blackmisc/icons.h"
 #include "blackmisc/crashhandler.h"
-#include "blackmisc/appstarttime.h"
 #include "swiftdata.h"
 
 #include <stdlib.h>

src/swiftguistandard/main.cpp

@@ -15,7 +15,6 @@
 #include "blackmisc/audio/audioutils.h"
 #include "blackmisc/directoryutils.h"
 #include "blackmisc/crashhandler.h"
-#include "blackmisc/appstarttime.h"
 
 #include <stdlib.h>
 #include <iostream>