Browse Source

Renamed visibility headers to distinguish them from API headers.

Also added note about that to coding style documentation.
vectorfields
Vladimír Vondruš 14 years ago
parent
commit
4af08d04c1
  1. 7
      doc/coding-style.dox
  2. 2
      src/Math/Math.h
  3. 2
      src/MeshTools/FlipNormals.h
  4. 2
      src/MeshTools/GenerateFlatNormals.h
  5. 2
      src/MeshTools/Tipsify.h
  6. 4
      src/MeshTools/visibilityMeshTools.h
  7. 2
      src/Physics/AbstractShape.h
  8. 4
      src/Physics/visibilityPhysics.h
  9. 2
      src/Shaders/PhongShader.h
  10. 4
      src/Shaders/visibilityShaders.h
  11. 4
      src/visibility.h

7
doc/coding-style.dox

@ -11,11 +11,18 @@ Nothing is worse than rule that hurts productivity instead of improving it.
@section cpp C++ code @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 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 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 are closely related and small enough, you can make an exception (see Query.h
or TypeTraits.h for example). 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 Code in the root Magnum namespace is in `src/` directory, each subnamespace is
in its own subdirectory. Unit tests are in `Test` subnamespace (and in its own subdirectory. Unit tests are in `Test` subnamespace (and
subdirectory). Implementation details (helper classes etc.) which shouldn't be subdirectory). Implementation details (helper classes etc.) which shouldn't be

2
src/Math/Math.h

@ -17,7 +17,7 @@
#include <cstddef> #include <cstddef>
#include "Visibility.h" #include "visibility.h"
/** @file /** @file
* @brief Math constants and utilities * @brief Math constants and utilities

2
src/MeshTools/FlipNormals.h

@ -20,7 +20,7 @@
*/ */
#include "Magnum.h" #include "Magnum.h"
#include "MeshToolsVisibility.h" #include "visibilityMeshTools.h"
namespace Magnum { namespace MeshTools { namespace Magnum { namespace MeshTools {

2
src/MeshTools/GenerateFlatNormals.h

@ -22,7 +22,7 @@
#include <tuple> #include <tuple>
#include "Magnum.h" #include "Magnum.h"
#include "MeshToolsVisibility.h" #include "visibilityMeshTools.h"
namespace Magnum { namespace MeshTools { namespace Magnum { namespace MeshTools {

2
src/MeshTools/Tipsify.h

@ -22,7 +22,7 @@
#include <cstddef> #include <cstddef>
#include <vector> #include <vector>
#include "MeshToolsVisibility.h" #include "visibilityMeshTools.h"
namespace Magnum { namespace MeshTools { namespace Magnum { namespace MeshTools {

4
src/MeshTools/MeshToolsVisibility.h → src/MeshTools/visibilityMeshTools.h

@ -1,5 +1,5 @@
#ifndef Magnum_MeshTools_MeshToolsVisibility_h #ifndef Magnum_MeshTools_visibilityMeshTools_h
#define Magnum_MeshTools_MeshToolsVisibility_h #define Magnum_MeshTools_visibilityMeshTools_h
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>

2
src/Physics/AbstractShape.h

@ -20,7 +20,7 @@
*/ */
#include "Magnum.h" #include "Magnum.h"
#include "PhysicsVisibility.h" #include "visibilityPhysics.h"
namespace Magnum { namespace Physics { namespace Magnum { namespace Physics {

4
src/Physics/PhysicsVisibility.h → src/Physics/visibilityPhysics.h

@ -1,5 +1,5 @@
#ifndef Magnum_Physics_PhysicsVisibility_h #ifndef Magnum_Physics_visibilityPhysics_h
#define Magnum_Physics_PhysicsVisibility_h #define Magnum_Physics_visibilityPhysics_h
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>

2
src/Shaders/PhongShader.h

@ -20,7 +20,7 @@
*/ */
#include "AbstractShaderProgram.h" #include "AbstractShaderProgram.h"
#include "ShadersVisibility.h" #include "visibilityShaders.h"
namespace Magnum { namespace Shaders { namespace Magnum { namespace Shaders {

4
src/Shaders/ShadersVisibility.h → src/Shaders/visibilityShaders.h

@ -1,5 +1,5 @@
#ifndef Magnum_Shaders_ShadersVisibility_h #ifndef Magnum_Shaders_visibilityShaders_h
#define Magnum_Shaders_ShadersVisibility_h #define Magnum_Shaders_visibilityShaders_h
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>

4
src/Visibility.h → src/visibility.h

@ -1,5 +1,5 @@
#ifndef Magnum_Visibility_h #ifndef Magnum_visibility_h
#define Magnum_Visibility_h #define Magnum_visibility_h
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
Loading…
Cancel
Save