Simplify the overly-complex CppDoc-breaking file headers

This was SVN commit r6832.

source/graphics/Camera.cpp

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CCamera holds a view and a projection matrix. It also has a frustum
- * File        : Camera.cpp
+ * which can be used to cull objects for rendering.
- * Project     : 0 A.D.
- * Description : CCamera holds a view and a projection matrix. It also has
- *               a frustum which can be used to cull objects for rendering.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/Camera.h

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CCamera holds a view and a projection matrix. It also has a frustum
- * File        : Camera.h
+ * which can be used to cull objects for rendering.
- * Project     : 0 A.D.
- * Description : CCamera holds a view and a projection matrix. It also has
- *               a frustum which can be used to cull objects for rendering.
- * =========================================================================
  */
 
 #ifndef INCLUDED_CAMERA

source/graphics/Color.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Convert float RGB(A) colors to unsigned byte
- * File        : Color.cpp
- * Project     : 0 A.D.
- * Description : Convert float RGB(A) colors to unsigned byte
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/Color.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Convert float RGB(A) colors to unsigned byte
- * File        : Color.h
- * Project     : 0 A.D.
- * Description : Convert float RGB(A) colors to unsigned byte
- * =========================================================================
  */
 
 #ifndef INCLUDED_COLOR

source/graphics/DefaultEmitter.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Default particle emitter implementation.
- * File        : DefaultEmitter.cpp
- * Project     : 0 A.D.
- * Description : Default particle emitter implementation.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/DefaultEmitter.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Default particle emitter implementation.
- * File        : DefaultEmitter.h
- * Project     : 0 A.D.
- * Description : Default particle emitter implementation.
- * =========================================================================
  */
 
 #ifndef INCLUDED_DEFAULTEMITTER

source/graphics/Frustum.cpp

@@ -15,13 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CFrustum is a collection of planes which define a viewing space.
- * File        : Frustum.cpp
- * Project     : 0 A.D.
- * Description : CFrustum is a collection of planes which define
- *               a viewing space.
- * =========================================================================
  */
 
 /*

source/graphics/Frustum.h

@@ -15,13 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CFrustum is a collection of planes which define a viewing space.
- * File        : Frustum.cpp
- * Project     : 0 A.D.
- * Description : CFrustum is a collection of planes which define
- *               a viewing space.
- * =========================================================================
  */
 
 /*

source/graphics/HFTracer.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Determine intersection of rays with a heightfield.
- * File        : HFTracer.cpp
- * Project     : 0 A.D.
- * Description : Determine intersection of rays with a heightfield.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/HFTracer.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Determine intersection of rays with a heightfield.
- * File        : HFTracer.h
- * Project     : 0 A.D.
- * Description : Determine intersection of rays with a heightfield.
- * =========================================================================
  */
 
 #ifndef INCLUDED_HFTRACER

source/graphics/LightEnv.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CLightEnv implementation
- * File        : LightEnv.cpp
- * Project     : Pyrogenesis
- * Description : CLightEnv implementation
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/LightEnv.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * CLightEnv, a class describing the current lights
- * File        : LightEnv.h
- * Project     : Pyrogenesis
- * Description : CLightEnv, a class describing the current lights
- * =========================================================================
  */
 
 #ifndef INCLUDED_LIGHTENV

source/graphics/MiniPatch.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Definition of a single terrain tile
- * File        : MiniPatch.cpp
- * Project     : 0 A.D.
- * Description : Definition of a single terrain tile
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/MiniPatch.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Definition of a single terrain tile
- * File        : MiniPatch.h
- * Project     : 0 A.D.
- * Description : Definition of a single terrain tile
- * =========================================================================
  */
 
 #ifndef INCLUDED_MINIPATCH

source/graphics/Model.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Mesh object with texture and skinning information
- * File        : Model.cpp
- * Project     : 0 A.D.
- * Description : Mesh object with texture and skinning information
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/Model.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Mesh object with texture and skinning information
- * File        : Model.h
- * Project     : 0 A.D.
- * Description : Mesh object with texture and skinning information
- * =========================================================================
  */
 
 #ifndef INCLUDED_MODEL

source/graphics/ModelDef.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Defines a raw 3d model.
- * File        : ModelDef.cpp
- * Project     : 0 A.D.
- * Description : Defines a raw 3d model.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/ModelDef.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Defines a raw 3d model.
- * File        : ModelDef.h
- * Project     : 0 A.D.
- * Description : Defines a raw 3d model.
- * =========================================================================
  */
 
 #ifndef INCLUDED_MODELDEF

source/graphics/ParticleEmitter.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Particle and Emitter base classes.
- * File        : ParticleEmitter.cpp
- * Project     : 0 A.D.
- * Description : Particle and Emitter base classes.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/ParticleEmitter.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Particle and Emitter base classes.
- * File        : ParticleEmitter.h
- * Project     : 0 A.D.
- * Description : Particle and Emitter base classes.
- * =========================================================================
  */
 
 #ifndef INCLUDED_PARTICLEEMITTER

source/graphics/ParticleEngine.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Particle engine implementation
- * File        : ParticleEngine.cpp
- * Project     : 0 A.D.
- * Description : Particle engine implementation
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/ParticleEngine.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Particle engine implementation
- * File        : ParticleEngine.h
- * Project     : 0 A.D.
- * Description : Particle engine implementation
- * =========================================================================
  */
 
 #ifndef INCLUDED_PARTICLEENGINE

source/graphics/Patch.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * A patch of terrain holding NxN MiniPatch tiles
- * File        : Patch.cpp
- * Project     : 0 A.D.
- * Description : A patch of terrain holding NxN MiniPatch tiles
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/Patch.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * A patch of terrain holding NxN MiniPatch tiles
- * File        : Patch.h
- * Project     : 0 A.D.
- * Description : A patch of terrain holding NxN MiniPatch tiles
- * =========================================================================
  */
 
 #ifndef INCLUDED_PATCH

source/graphics/RenderableObject.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Base class for renderable objects
- * File        : RenderableObject.h
- * Project     : 0 A.D.
- * Description : Base class for renderable objects
- * =========================================================================
  */
 
 #ifndef INCLUDED_RENDERABLEOBJECT

source/graphics/SkeletonAnim.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Instance of CSkeletonAnimDef for application onto a model
- * File        : SkeletonAnim.h
- * Project     : 0 A.D.
- * Description : Instance of CSkeletonAnimDef for application onto a model
- * =========================================================================
  */
 
 #ifndef INCLUDED_SKELETONANIM

source/graphics/SkeletonAnimDef.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Raw description of a skeleton animation
- * File        : SkeletonAnim.cpp
- * Project     : 0 A.D.
- * Description : Raw description of a skeleton animation
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/SkeletonAnimDef.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Raw description of a skeleton animation
- * File        : SkeletonAnim.h
- * Project     : 0 A.D.
- * Description : Raw description of a skeleton animation
- * =========================================================================
  */
 
 #ifndef INCLUDED_SKELETONANIMDEF

source/graphics/SkeletonAnimManager.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Owner of all skeleton animations
- * File        : SkeletonAnimManager.cpp
- * Project     : 0 A.D.
- * Description : Owner of all skeleton animations
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/SkeletonAnimManager.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Owner of all skeleton animations
- * File        : SkeletonAnimManager.h
- * Project     : 0 A.D.
- * Description : Owner of all skeleton animations
- * =========================================================================
  */
 
 #ifndef INCLUDED_SKELETONANIMMANAGER

source/graphics/Sprite.cpp

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Billboarding sprite class - always faces the camera. It does this by
- * File        : Sprite.h
+ * getting the current model view matrix state.
- * Project     : 0 A.D.
- * Description : Billboarding sprite class - always faces the camera. It
- *               does this by getting the current model view matrix state.
- * =========================================================================
  */
 
 // Usage: Instantiate, then be sure to pass a loaded

source/graphics/Sprite.h

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Billboarding sprite class - always faces the camera. It does this by
- * File        : Sprite.h
+ * getting the current model view matrix state.
- * Project     : 0 A.D.
- * Description : Billboarding sprite class - always faces the camera. It
- *               does this by getting the current model view matrix state.
- * =========================================================================
  */
 
 // Usage: Instantiate, then be sure to pass a loaded

source/graphics/Terrain.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Describes ground via heightmap and array of CPatch.
- * File        : Terrain.cpp
- * Project     : 0 A.D.
- * Description : Describes ground via heightmap and array of CPatch.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/Terrain.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Describes ground via heightmap and array of CPatch.
- * File        : Terrain.h
- * Project     : 0 A.D.
- * Description : Describes ground via heightmap and array of CPatch.
- * =========================================================================
  */
 
 #ifndef INCLUDED_TERRAIN

source/graphics/UnitManager.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Container that owns all units
- * File        : UnitManager.cpp
- * Project     : 0 A.D.
- * Description : Container that owns all units
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/UnitManager.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Container that owns all units
- * File        : UnitManager.h
- * Project     : 0 A.D.
- * Description : Container that owns all units
- * =========================================================================
  */
 
 #ifndef INCLUDED_UNITMANAGER

source/graphics/scripting/JSInterface_LightEnv.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Provide the LightEnv object type for JavaScript
- * File        : JSInterface_LightEnv.cpp
- * Project     : Pyrogenesis
- * Description : Provide the LightEnv object type for JavaScript
- * =========================================================================
  */
 
 #include "precompiled.h"

source/graphics/scripting/JSInterface_LightEnv.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Provide the LightEnv object type for JavaScript
- * File        : JSInterface_LightEnv.h
- * Project     : Pyrogenesis
- * Description : Provide the LightEnv object type for JavaScript
- * =========================================================================
  */
 
 #ifndef INCLUDED_JSI_LIGHTENV

source/lib/adts.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * useful Abstract Data Types not provided by STL.
- * File        : adts.h
- * Project     : 0 A.D.
- * Description : useful Abstract Data Types not provided by STL.
- * =========================================================================
  */
 
 #ifndef INCLUDED_ADTS

source/lib/allocators/aligned_allocator.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * STL allocator for aligned memory
- * File        : aligned_allocator.cpp
- * Project     : 0 A.D.
- * Description : STL allocator for aligned memory
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/aligned_allocator.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * STL allocator for aligned memory
- * File        : aligned_allocator.h
- * Project     : 0 A.D.
- * Description : STL allocator for aligned memory
- * =========================================================================
  */
 
 #ifndef ALIGNED_ALLOCATOR

source/lib/allocators/allocators.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * memory suballocators.
- * File        : allocators.cpp
- * Project     : 0 A.D.
- * Description : memory suballocators.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/allocators.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * memory suballocators.
- * File        : allocators.h
- * Project     : 0 A.D.
- * Description : memory suballocators.
- * =========================================================================
  */
 
 #ifndef INCLUDED_ALLOCATORS

source/lib/allocators/bucket.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bucket allocator
- * File        : bucket.cpp
- * Project     : 0 A.D.
- * Description : bucket allocator
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/bucket.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bucket allocator
- * File        : bucket.h
- * Project     : 0 A.D.
- * Description : bucket allocator
- * =========================================================================
  */
 
 #ifndef INCLUDED_BUCKET

source/lib/allocators/dynarray.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * dynamic (expandable) array
- * File        : dynarray.cpp
- * Project     : 0 A.D.
- * Description : dynamic (expandable) array
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/dynarray.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * dynamic (expandable) array
- * File        : dynarray.h
- * Project     : 0 A.D.
- * Description : dynamic (expandable) array
- * =========================================================================
  */
 
 #ifndef INCLUDED_DYNARRAY

source/lib/allocators/headerless.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * (header-.less) pool-based heap allocator
- * File        : headerless.cpp
- * Project     : 0 A.D.
- * Description : (header-.less) pool-based heap allocator
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/headerless.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * (header-less) pool-based heap allocator
- * File        : headerless.h
- * Project     : 0 A.D.
- * Description : (header-less) pool-based heap allocator
- * =========================================================================
  */
 
 #ifndef INCLUDED_HEADERLESS

source/lib/allocators/mem_util.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * memory allocator helper routines.
- * File        : mem_util.cpp
- * Project     : 0 A.D.
- * Description : memory allocator helper routines.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/mem_util.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * memory allocator helper routines.
- * File        : mem_util.h
- * Project     : 0 A.D.
- * Description : memory allocator helper routines.
- * =========================================================================
  */
 
 #ifndef INCLUDED_MEM_UTIL

source/lib/allocators/pool.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * pool allocator
- * File        : pool.cpp
- * Project     : 0 A.D.
- * Description : pool allocator
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/pool.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * pool allocator
- * File        : pool.h
- * Project     : 0 A.D.
- * Description : pool allocator
- * =========================================================================
  */
 
 #ifndef INCLUDED_POOL

source/lib/allocators/string_pool.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * shared storage for strings
- * File        : string_pool.cpp
- * Project     : 0 A.D.
- * Description : shared storage for strings
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/allocators/string_pool.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * shared storage for strings
- * File        : string_pool.h
- * Project     : 0 A.D.
- * Description : shared storage for strings
- * =========================================================================
  */
 
 #ifndef INCLUDED_STRING_POOL

source/lib/app_hooks.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * hooks to allow customization / app-specific behavior.
- * File        : app_hooks.cpp
- * Project     : 0 A.D.
- * Description : hooks to allow customization / app-specific behavior.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/app_hooks.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * hooks to allow customization / app-specific behavior.
- * File        : app_hooks.h
- * Project     : 0 A.D.
- * Description : hooks to allow customization / app-specific behavior.
- * =========================================================================
  */
 
 /*

source/lib/base32.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * base32 conversion
- * File        : base32.cpp
- * Project     : 0 A.D.
- * Description : base32 conversion
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/base32.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * base32 conversion
- * File        : base32.h
- * Project     : 0 A.D.
- * Description : base32 conversion
- * =========================================================================
  */
 
 #ifndef INCLUDED_BASE32

source/lib/bits.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bit-twiddling.
- * File        : bits.cpp
- * Project     : 0 A.D.
- * Description : bit-twiddling.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/bits.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bit-twiddling.
- * File        : bits.h
- * Project     : 0 A.D.
- * Description : bit-twiddling.
- * =========================================================================
  */
 
 #ifndef INCLUDED_BITS

source/lib/byte_order.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * byte order (endianness) support routines.
- * File        : byte_order.cpp
- * Project     : 0 A.D.
- * Description : byte order (endianness) support routines.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/byte_order.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * byte order (endianness) support routines.
- * File        : byte_order.h
- * Project     : 0 A.D.
- * Description : byte order (endianness) support routines.
- * =========================================================================
  */
 
 #ifndef INCLUDED_BYTE_ORDER

source/lib/cache_adt.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * Customizable cache data structure.
- * File        : cache_adt.h
- * Project     : 0 A.D.
- * Description : Customizable cache data structure.
- * =========================================================================
  */
 
 #ifndef INCLUDED_CACHE_ADT

source/lib/code_annotation.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * macros for code annotation.
- * File        : code_annotation.h
- * Project     : 0 A.D.
- * Description : macros for code annotation.
- * =========================================================================
  */
 
 #ifndef INCLUDED_CODE_ANNOTATION

source/lib/config.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * compile-time configuration for the entire project
- * File        : config.h
- * Project     : 0 A.D.
- * Description : compile-time configuration for the entire project
- * =========================================================================
  */
 
 #ifndef INCLUDED_CONFIG

source/lib/config2.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * compile-time configuration for isolated spots
- * File        : config2.h
- * Project     : 0 A.D.
- * Description : compile-time configuration for isolated spots
- * =========================================================================
  */
 
 #ifndef INCLUDED_CONFIG2

source/lib/debug.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * platform-independent debug support code.
- * File        : debug.cpp
- * Project     : 0 A.D.
- * Description : platform-independent debug support code.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/debug.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * platform-independent debug support code.
- * File        : debug.h
- * Project     : 0 A.D.
- * Description : platform-independent debug support code.
- * =========================================================================
  */
 
 #ifndef INCLUDED_DEBUG

source/lib/debug_stl.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * portable debugging helper functions specific to the STL.
- * File        : debug_stl.cpp
- * Project     : 0 A.D.
- * Description : portable debugging helper functions specific to the STL.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/debug_stl.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * portable debugging helper functions specific to the STL.
- * File        : debug_stl.h
- * Project     : 0 A.D.
- * Description : portable debugging helper functions specific to the STL.
- * =========================================================================
  */
 
 #ifndef INCLUDED_DEBUG_STL

source/lib/external_libraries/boost_filesystem.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in Boost filesystem library
- * File        : boost_filesystem.h
- * Project     : 0 A.D.
- * Description : bring in Boost filesystem library
- * =========================================================================
  */
 
 #ifndef INCLUDED_BOOST_FILESYSTEM

source/lib/external_libraries/dbghelp.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in dbghelp library
- * File        : dbghelp.h
- * Project     : 0 A.D.
- * Description : bring in dbghelp library
- * =========================================================================
  */
 
 #ifndef INCLUDED_DBGHELP

source/lib/external_libraries/libjpeg.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in libjpeg header+library, with compatibility fixes
- * File        : libjpeg.h
- * Project     : 0 A.D.
- * Description : bring in libjpeg header+library, with compatibility fixes
- * =========================================================================
  */
 
 #ifndef INCLUDED_LIBJPEG

source/lib/external_libraries/openal.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in OpenAL header+library, with compatibility fixes
- * File        : openal.h
- * Project     : 0 A.D.
- * Description : bring in OpenAL header+library, with compatibility fixes
- * =========================================================================
  */
 
 #ifndef INCLUDED_OPENAL

source/lib/external_libraries/png.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in LibPNG header+library, with compatibility fixes
- * File        : png.h
- * Project     : 0 A.D.
- * Description : bring in LibPNG header+library, with compatibility fixes
- * =========================================================================
  */
 
 #ifndef INCLUDED_PNG

source/lib/external_libraries/sdl.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * SDL header; uses emulator on Windows, otherwise libsdl.
- * File        : sdl.h
- * Project     : 0 A.D.
- * Description : SDL header; uses emulator on Windows, otherwise libsdl.
- * =========================================================================
  */
 
 #ifndef INCLUDED_SDL

source/lib/external_libraries/sdl_fwd.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * forward declaration of SDL_Event
- * File        : sdl_fwd.h
- * Project     : 0 A.D.
- * Description : forward declaration of SDL_Event
- * =========================================================================
  */
 
 #ifndef INCLUDED_SDL_FWD

source/lib/external_libraries/wxwidgets.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in wxWidgets headers, with compatibility fixes
- * File        : wxwidgets.h
- * Project     : 0 A.D.
- * Description : bring in wxWidgets headers, with compatibility fixes
- * =========================================================================
  */
 
 #ifndef INCLUDED_WXWIDGETS

source/lib/external_libraries/zlib.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * bring in ZLib header+library, with compatibility fixes
- * File        : zlib.h
- * Project     : 0 A.D.
- * Description : bring in ZLib header+library, with compatibility fixes
- * =========================================================================
  */
 
 #ifndef INCLUDED_ZLIB

source/lib/fat_time.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * timestamp conversion: DOS FAT <-> Unix time_t
- * File        : fat_time.cpp
- * Project     : 0 A.D.
- * Description : timestamp conversion: DOS FAT <-> Unix time_t
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/archive.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * interface for reading from and creating archives.
- * File        : archive.cpp
- * Project     : 0 A.D.
- * Description : interface for reading from and creating archives.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/archive.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * interface for reading from and creating archives.
- * File        : archive.h
- * Project     : 0 A.D.
- * Description : interface for reading from and creating archives.
- * =========================================================================
  */
 
 #ifndef INCLUDED_ARCHIVE

source/lib/file/archive/archive_builder.cpp

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * automatically bundles files into archives in order of access to
- * File        : vfs_optimizer.cpp
+ * optimize I/O.
- * Project     : 0 A.D.
- * Description : automatically bundles files into archives in order of
- *             : access to optimize I/O.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/archive_builder.h

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * automatically bundles files into archives in order of access to
- * File        : vfs_optimizer.h
+ * optimize I/O.
- * Project     : 0 A.D.
- * Description : automatically bundles files into archives in order of
- *             : access to optimize I/O.
- * =========================================================================
  */
 
 #ifndef INCLUDED_VFS_OPTIMIZER

source/lib/file/archive/archive_zip.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * archive backend for Zip files.
- * File        : archive_zip.cpp
- * Project     : 0 A.D.
- * Description : archive backend for Zip files.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/archive_zip.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * archive backend for Zip files.
- * File        : archive_zip.h
- * Project     : 0 A.D.
- * Description : archive backend for Zip files.
- * =========================================================================
  */
 
 #ifndef INCLUDED_ARCHIVE_ZIP

source/lib/file/archive/codec.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : codec.cpp
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/codec.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : codec.h
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #ifndef INCLUDED_CODEC

source/lib/file/archive/stream.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : stream.cpp
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/archive/stream.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : stream.cpp
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #ifndef INCLUDED_STREAM

source/lib/file/common/file_stats.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * gathers statistics from all file modules.
- * File        : file_stats.cpp
- * Project     : 0 A.D.
- * Description : gathers statistics from all file modules.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/common/file_stats.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * gathers statistics from all file modules.
- * File        : file_stats.h
- * Project     : 0 A.D.
- * Description : gathers statistics from all file modules.
- * =========================================================================
  */
 
 #ifndef INCLUDED_FILE_STATS

source/lib/file/common/trace.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * IO event recording
- * File        : trace.cpp
- * Project     : 0 A.D.
- * Description : IO event recording
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/common/trace.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * IO event recording
- * File        : trace.h
- * Project     : 0 A.D.
- * Description : IO event recording
- * =========================================================================
  */
 
 // traces are useful for determining the optimal ordering of archived files

source/lib/file/file.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * simple POSIX file wrapper.
- * File        : file.cpp
- * Project     : 0 A.D.
- * Description : simple POSIX file wrapper.
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/file.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * simple POSIX file wrapper.
- * File        : file.h
- * Project     : 0 A.D.
- * Description : simple POSIX file wrapper.
- * =========================================================================
  */
 
 #ifndef INCLUDED_FILE

source/lib/file/file_system.cpp

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : file_system.cpp
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #include "precompiled.h"

source/lib/file/file_system.h

@@ -15,12 +15,8 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+
- * File        : file_system.h
- * Project     : 0 A.D.
- * Description : 
- * =========================================================================
  */
 
 #ifndef INCLUDED_FILE_SYSTEM

source/lib/file/file_system_posix.cpp

@@ -15,13 +15,9 @@
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
+/*
- * =========================================================================
+ * file layer on top of POSIX. avoids the need for absolute paths and
- * File        : directory_posix.cpp
+ * provides fast I/O.
- * Project     : 0 A.D.
- * Description : file layer on top of POSIX. avoids the need for
- *             : absolute paths and provides fast I/O.
- * =========================================================================
  */
 
 #include "precompiled.h"