From ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 1 Aug 2010 19:22:34 +0000 Subject: (svn r20283) -Codechange: Unify start of doygen comments. --- src/pathfinder/npf/aystar.h | 3 ++- src/pathfinder/npf/queue.cpp | 3 ++- src/pathfinder/npf/queue.h | 15 ++++++++++----- 3 files changed, 14 insertions(+), 7 deletions(-) (limited to 'src/pathfinder/npf') diff --git a/src/pathfinder/npf/aystar.h b/src/pathfinder/npf/aystar.h index 5be2dd3e4..864cdd486 100644 --- a/src/pathfinder/npf/aystar.h +++ b/src/pathfinder/npf/aystar.h @@ -7,7 +7,8 @@ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see . */ -/** @file aystar.h +/** + * @file aystar.h * This file has the header for AyStar * AyStar is a fast pathfinding routine and is used for things like * AI_pathfinding and Train_pathfinding. diff --git a/src/pathfinder/npf/queue.cpp b/src/pathfinder/npf/queue.cpp index d4850a0fc..791cbfe38 100644 --- a/src/pathfinder/npf/queue.cpp +++ b/src/pathfinder/npf/queue.cpp @@ -435,7 +435,8 @@ void clear_Hash(Hash *h, bool free_values) h->size = 0; } -/** Finds the node that that saves this key pair. If it is not +/** + * Finds the node that that saves this key pair. If it is not * found, returns NULL. If it is found, *prev is set to the * node before the one found, or if the node found was the first in the bucket * to NULL. If it is not found, *prev is set to the last HashNode in the diff --git a/src/pathfinder/npf/queue.h b/src/pathfinder/npf/queue.h index 1d94ac740..3f042b7ad 100644 --- a/src/pathfinder/npf/queue.h +++ b/src/pathfinder/npf/queue.h @@ -98,7 +98,8 @@ void init_InsSort(Queue *q); /* The amount of elements that will be malloc'd at a time */ #define BINARY_HEAP_BLOCKSIZE_BITS 10 -/** Initializes a binary heap and allocates internal memory for maximum of +/** + * Initializes a binary heap and allocates internal memory for maximum of * max_size elements */ void init_BinaryHeap(Queue *q, uint max_size); @@ -133,20 +134,24 @@ struct Hash { /* Call these function to manipulate a hash */ -/** Deletes the value with the specified key pair from the hash and returns +/** + * Deletes the value with the specified key pair from the hash and returns * that value. Returns NULL when the value was not present. The value returned * is _not_ free()'d! */ void *Hash_Delete(Hash *h, uint key1, uint key2); -/** Sets the value associated with the given key pair to the given value. +/** + * Sets the value associated with the given key pair to the given value. * Returns the old value if the value was replaced, NULL when it was not yet present. */ void *Hash_Set(Hash *h, uint key1, uint key2, void *value); -/** Gets the value associated with the given key pair, or NULL when it is not +/** + * Gets the value associated with the given key pair, or NULL when it is not * present. */ void *Hash_Get(const Hash *h, uint key1, uint key2); /* Call these function to create/destroy a hash */ -/** Builds a new hash in an existing struct. Make sure that hash() always +/** + * Builds a new hash in an existing struct. Make sure that hash() always * returns a hash less than num_buckets! Call delete_hash after use */ void init_Hash(Hash *h, Hash_HashProc *hash, uint num_buckets); /** -- cgit v1.2.3-54-g00ecf