summaryrefslogtreecommitdiff
path: root/src/yapf
diff options
context:
space:
mode:
authorcelestar <celestar@openttd.org>2007-02-23 08:37:33 +0000
committercelestar <celestar@openttd.org>2007-02-23 08:37:33 +0000
commit0ed4b64e649349f695a1942e0fa09b8b564e1774 (patch)
treeffbf65a36988c29feee223c710b66030721b7952 /src/yapf
parent798c95a2284ced6a52ed00e5a273965971f364a2 (diff)
downloadopenttd-0ed4b64e649349f695a1942e0fa09b8b564e1774.tar.xz
(svn r8857) -Documentation: Added some doxygen @file tags, repaired others (the @file tag MUST be found before any line of code, that includes preprocessor directives).
Diffstat (limited to 'src/yapf')
-rw-r--r--src/yapf/follow_track.hpp2
-rw-r--r--src/yapf/nodelist.hpp2
-rw-r--r--src/yapf/yapf.h2
-rw-r--r--src/yapf/yapf_base.hpp2
-rw-r--r--src/yapf/yapf_common.hpp2
-rw-r--r--src/yapf/yapf_costcache.hpp3
-rw-r--r--src/yapf/yapf_costrail.hpp2
-rw-r--r--src/yapf/yapf_destrail.hpp2
-rw-r--r--src/yapf/yapf_node.hpp2
-rw-r--r--src/yapf/yapf_node_rail.hpp2
-rw-r--r--src/yapf/yapf_node_road.hpp2
-rw-r--r--src/yapf/yapf_rail.cpp2
-rw-r--r--src/yapf/yapf_road.cpp2
-rw-r--r--src/yapf/yapf_settings.h3
-rw-r--r--src/yapf/yapf_ship.cpp2
15 files changed, 32 insertions, 0 deletions
diff --git a/src/yapf/follow_track.hpp b/src/yapf/follow_track.hpp
index afae9b788..99c6ea20e 100644
--- a/src/yapf/follow_track.hpp
+++ b/src/yapf/follow_track.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file follow_track.hpp Template function for track followers */
+
#ifndef FOLLOW_TRACK_HPP
#define FOLLOW_TRACK_HPP
diff --git a/src/yapf/nodelist.hpp b/src/yapf/nodelist.hpp
index a4d14e934..000c36659 100644
--- a/src/yapf/nodelist.hpp
+++ b/src/yapf/nodelist.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file nodelist.hpp */
+
#ifndef NODELIST_HPP
#define NODELIST_HPP
diff --git a/src/yapf/yapf.h b/src/yapf/yapf.h
index 76f2dc1cb..132922b11 100644
--- a/src/yapf/yapf.h
+++ b/src/yapf/yapf.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf.h */
+
#ifndef YAPF_H
#define YAPF_H
diff --git a/src/yapf/yapf_base.hpp b/src/yapf/yapf_base.hpp
index 3dfa9e908..6218c6ec7 100644
--- a/src/yapf/yapf_base.hpp
+++ b/src/yapf/yapf_base.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_base.hpp */
+
#ifndef YAPF_BASE_HPP
#define YAPF_BASE_HPP
diff --git a/src/yapf/yapf_common.hpp b/src/yapf/yapf_common.hpp
index 87deffeda..ed6b8782a 100644
--- a/src/yapf/yapf_common.hpp
+++ b/src/yapf/yapf_common.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_common.hpp */
+
#ifndef YAPF_COMMON_HPP
#define YAPF_COMMON_HPP
diff --git a/src/yapf/yapf_costcache.hpp b/src/yapf/yapf_costcache.hpp
index c90d37302..5b459601a 100644
--- a/src/yapf/yapf_costcache.hpp
+++ b/src/yapf/yapf_costcache.hpp
@@ -1,4 +1,7 @@
/* $Id$ */
+
+/** @file yapf_costcache.hpp */
+
#ifndef YAPF_COSTCACHE_HPP
#define YAPF_COSTCACHE_HPP
diff --git a/src/yapf/yapf_costrail.hpp b/src/yapf/yapf_costrail.hpp
index e1fd61068..b776815dc 100644
--- a/src/yapf/yapf_costrail.hpp
+++ b/src/yapf/yapf_costrail.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_costrail.hpp */
+
#ifndef YAPF_COSTRAIL_HPP
#define YAPF_COSTRAIL_HPP
diff --git a/src/yapf/yapf_destrail.hpp b/src/yapf/yapf_destrail.hpp
index 9a5bd0536..1baa62164 100644
--- a/src/yapf/yapf_destrail.hpp
+++ b/src/yapf/yapf_destrail.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_destrail.hpp */
+
#ifndef YAPF_DESTRAIL_HPP
#define YAPF_DESTRAIL_HPP
diff --git a/src/yapf/yapf_node.hpp b/src/yapf/yapf_node.hpp
index 2fa82a6a6..577a40b7d 100644
--- a/src/yapf/yapf_node.hpp
+++ b/src/yapf/yapf_node.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_node.hpp */
+
#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 df0186989..549bf76b7 100644
--- a/src/yapf/yapf_node_rail.hpp
+++ b/src/yapf/yapf_node_rail.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_node_rail.hpp */
+
#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 dc6f1be3a..ff4856c8d 100644
--- a/src/yapf/yapf_node_road.hpp
+++ b/src/yapf/yapf_node_road.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_node_road.hpp */
+
#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 5073b8705..8b88fde26 100644
--- a/src/yapf/yapf_rail.cpp
+++ b/src/yapf/yapf_rail.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_rail.cpp */
+
#include "../stdafx.h"
#include "yapf.hpp"
diff --git a/src/yapf/yapf_road.cpp b/src/yapf/yapf_road.cpp
index 43d98716d..763d39af4 100644
--- a/src/yapf/yapf_road.cpp
+++ b/src/yapf/yapf_road.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_road.cpp */
+
#include "../stdafx.h"
#include "yapf.hpp"
diff --git a/src/yapf/yapf_settings.h b/src/yapf/yapf_settings.h
index f66b4b732..aea509441 100644
--- a/src/yapf/yapf_settings.h
+++ b/src/yapf/yapf_settings.h
@@ -1,4 +1,7 @@
/* $Id$ */
+
+/** @file yapf_settings.h */
+
#if !defined(YAPF_SETTINGS_H) || defined(YS_DEF)
# ifndef YAPF_SETTINGS_H
diff --git a/src/yapf/yapf_ship.cpp b/src/yapf/yapf_ship.cpp
index 038bdba43..43f7eca73 100644
--- a/src/yapf/yapf_ship.cpp
+++ b/src/yapf/yapf_ship.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_ship.cpp */
+
#include "../stdafx.h"
#include "yapf.hpp"