From 1ce0b03bf09b03fc219078a98b3c635672f3a8e4 Mon Sep 17 00:00:00 2001 From: rubidium Date: Tue, 6 May 2008 15:11:33 +0000 Subject: (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. --- src/yapf/nodelist.hpp | 2 +- src/yapf/yapf.h | 2 +- src/yapf/yapf.hpp | 2 ++ src/yapf/yapf_base.hpp | 2 +- src/yapf/yapf_common.hpp | 2 +- src/yapf/yapf_costbase.hpp | 2 ++ src/yapf/yapf_costcache.hpp | 2 +- src/yapf/yapf_costrail.hpp | 2 +- src/yapf/yapf_destrail.hpp | 2 +- src/yapf/yapf_node.hpp | 2 +- src/yapf/yapf_node_rail.hpp | 2 +- src/yapf/yapf_node_road.hpp | 2 +- src/yapf/yapf_rail.cpp | 2 +- src/yapf/yapf_road.cpp | 2 +- src/yapf/yapf_settings.h | 2 +- src/yapf/yapf_ship.cpp | 2 +- 16 files changed, 18 insertions(+), 14 deletions(-) (limited to 'src/yapf') diff --git a/src/yapf/nodelist.hpp b/src/yapf/nodelist.hpp index a174d69d8..ede2169f8 100644 --- a/src/yapf/nodelist.hpp +++ b/src/yapf/nodelist.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file nodelist.hpp */ +/** @file nodelist.hpp List of nodes used for the A-star pathfinder. */ #ifndef NODELIST_HPP #define NODELIST_HPP diff --git a/src/yapf/yapf.h b/src/yapf/yapf.h index f11ef2a40..a4c435fcf 100644 --- a/src/yapf/yapf.h +++ b/src/yapf/yapf.h @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf.h */ +/** @file yapf.h Entry point for OpenTTD to YAPF. */ #ifndef YAPF_H #define YAPF_H diff --git a/src/yapf/yapf.hpp b/src/yapf/yapf.hpp index 82ee7bfa6..bdd975e8c 100644 --- a/src/yapf/yapf.hpp +++ b/src/yapf/yapf.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf.hpp Base includes/functions for YAPF. */ + #ifndef YAPF_HPP #define YAPF_HPP diff --git a/src/yapf/yapf_base.hpp b/src/yapf/yapf_base.hpp index 1e8ea8973..f83ecbb20 100644 --- a/src/yapf/yapf_base.hpp +++ b/src/yapf/yapf_base.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_base.hpp */ +/** @file yapf_base.hpp Base classes for YAPF. */ #ifndef YAPF_BASE_HPP #define YAPF_BASE_HPP diff --git a/src/yapf/yapf_common.hpp b/src/yapf/yapf_common.hpp index b507ceb9e..b13d76fe5 100644 --- a/src/yapf/yapf_common.hpp +++ b/src/yapf/yapf_common.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_common.hpp */ +/** @file yapf_common.hpp Commonly used classes for YAPF. */ #ifndef YAPF_COMMON_HPP #define YAPF_COMMON_HPP diff --git a/src/yapf/yapf_costbase.hpp b/src/yapf/yapf_costbase.hpp index 6aef7fbd0..f48e5bade 100644 --- a/src/yapf/yapf_costbase.hpp +++ b/src/yapf/yapf_costbase.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_costbase.hpp Handling of cost determination. */ + #ifndef YAPF_COSTBASE_HPP #define YAPF_COSTBASE_HPP diff --git a/src/yapf/yapf_costcache.hpp b/src/yapf/yapf_costcache.hpp index 24e7e2dbd..964e638c3 100644 --- a/src/yapf/yapf_costcache.hpp +++ b/src/yapf/yapf_costcache.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_costcache.hpp */ +/** @file yapf_costcache.hpp Caching of segment costs. */ #ifndef YAPF_COSTCACHE_HPP #define YAPF_COSTCACHE_HPP diff --git a/src/yapf/yapf_costrail.hpp b/src/yapf/yapf_costrail.hpp index 5756f0467..eaba2fe80 100644 --- a/src/yapf/yapf_costrail.hpp +++ b/src/yapf/yapf_costrail.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_costrail.hpp */ +/** @file yapf_costrail.hpp Cost determination for rails. */ #ifndef YAPF_COSTRAIL_HPP #define YAPF_COSTRAIL_HPP diff --git a/src/yapf/yapf_destrail.hpp b/src/yapf/yapf_destrail.hpp index fab8400d1..b648642cf 100644 --- a/src/yapf/yapf_destrail.hpp +++ b/src/yapf/yapf_destrail.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_destrail.hpp */ +/** @file yapf_destrail.hpp Determining the destination for rail vehicles. */ #ifndef YAPF_DESTRAIL_HPP #define YAPF_DESTRAIL_HPP diff --git a/src/yapf/yapf_node.hpp b/src/yapf/yapf_node.hpp index 305e848a7..5857e3a7d 100644 --- a/src/yapf/yapf_node.hpp +++ b/src/yapf/yapf_node.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_node.hpp */ +/** @file yapf_node.hpp Node in the pathfinder's graph. */ #ifndef YAPF_NODE_HPP #define YAPF_NODE_HPP diff --git a/src/yapf/yapf_node_rail.hpp b/src/yapf/yapf_node_rail.hpp index 3d112888d..9745ff38d 100644 --- a/src/yapf/yapf_node_rail.hpp +++ b/src/yapf/yapf_node_rail.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_node_rail.hpp */ +/** @file yapf_node_rail.hpp Node tailored for rail pathfinding. */ #ifndef YAPF_NODE_RAIL_HPP #define YAPF_NODE_RAIL_HPP diff --git a/src/yapf/yapf_node_road.hpp b/src/yapf/yapf_node_road.hpp index ff4856c8d..8d6fd2978 100644 --- a/src/yapf/yapf_node_road.hpp +++ b/src/yapf/yapf_node_road.hpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_node_road.hpp */ +/** @file yapf_node_road.hpp Node tailored for road pathfinding. */ #ifndef YAPF_NODE_ROAD_HPP #define YAPF_NODE_ROAD_HPP diff --git a/src/yapf/yapf_rail.cpp b/src/yapf/yapf_rail.cpp index 159c097d4..ffbb1a2c1 100644 --- a/src/yapf/yapf_rail.cpp +++ b/src/yapf/yapf_rail.cpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_rail.cpp */ +/** @file yapf_rail.cpp The rail pathfinding. */ #include "../stdafx.h" diff --git a/src/yapf/yapf_road.cpp b/src/yapf/yapf_road.cpp index ce032eacd..a0ea6864f 100644 --- a/src/yapf/yapf_road.cpp +++ b/src/yapf/yapf_road.cpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_road.cpp */ +/** @file yapf_road.cpp The road pathfinding. */ #include "../stdafx.h" #include "../depot_base.h" diff --git a/src/yapf/yapf_settings.h b/src/yapf/yapf_settings.h index 0d840721d..18f7947b8 100644 --- a/src/yapf/yapf_settings.h +++ b/src/yapf/yapf_settings.h @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_settings.h */ +/** @file yapf_settings.h Penalty settings for YAPF. */ #if !defined(YAPF_SETTINGS_H) || defined(YS_DEF) diff --git a/src/yapf/yapf_ship.cpp b/src/yapf/yapf_ship.cpp index 7a58a765a..9a6f57123 100644 --- a/src/yapf/yapf_ship.cpp +++ b/src/yapf/yapf_ship.cpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file yapf_ship.cpp */ +/** @file yapf_ship.cpp Implementation of YAPF for ships. */ #include "../stdafx.h" -- cgit v1.2.3-70-g09d2