summaryrefslogtreecommitdiff
path: root/src/misc
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
commitd03994098be29bd48f3b715c533ffac3b1315eb0 (patch)
tree6bfd044ea899467ce35f766d2c1c8a4e2df7dea9 /src/misc
parentfb938a2cb3fb7cfe6ca447dca5fc28bac78ed2e8 (diff)
downloadopenttd-d03994098be29bd48f3b715c533ffac3b1315eb0.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/misc')
-rw-r--r--src/misc/array.hpp2
-rw-r--r--src/misc/binaryheap.hpp2
-rw-r--r--src/misc/blob.hpp2
-rw-r--r--src/misc/countedobj.cpp2
-rw-r--r--src/misc/crc32.hpp2
-rw-r--r--src/misc/dbg_helpers.cpp3
-rw-r--r--src/misc/dbg_helpers.h2
-rw-r--r--src/misc/fixedsizearray.hpp2
-rw-r--r--src/misc/hashtable.hpp2
-rw-r--r--src/misc/smallvec.h2
-rw-r--r--src/misc/str.hpp2
-rw-r--r--src/misc/strapi.hpp2
12 files changed, 14 insertions, 11 deletions
diff --git a/src/misc/array.hpp b/src/misc/array.hpp
index a88b6cbe9..b5ec1e9ff 100644
--- a/src/misc/array.hpp
+++ b/src/misc/array.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file array.hpp */
+/** @file array.hpp Array without an explicit maximum size. */
#ifndef ARRAY_HPP
#define ARRAY_HPP
diff --git a/src/misc/binaryheap.hpp b/src/misc/binaryheap.hpp
index 78ebdc47f..8b55badf9 100644
--- a/src/misc/binaryheap.hpp
+++ b/src/misc/binaryheap.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file binaryheap.hpp */
+/** @file binaryheap.hpp Binary heap implementation. */
#ifndef BINARYHEAP_HPP
#define BINARYHEAP_HPP
diff --git a/src/misc/blob.hpp b/src/misc/blob.hpp
index c485e9207..441c8a027 100644
--- a/src/misc/blob.hpp
+++ b/src/misc/blob.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file blob.hpp */
+/** @file blob.hpp Support for storing random binary data. */
#ifndef BLOB_HPP
#define BLOB_HPP
diff --git a/src/misc/countedobj.cpp b/src/misc/countedobj.cpp
index 116fa3160..2de944c65 100644
--- a/src/misc/countedobj.cpp
+++ b/src/misc/countedobj.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file countedobj.cpp Support for reference counted objects. */
+
#include "../stdafx.h"
#include "countedptr.hpp"
diff --git a/src/misc/crc32.hpp b/src/misc/crc32.hpp
index 71f7ff03f..1d2f86dcd 100644
--- a/src/misc/crc32.hpp
+++ b/src/misc/crc32.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file crc32.hpp */
+/** @file crc32.hpp Cyclic reduncancy check support. */
#ifndef CRC32_HPP
#define CRC32_HPP
diff --git a/src/misc/dbg_helpers.cpp b/src/misc/dbg_helpers.cpp
index a07c5ce60..c019ce5de 100644
--- a/src/misc/dbg_helpers.cpp
+++ b/src/misc/dbg_helpers.cpp
@@ -1,6 +1,7 @@
/* $Id$ */
-/** @file dbg_helpers.cpp */
+/** @file dbg_helpers.cpp Helpers for outputting debug information. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../direction_type.h"
diff --git a/src/misc/dbg_helpers.h b/src/misc/dbg_helpers.h
index 65bf08a5c..83aa6c294 100644
--- a/src/misc/dbg_helpers.h
+++ b/src/misc/dbg_helpers.h
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dbg_helpers.h */
+/** @file dbg_helpers.h Functions to be used for debug printings. */
#ifndef DBG_HELPERS
#define DBG_HELPERS
diff --git a/src/misc/fixedsizearray.hpp b/src/misc/fixedsizearray.hpp
index d0a987e1a..10eb4eaa1 100644
--- a/src/misc/fixedsizearray.hpp
+++ b/src/misc/fixedsizearray.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file fixedsizearray.hpp */
+/** @file fixedsizearray.hpp A fixed size array that doesn't create items until needed. */
#ifndef FIXEDSIZEARRAY_HPP
#define FIXEDSIZEARRAY_HPP
diff --git a/src/misc/hashtable.hpp b/src/misc/hashtable.hpp
index fad44114d..7b93b6cd8 100644
--- a/src/misc/hashtable.hpp
+++ b/src/misc/hashtable.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file hashtable.hpp */
+/** @file hashtable.hpp Hash table support. */
#ifndef HASHTABLE_HPP
#define HASHTABLE_HPP
diff --git a/src/misc/smallvec.h b/src/misc/smallvec.h
index 35e90be97..d57f29688 100644
--- a/src/misc/smallvec.h
+++ b/src/misc/smallvec.h
@@ -1,6 +1,6 @@
/* $Id$ */
-/* @file smallvec.h */
+/** @file smallvec.h Simple vector class that allows allocating an item without the need to copy data needlessly. */
#ifndef SMALLVEC_H
#define SMALLVEC_H
diff --git a/src/misc/str.hpp b/src/misc/str.hpp
index e1138616a..93e60d441 100644
--- a/src/misc/str.hpp
+++ b/src/misc/str.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file str.hpp */
+/** @file str.hpp String formating? */
#ifndef STR_HPP
#define STR_HPP
diff --git a/src/misc/strapi.hpp b/src/misc/strapi.hpp
index 48cfb0f8c..53e0dd9e5 100644
--- a/src/misc/strapi.hpp
+++ b/src/misc/strapi.hpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file strapi.hpp */
+/** @file strapi.hpp More string formatting? */
#ifndef STRAPI_HPP
#define STRAPI_HPP