(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.

This commit is contained in:
rubidium
2008-05-06 15:11:33 +00:00
parent fb938a2cb3
commit d03994098b
360 changed files with 542 additions and 335 deletions

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file array.hpp */
/** @file array.hpp Array without an explicit maximum size. */
#ifndef ARRAY_HPP
#define ARRAY_HPP

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file binaryheap.hpp */
/** @file binaryheap.hpp Binary heap implementation. */
#ifndef BINARYHEAP_HPP
#define BINARYHEAP_HPP

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file blob.hpp */
/** @file blob.hpp Support for storing random binary data. */
#ifndef BLOB_HPP
#define BLOB_HPP

View File

@@ -1,5 +1,7 @@
/* $Id$ */
/** @file countedobj.cpp Support for reference counted objects. */
#include "../stdafx.h"
#include "countedptr.hpp"

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file crc32.hpp */
/** @file crc32.hpp Cyclic reduncancy check support. */
#ifndef CRC32_HPP
#define CRC32_HPP

View File

@@ -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"

View File

@@ -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

View File

@@ -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

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file hashtable.hpp */
/** @file hashtable.hpp Hash table support. */
#ifndef HASHTABLE_HPP
#define HASHTABLE_HPP

View File

@@ -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

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file str.hpp */
/** @file str.hpp String formating? */
#ifndef STR_HPP
#define STR_HPP

View File

@@ -1,6 +1,6 @@
/* $Id$ */
/** @file strapi.hpp */
/** @file strapi.hpp More string formatting? */
#ifndef STRAPI_HPP
#define STRAPI_HPP