(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

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

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

src/yapf/yapf.hpp

@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file yapf.hpp Base includes/functions for YAPF. */
+
 #ifndef  YAPF_HPP
 #define  YAPF_HPP
 

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

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

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
 

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

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

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

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

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

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

src/yapf/yapf_rail.cpp

@@ -1,6 +1,6 @@
 /* $Id$ */
 
-/** @file yapf_rail.cpp */
+/** @file yapf_rail.cpp The rail pathfinding. */
 
 #include "../stdafx.h"
 

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"

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)
 

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"