summaryrefslogtreecommitdiff
path: root/src/blitter
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-05-06 15:11:33 +0000
committerrubidium <rubidium@openttd.org>2008-05-06 15:11:33 +0000
commit1ce0b03bf09b03fc219078a98b3c635672f3a8e4 (patch)
tree6bfd044ea899467ce35f766d2c1c8a4e2df7dea9 /src/blitter
parent1b9197d6dd5b12c0bafc70d8103cd3c7c9267a99 (diff)
downloadopenttd-1ce0b03bf09b03fc219078a98b3c635672f3a8e4.tar.xz
(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
Diffstat (limited to 'src/blitter')
-rw-r--r--src/blitter/32bpp_anim.cpp2
-rw-r--r--src/blitter/32bpp_anim.hpp2
-rw-r--r--src/blitter/32bpp_base.cpp2
-rw-r--r--src/blitter/32bpp_base.hpp2
-rw-r--r--src/blitter/32bpp_optimized.cpp2
-rw-r--r--src/blitter/32bpp_optimized.hpp2
-rw-r--r--src/blitter/32bpp_simple.cpp2
-rw-r--r--src/blitter/32bpp_simple.hpp2
-rw-r--r--src/blitter/8bpp_base.cpp2
-rw-r--r--src/blitter/8bpp_base.hpp2
-rw-r--r--src/blitter/8bpp_debug.cpp2
-rw-r--r--src/blitter/8bpp_debug.hpp2
-rw-r--r--src/blitter/8bpp_optimized.cpp2
-rw-r--r--src/blitter/8bpp_optimized.hpp2
-rw-r--r--src/blitter/8bpp_simple.cpp2
-rw-r--r--src/blitter/8bpp_simple.hpp2
-rw-r--r--src/blitter/base.hpp2
-rw-r--r--src/blitter/factory.hpp2
-rw-r--r--src/blitter/null.hpp2
19 files changed, 26 insertions, 12 deletions
diff --git a/src/blitter/32bpp_anim.cpp b/src/blitter/32bpp_anim.cpp
index 924803be9..ccbc38af9 100644
--- a/src/blitter/32bpp_anim.cpp
+++ b/src/blitter/32bpp_anim.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_anim.cpp Implementation of the optimized 32 bpp blitter with animation support. */
+
#include "../stdafx.h"
#include "../core/alloc_func.hpp"
#include "../gfx_func.h"
diff --git a/src/blitter/32bpp_anim.hpp b/src/blitter/32bpp_anim.hpp
index 255cca48b..373253deb 100644
--- a/src/blitter/32bpp_anim.hpp
+++ b/src/blitter/32bpp_anim.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_anim.hpp */
+/** @file 32bpp_anim.hpp A 32 bpp blitter with animation support. */
#ifndef BLITTER_32BPP_ANIM_HPP
#define BLITTER_32BPP_ANIM_HPP
diff --git a/src/blitter/32bpp_base.cpp b/src/blitter/32bpp_base.cpp
index 0358ae5dc..eddec74ff 100644
--- a/src/blitter/32bpp_base.cpp
+++ b/src/blitter/32bpp_base.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_base.cpp Implementation of base for 32 bpp blitters. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "32bpp_base.hpp"
diff --git a/src/blitter/32bpp_base.hpp b/src/blitter/32bpp_base.hpp
index 5a664cd0b..dca8728ad 100644
--- a/src/blitter/32bpp_base.hpp
+++ b/src/blitter/32bpp_base.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_base.hpp */
+/** @file 32bpp_base.hpp Base for all 32 bits blitters. */
#ifndef BLITTER_32BPP_BASE_HPP
#define BLITTER_32BPP_BASE_HPP
diff --git a/src/blitter/32bpp_optimized.cpp b/src/blitter/32bpp_optimized.cpp
index f4be19926..c0958b0e9 100644
--- a/src/blitter/32bpp_optimized.cpp
+++ b/src/blitter/32bpp_optimized.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_optimized.cpp Implementation of the optimized 32 bpp blitter. */
+
#include "../stdafx.h"
#include "../zoom_func.h"
#include "../gfx_func.h"
diff --git a/src/blitter/32bpp_optimized.hpp b/src/blitter/32bpp_optimized.hpp
index d437dcdab..46c30ec25 100644
--- a/src/blitter/32bpp_optimized.hpp
+++ b/src/blitter/32bpp_optimized.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_optimized.hpp */
+/** @file 32bpp_optimized.hpp Optimized 32 bpp blitter. */
#ifndef BLITTER_32BPP_OPTIMIZED_HPP
#define BLITTER_32BPP_OPTIMIZED_HPP
diff --git a/src/blitter/32bpp_simple.cpp b/src/blitter/32bpp_simple.cpp
index b5fa3f06d..0d60a7234 100644
--- a/src/blitter/32bpp_simple.cpp
+++ b/src/blitter/32bpp_simple.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_simple.cpp Implementation of the simple 32 bpp blitter. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "../zoom_func.h"
diff --git a/src/blitter/32bpp_simple.hpp b/src/blitter/32bpp_simple.hpp
index 448b819bf..5ca965b27 100644
--- a/src/blitter/32bpp_simple.hpp
+++ b/src/blitter/32bpp_simple.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_simple.hpp */
+/** @file 32bpp_simple.hpp Simple 32 bpp blitter. */
#ifndef BLITTER_32BPP_SIMPLE_HPP
#define BLITTER_32BPP_SIMPLE_HPP
diff --git a/src/blitter/8bpp_base.cpp b/src/blitter/8bpp_base.cpp
index 7b813f6e7..78bb90f5e 100644
--- a/src/blitter/8bpp_base.cpp
+++ b/src/blitter/8bpp_base.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 8bpp_base.cpp Implementation of the base for all 8 bpp blitters. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "8bpp_base.hpp"
diff --git a/src/blitter/8bpp_base.hpp b/src/blitter/8bpp_base.hpp
index b437a080b..eecd6e139 100644
--- a/src/blitter/8bpp_base.hpp
+++ b/src/blitter/8bpp_base.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_base.hpp */
+/** @file 8bpp_base.hpp Base for all 8 bpp blitters. */
#ifndef BLITTER_8BPP_BASE_HPP
#define BLITTER_8BPP_BASE_HPP
diff --git a/src/blitter/8bpp_debug.cpp b/src/blitter/8bpp_debug.cpp
index d084965a1..3ce0600c3 100644
--- a/src/blitter/8bpp_debug.cpp
+++ b/src/blitter/8bpp_debug.cpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_debug.cpp */
+/** @file 8bpp_debug.cpp Implementation of 8 bpp debug blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
diff --git a/src/blitter/8bpp_debug.hpp b/src/blitter/8bpp_debug.hpp
index e140d0db5..688391bd0 100644
--- a/src/blitter/8bpp_debug.hpp
+++ b/src/blitter/8bpp_debug.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_debug.hpp */
+/** @file 8bpp_debug.hpp A 8 bpp blitter that uses random colours to show the drawn sprites. */
#ifndef BLITTER_8BPP_DEBUG_HPP
#define BLITTER_8BPP_DEBUG_HPP
diff --git a/src/blitter/8bpp_optimized.cpp b/src/blitter/8bpp_optimized.cpp
index 7b7165975..a230b6015 100644
--- a/src/blitter/8bpp_optimized.cpp
+++ b/src/blitter/8bpp_optimized.cpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_optimized.cpp */
+/** @file 8bpp_optimized.cpp Implementation of the optimized 8 bpp blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
diff --git a/src/blitter/8bpp_optimized.hpp b/src/blitter/8bpp_optimized.hpp
index 4dfe91604..d377b522a 100644
--- a/src/blitter/8bpp_optimized.hpp
+++ b/src/blitter/8bpp_optimized.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_optimized.hpp */
+/** @file 8bpp_optimized.hpp An optimized 8 bpp blitter. */
#ifndef BLITTER_8BPP_OPTIMIZED_HPP
#define BLITTER_8BPP_OPTIMIZED_HPP
diff --git a/src/blitter/8bpp_simple.cpp b/src/blitter/8bpp_simple.cpp
index 77698cb1c..5bef7927f 100644
--- a/src/blitter/8bpp_simple.cpp
+++ b/src/blitter/8bpp_simple.cpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_simple.cpp */
+/** @file 8bpp_simple.cpp Implementation of the simple 8 bpp blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
diff --git a/src/blitter/8bpp_simple.hpp b/src/blitter/8bpp_simple.hpp
index 9ab78db64..49278f970 100644
--- a/src/blitter/8bpp_simple.hpp
+++ b/src/blitter/8bpp_simple.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_simple.hpp */
+/** @file 8bpp_simple.hpp Simple (and slow) 8 bpp blitter. */
#ifndef BLITTER_8BPP_SIMPLE_HPP
#define BLITTER_8BPP_SIMPLE_HPP
diff --git a/src/blitter/base.hpp b/src/blitter/base.hpp
index cefaaa29f..6a4e4196a 100644
--- a/src/blitter/base.hpp
+++ b/src/blitter/base.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file base.hpp Base for all blitters. */
+
#ifndef BLITTER_BASE_HPP
#define BLITTER_BASE_HPP
diff --git a/src/blitter/factory.hpp b/src/blitter/factory.hpp
index 6b4a71a72..e991ed8d6 100644
--- a/src/blitter/factory.hpp
+++ b/src/blitter/factory.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file factory.hpp Factory to 'query' all available blitters. */
+
#ifndef BLITTER_FACTORY_HPP
#define BLITTER_FACTORY_HPP
diff --git a/src/blitter/null.hpp b/src/blitter/null.hpp
index 326155551..d9589bd51 100644
--- a/src/blitter/null.hpp
+++ b/src/blitter/null.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file null.hpp */
+/** @file null.hpp The blitter that doesn't blit. */
#ifndef BLITTER_NULL_HPP
#define BLITTER_NULL_HPP