From 4af08d04c194fbf02eeda4ee3ea2d2cbc1530835 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 20 Jun 2012 22:56:34 +0200 Subject: [PATCH] Renamed visibility headers to distinguish them from API headers. Also added note about that to coding style documentation. --- doc/coding-style.dox | 7 +++++++ src/Math/Math.h | 2 +- src/MeshTools/FlipNormals.h | 2 +- src/MeshTools/GenerateFlatNormals.h | 2 +- src/MeshTools/Tipsify.h | 2 +- .../{MeshToolsVisibility.h => visibilityMeshTools.h} | 4 ++-- src/Physics/AbstractShape.h | 2 +- src/Physics/{PhysicsVisibility.h => visibilityPhysics.h} | 4 ++-- src/Shaders/PhongShader.h | 2 +- src/Shaders/{ShadersVisibility.h => visibilityShaders.h} | 4 ++-- src/{Visibility.h => visibility.h} | 4 ++-- 11 files changed, 21 insertions(+), 14 deletions(-) rename src/MeshTools/{MeshToolsVisibility.h => visibilityMeshTools.h} (89%) rename src/Physics/{PhysicsVisibility.h => visibilityPhysics.h} (90%) rename src/Shaders/{ShadersVisibility.h => visibilityShaders.h} (90%) rename src/{Visibility.h => visibility.h} (94%) diff --git a/doc/coding-style.dox b/doc/coding-style.dox index 5336b9a7a..60437cb65 100644 --- a/doc/coding-style.dox +++ b/doc/coding-style.dox @@ -11,11 +11,18 @@ Nothing is worse than rule that hurts productivity instead of improving it. @section cpp C++ code +@subsection cpp-files File naming and directory structure + All C++ header and source files are named after the class they contain with no case change. Thus there should be only one class per file, but if the classes are closely related and small enough, you can make an exception (see Query.h or TypeTraits.h for example). +Supporting headers (not relevant to end user), such as various `configure.h`, +`visibility.h` etc., which are used only internally and don't contain any +code, should have first letter of the name lowercased to distinguish them from +API headers. + Code in the root Magnum namespace is in `src/` directory, each subnamespace is in its own subdirectory. Unit tests are in `Test` subnamespace (and subdirectory). Implementation details (helper classes etc.) which shouldn't be diff --git a/src/Math/Math.h b/src/Math/Math.h index adae76dc9..c822e3d1e 100644 --- a/src/Math/Math.h +++ b/src/Math/Math.h @@ -17,7 +17,7 @@ #include -#include "Visibility.h" +#include "visibility.h" /** @file * @brief Math constants and utilities diff --git a/src/MeshTools/FlipNormals.h b/src/MeshTools/FlipNormals.h index baa79e0f0..e939bf13b 100644 --- a/src/MeshTools/FlipNormals.h +++ b/src/MeshTools/FlipNormals.h @@ -20,7 +20,7 @@ */ #include "Magnum.h" -#include "MeshToolsVisibility.h" +#include "visibilityMeshTools.h" namespace Magnum { namespace MeshTools { diff --git a/src/MeshTools/GenerateFlatNormals.h b/src/MeshTools/GenerateFlatNormals.h index fec2d00fa..bc702fc3e 100644 --- a/src/MeshTools/GenerateFlatNormals.h +++ b/src/MeshTools/GenerateFlatNormals.h @@ -22,7 +22,7 @@ #include #include "Magnum.h" -#include "MeshToolsVisibility.h" +#include "visibilityMeshTools.h" namespace Magnum { namespace MeshTools { diff --git a/src/MeshTools/Tipsify.h b/src/MeshTools/Tipsify.h index d92b972fc..11ba841b7 100644 --- a/src/MeshTools/Tipsify.h +++ b/src/MeshTools/Tipsify.h @@ -22,7 +22,7 @@ #include #include -#include "MeshToolsVisibility.h" +#include "visibilityMeshTools.h" namespace Magnum { namespace MeshTools { diff --git a/src/MeshTools/MeshToolsVisibility.h b/src/MeshTools/visibilityMeshTools.h similarity index 89% rename from src/MeshTools/MeshToolsVisibility.h rename to src/MeshTools/visibilityMeshTools.h index 9d0f795be..57c36d34e 100644 --- a/src/MeshTools/MeshToolsVisibility.h +++ b/src/MeshTools/visibilityMeshTools.h @@ -1,5 +1,5 @@ -#ifndef Magnum_MeshTools_MeshToolsVisibility_h -#define Magnum_MeshTools_MeshToolsVisibility_h +#ifndef Magnum_MeshTools_visibilityMeshTools_h +#define Magnum_MeshTools_visibilityMeshTools_h /* Copyright © 2010, 2011, 2012 Vladimír Vondruš diff --git a/src/Physics/AbstractShape.h b/src/Physics/AbstractShape.h index f64ea6f43..80aa4056a 100644 --- a/src/Physics/AbstractShape.h +++ b/src/Physics/AbstractShape.h @@ -20,7 +20,7 @@ */ #include "Magnum.h" -#include "PhysicsVisibility.h" +#include "visibilityPhysics.h" namespace Magnum { namespace Physics { diff --git a/src/Physics/PhysicsVisibility.h b/src/Physics/visibilityPhysics.h similarity index 90% rename from src/Physics/PhysicsVisibility.h rename to src/Physics/visibilityPhysics.h index 2add2c9f3..e0e1fec9d 100644 --- a/src/Physics/PhysicsVisibility.h +++ b/src/Physics/visibilityPhysics.h @@ -1,5 +1,5 @@ -#ifndef Magnum_Physics_PhysicsVisibility_h -#define Magnum_Physics_PhysicsVisibility_h +#ifndef Magnum_Physics_visibilityPhysics_h +#define Magnum_Physics_visibilityPhysics_h /* Copyright © 2010, 2011, 2012 Vladimír Vondruš diff --git a/src/Shaders/PhongShader.h b/src/Shaders/PhongShader.h index b7c3f0f6d..1f0285dc0 100644 --- a/src/Shaders/PhongShader.h +++ b/src/Shaders/PhongShader.h @@ -20,7 +20,7 @@ */ #include "AbstractShaderProgram.h" -#include "ShadersVisibility.h" +#include "visibilityShaders.h" namespace Magnum { namespace Shaders { diff --git a/src/Shaders/ShadersVisibility.h b/src/Shaders/visibilityShaders.h similarity index 90% rename from src/Shaders/ShadersVisibility.h rename to src/Shaders/visibilityShaders.h index cda87d06b..b964557a1 100644 --- a/src/Shaders/ShadersVisibility.h +++ b/src/Shaders/visibilityShaders.h @@ -1,5 +1,5 @@ -#ifndef Magnum_Shaders_ShadersVisibility_h -#define Magnum_Shaders_ShadersVisibility_h +#ifndef Magnum_Shaders_visibilityShaders_h +#define Magnum_Shaders_visibilityShaders_h /* Copyright © 2010, 2011, 2012 Vladimír Vondruš diff --git a/src/Visibility.h b/src/visibility.h similarity index 94% rename from src/Visibility.h rename to src/visibility.h index a10d6b1c8..9c96ac77d 100644 --- a/src/Visibility.h +++ b/src/visibility.h @@ -1,5 +1,5 @@ -#ifndef Magnum_Visibility_h -#define Magnum_Visibility_h +#ifndef Magnum_visibility_h +#define Magnum_visibility_h /* Copyright © 2010, 2011, 2012 Vladimír Vondruš