Update doxygen comment.

The filename after the @file comment is optional (spotted by alink).
This commit is contained in:
Mark de Wever 2010-07-26 21:32:18 +00:00
parent 9530e5ddb7
commit a99c78e0d8
296 changed files with 296 additions and 296 deletions

View file

@ -13,7 +13,7 @@
*/
/**
* @file about.cpp
* @file
* Show screen with scrolling credits.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file src/actions.cpp
* @file
* Recruiting, Fighting.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file src/actions.hpp
* @file
* Various functions which implement in-game events and commands.
*/

View file

@ -14,7 +14,7 @@
/**
* Managing the AI-Game interaction - AI actions and their results
* @file ai/actions.cpp
* @file
*/
/**

View file

@ -14,7 +14,7 @@
/**
* Managing the AI-Game interaction - AI actions and their results
* @file ai/actions.hpp
* @file
* */
#ifndef AI_ACTIONS_HPP_INCLUDED

View file

@ -15,7 +15,7 @@
/**
* Composite AI with turn sequence which is a vector of stages
* @file ai/composite/ai.cpp
* @file
*/
#include "ai.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/ai.hpp
* @file
* Composite AI with turn sequence which is a vector of stages
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/aspect.cpp
* @file
*/
#include "aspect.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/aspect.hpp
* @file
*/
#ifndef AI_COMPOSITE_ASPECT_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* Composite AI component
* @file ai/composite/component.cpp
* @file
*/
#include "component.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/component.hpp
* @file
* A component of the AI framework
*/

View file

@ -15,7 +15,7 @@
/**
* Helper functions for the object which operates in the context of AI for specific side
* This is part of AI interface
* @file ai/composite/contexts.cpp
* @file
*/
#include "contexts.hpp"

View file

@ -14,7 +14,7 @@
*/
/**
* @file ai/composite/contexts.hpp
* @file
* Composite AI contexts
*/

View file

@ -14,7 +14,7 @@
/**
* AI Support engine - creating specific ai components from config
* @file ai/composite/engine.cpp
* @file
*/
#include "engine.hpp"

View file

@ -15,7 +15,7 @@
/**
* AI Support engine - creating specific ai components from config
* @file ai/composite/engine.hpp
* @file
*/
#ifndef AI_COMPOSITE_ENGINE_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* CPP AI Support engine - creating specific ai components from config
* @file ai/composite/engine_default.cpp
* @file
*/
#include "ai.hpp"

View file

@ -14,7 +14,7 @@
/**
* CPP AI Support engine - creating specific ai components from config
* @file ai/composite/engine_default.hpp
* @file
*/
#ifndef AI_COMPOSITE_ENGINE_DEFAULT_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* FAI AI Support engine - creating specific ai components from config
* @file ai/composite/engine_fai.cpp
* @file
*/
#include "ai.hpp"

View file

@ -14,7 +14,7 @@
/**
* FAI AI Support engine - creating specific ai components from config
* @file ai/composite/engine_fai.hpp
* @file
*/
#ifndef AI_COMPOSITE_ENGINE_FAI_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* LUA AI Support engine - creating specific ai components from config
* @file ai/composite/engine_lua.cpp
* @file
*/
#include "ai.hpp"

View file

@ -14,7 +14,7 @@
/**
* LUA AI Support engine - creating specific ai components from config
* @file ai/composite/engine_lua.hpp
* @file
*/
#ifndef AI_COMPOSITE_ENGINE_LUA_HPP_INCLUDED

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/goal.cpp
* @file
*/
#include "goal.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/goal.hpp
* @file
*/
#ifndef AI_COMPOSITE_GOAL_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* Composite AI component
* @file ai/composite/property_handler.hpp
* @file
*/

View file

@ -14,7 +14,7 @@
/**
* Candidate actions framework
* @file ai/composite/rca.cpp
* @file
*/
#include "ai.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/rca.hpp
* @file
* candidate action framework
*/

View file

@ -14,7 +14,7 @@
/**
* Stage of a composite AI
* @file ai/composite/stage.cpp
* @file
*/
#include "ai.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/stage.hpp
* @file
* Composite AI stages
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/composite/value_translator.hpp
* @file
*/

View file

@ -15,7 +15,7 @@
/**
* Managing the AI configuration
* @file ai/configuration.cpp
* @file
*/
#include "configuration.hpp"

View file

@ -14,7 +14,7 @@
/**
* Managing the AIs configuration - headers
* @file ai/configuration.hpp
* @file
* */
#ifndef AI_CONFIGURATION_HPP_INCLUDED

View file

@ -15,7 +15,7 @@
/**
* Helper functions for the object which operates in the context of AI for specific side
* This is part of AI interface
* @file ai/contexts.cpp
* @file
*/
#include "actions.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/contexts.hpp
* @file
* Helper functions for the object which operates in the context of AI for specific side
* this is part of AI interface
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/default/ai.cpp
* @file
* Artificial intelligence - The computer commands the enemy.
*/

View file

@ -12,7 +12,7 @@
See the COPYING file for more details.
*/
/** @file ai/default/ai.hpp */
/** @file */
#ifndef AI_DEFAULT_AI_HPP_INCLUDED
#define AI_DEFAULT_AI_HPP_INCLUDED

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/default/attack.cpp
* @file
* Calculate & analyse attacks of the default ai
*/

View file

@ -15,7 +15,7 @@
/**
* Helper functions for the object which operates in the context of AI for specific side
* This is part of AI interface
* @file ai/default/contexts.cpp
* @file
*/
#include "contexts.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/default/contexts.hpp
* @file
* Default AI contexts
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/ai.cpp
* @file
* Defines formula ai candidate actions - headers
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/ai.hpp
* @file
* Defines formula ai
* */

View file

@ -12,7 +12,7 @@
*/
/**
* @file ai/formula/candidates.cpp
* @file
* Defines formula ai candidate actions
* */

View file

@ -12,7 +12,7 @@
*/
/**
* @file ai/formula/candidates.hpp
* @file
* Defines formula ai candidate actions - headers
* */

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/stage_side_formulas.cpp
* @file
* Defines formula ai side formulas stage
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/stage_side_formulas.hpp
* @file
* Stage which executes side formulas
* */

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/stage_unit_formulas.cpp
* @file
* Defines formula ai unit formulas stage
* */

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/formula/stage_unit_formulas.hpp
* @file
* Stage which executes unit formulas
* */

View file

@ -14,7 +14,7 @@
/**
* Base class for the AI and AI-ai::manager contract.
* @file ai/game_info.cpp
* @file
*/
#include "game_info.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/game_info.hpp
* @file
* Game information for the AI
*/

View file

@ -15,7 +15,7 @@
/**
* Base gamestate observer - useful to see if the gamestate has changed
* between two points of time
* @file ai/gamestate_observer.cpp
* @file
*/
#include "manager.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/gamestate_observer.hpp
* @file
* A helper class to observe the game state
*/

View file

@ -14,7 +14,7 @@
/**
* Base class for the AI and AI-ai_manager contract.
* @file ai/interface.cpp
* @file
*/
#include "interface.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/interface.hpp
* @file
* Interface to the AI.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/lua/core.cpp
* @file
* Provides core classes for the Lua AI.
*
*/

View file

@ -14,7 +14,7 @@
/**
* Managing the AI lifecycle and interface for the rest of Wesnoth
* @file ai/manager.cpp
* @file
*/
#include "composite/ai.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/manager.hpp
* @file
* Managing the AIs lifecycle - headers
* @todo 1.9 Refactor history handling and internal commands.
* @todo 1.9 AI Interface command to clear the history.

View file

@ -14,7 +14,7 @@
/**
* All known c++ AI parts. Workaround to a linker feature of not including all symbols from files, and including only actually referenced stuff. this is not good for 'static registry' pattern. (other workarounds such as --whole-archive for ld are possible, but require messing with all buildsystems)
* @file ai/registry.cpp
* @file
*/
#include "composite/ai.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/registry.hpp
* @file
* All known AI parts
*/

View file

@ -14,7 +14,7 @@
/**
* Gather statistics important for AI testing and output them
* @file ai/testing.cpp
* @file
*/
#include "manager.hpp"
#include "testing.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/testing.hpp
* @file
* Gather statistics important for AI testing and output them
*/

View file

@ -14,7 +14,7 @@
/**
* Stage: fallback to other AI
* @file ai/testing/aspect_attacks.cpp
* @file
*/
#include "aspect_attacks.hpp"

View file

@ -14,7 +14,7 @@
/**
* Aspect: attacks
* @file ai/testing/aspect_attacks.hpp
* @file
*/
#ifndef AI_TESTING_ASPECT_ATTACKS_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* Default AI (Testing)
* @file ai/testing/ca.cpp
* @file
*/
#include "ca.hpp"

View file

@ -15,7 +15,7 @@
/**
* Default AI (Testing)
* @file ai/testing/ca.hpp
* @file
*/
#ifndef AI_TESTING_CA_HPP_INCLUDED

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/testing/ca_testing_move_to_targets.cpp
* @file
* Strategic movement routine, taken from default AI
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/testing/ca_testing_move_to_targets.hpp
* @file
* Strategic movement routine, for experimentation
*/

View file

@ -14,7 +14,7 @@
/**
* Stage: fallback to other AI
* @file ai/testing/stage_fallback.cpp
* @file
*/
#include "stage_fallback.hpp"

View file

@ -14,7 +14,7 @@
/**
* Stage: fallback to other AI
* @file ai/testing/stage_fallback.hpp
* @file
*/
#ifndef AI_TESTING_STAGE_FALLBACK_HPP_INCLUDED

View file

@ -14,7 +14,7 @@
/**
* Candidate actions evaluator
* @file ai/testing/stage_rca.cpp
* @file
*/
#include "stage_rca.hpp"

View file

@ -13,7 +13,7 @@
*/
/**
* @file ai/testing/stage_rca.hpp
* @file
* candidate action evaluator
*/

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file ana.hpp
* @file
* @brief Main include file for application developers that wish to use ana.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file binary_streams.hpp
* @file
* @brief Minimal serialization library.
*
* This file is part of the MiLi Minimalistic Library :

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file buffers.hpp
* @file
* @brief Implementation details for the ana project dealing with buffers.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file common.hpp
* @file
* @brief Main definitions for project ana.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file predicates.hpp
* @file
* @brief Implementation details for the ana project dealing with client predicates.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file stats.hpp
* @file
* @brief Implementation details for the ana project dealing with network statistics.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file timers.hpp
* @file
* @brief Implementation details for the ana project dealing with timers.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file client.cpp
* @file
* @brief Client side chat application. Example for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file server.hpp
* @file
* @brief Server side chat application. Example for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_client.cpp
* @file
* @brief Implementation of the client side of the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_client.hpp
* @file
* @brief Header file of the client side of the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_listener.cpp
* @file
* @brief Implementation of a listener for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_listener.hpp
* @file
* @brief Header file of a listener for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_proxy_connection.cpp
* @file
* @brief Implementation of the client side proxy connection for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_proxy_connection.hpp
* @file
* @brief Header file of the client side proxy connection for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_sender.hpp
* @file
* @brief Implementation file providing send capability to ana.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_sender.hpp
* @file
* @brief Header file providing send capability to ana.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_server.cpp
* @file
* @brief Implementation of the server side for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file asio_server.hpp
* @file
* @brief Header file of the server side for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$*/
/**
* @file asio_timers.cpp
* @file
* @brief Implementation details for the ana project dealing with timers.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file client.cpp
* @file
* @brief Client side chat application. Example for the ana project.
*
* ana: Asynchronous Network API.

View file

@ -1,7 +1,7 @@
/* $Id$ */
/**
* @file sdl_server.cpp
* @file
* @brief Server application using SDL_net to test compatibility with ana.
*
* Language : C

View file

@ -13,7 +13,7 @@
*/
/**
* @file animated.hpp
* @file
* Animate units.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file animated_game.cpp
* @file
* Template instantiations for wesnoth-game.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file array.hpp
* @file
* Template for arrays.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file arrow.cpp
* @file
* Method bodies for the arrow class.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file arrow.hpp
* @file
* Arrows destined to be drawn on the map. Created for the whiteboard project.
*/

View file

@ -18,7 +18,7 @@
*/
/**
* @file attack_prediction.cpp
* @file
* Simulate combat to calculate attacks. Standalone program, benchmark.
*/

View file

@ -12,7 +12,7 @@
See the COPYING file for more details.
*/
/** @file attack_prediction.hpp */
/** @file */
#ifndef ATTACK_PREDICTION_H_INCLUDED
#define ATTACK_PREDICTION_H_INCLUDED

View file

@ -13,7 +13,7 @@
*/
/**
* @file boilerplate-header.cpp
* @file
* Template for new cpp-files.
*/

View file

@ -13,7 +13,7 @@
*/
/**
* @file builder.cpp
* @file
* Terrain builder.
*/

Some files were not shown because too many files have changed in this diff Show more