Permalink
Browse files

Doc: Lots and lots of doxymentation fixes

  • Loading branch information...
LordAro authored and frosch123 committed Oct 28, 2018
1 parent b9273cb commit f5b1115039e41d7f75f91e7355003f10dd01b352
Showing with 265 additions and 290 deletions.
  1. +3 −4 Doxyfile
  2. +6 −6 src/aircraft_cmd.cpp
  3. +1 −2 src/autoreplace_cmd.cpp
  4. +1 −1 src/autoreplace_gui.cpp
  5. +1 −1 src/blitter/32bpp_anim_sse4.cpp
  6. +1 −1 src/blitter/32bpp_anim_sse4.hpp
  7. +4 −4 src/blitter/32bpp_sse_type.h
  8. +2 −2 src/bridge_map.cpp
  9. +3 −3 src/cargopacket.cpp
  10. +0 −1 src/command.cpp
  11. +1 −1 src/company_base.h
  12. +1 −1 src/company_cmd.cpp
  13. +1 −7 src/company_gui.cpp
  14. +2 −2 src/console.cpp
  15. +4 −4 src/console_cmds.cpp
  16. +6 −6 src/core/smallmatrix_type.hpp
  17. +18 −18 src/depend/depend.cpp
  18. +2 −2 src/dock_gui.cpp
  19. +0 −1 src/economy.cpp
  20. +1 −1 src/engine.cpp
  21. +1 −1 src/error_gui.cpp
  22. +4 −5 src/fileio.cpp
  23. +1 −1 src/fios_gui.cpp
  24. +1 −1 src/game/game_text.cpp
  25. +3 −3 src/gamelog.cpp
  26. +7 −7 src/gfx.cpp
  27. +1 −1 src/gfx_type.h
  28. +1 −1 src/gfxinit.cpp
  29. +4 −4 src/goal_gui.cpp
  30. +1 −1 src/group_cmd.cpp
  31. +6 −6 src/group_gui.cpp
  32. +3 −3 src/heightmap.cpp
  33. +14 −14 src/industry_cmd.cpp
  34. +2 −2 src/industry_gui.cpp
  35. +1 −1 src/ini_type.h
  36. +0 −1 src/linkgraph/demands.cpp
  37. +1 −1 src/linkgraph/demands.h
  38. +1 −1 src/linkgraph/flowmapper.cpp
  39. +0 −2 src/linkgraph/linkgraph.cpp
  40. +1 −1 src/linkgraph/linkgraph_gui.cpp
  41. +2 −2 src/linkgraph/mcf.cpp
  42. +1 −1 src/map_type.h
  43. +3 −3 src/misc/dbg_helpers.cpp
  44. +1 −1 src/misc/getoptdata.h
  45. +2 −2 src/misc_gui.cpp
  46. +2 −2 src/music/midifile.cpp
  47. +1 −1 src/music/music_driver.hpp
  48. +1 −1 src/network/network_content_gui.cpp
  49. +1 −1 src/network/network_server.cpp
  50. +6 −6 src/newgrf.cpp
  51. +0 −1 src/newgrf_airport.cpp
  52. +0 −1 src/newgrf_animation_base.h
  53. +2 −4 src/newgrf_generic.cpp
  54. +2 −2 src/newgrf_gui.cpp
  55. +1 −1 src/newgrf_industries.cpp
  56. +1 −1 src/newgrf_industrytiles.cpp
  57. +2 −2 src/newgrf_object.cpp
  58. +2 −2 src/newgrf_railtype.cpp
  59. +2 −2 src/newgrf_spritegroup.cpp
  60. +1 −1 src/newgrf_station.cpp
  61. +1 −1 src/newgrf_text.cpp
  62. +1 −2 src/news_gui.cpp
  63. +1 −4 src/object_gui.cpp
  64. +2 −2 src/openttd.cpp
  65. +0 −1 src/order_cmd.cpp
  66. +2 −2 src/os/windows/win32.cpp
  67. +2 −2 src/osk_gui.cpp
  68. +1 −1 src/pathfinder/npf/aystar.cpp
  69. +4 −4 src/pathfinder/npf/aystar.h
  70. +1 −1 src/pathfinder/yapf/nodelist.hpp
  71. +1 −1 src/rail.cpp
  72. +1 −1 src/rail.h
  73. +1 −1 src/road_func.h
  74. +1 −1 src/roadveh_cmd.cpp
  75. +1 −1 src/saveload/linkgraph_sl.cpp
  76. +1 −1 src/saveload/saveload.cpp
  77. +3 −3 src/saveload/saveload.h
  78. +2 −2 src/screenshot.cpp
  79. +2 −2 src/settings.cpp
  80. +1 −1 src/settings_type.h
  81. +3 −4 src/settingsgen/settingsgen.cpp
  82. +1 −1 src/ship_cmd.cpp
  83. +13 −13 src/smallmap_gui.cpp
  84. +1 −1 src/station_base.h
  85. +4 −4 src/station_cmd.cpp
  86. +0 −1 src/station_gui.cpp
  87. +1 −1 src/strgen/strgen_base.cpp
  88. +2 −2 src/string_base.h
  89. +6 −7 src/strings.cpp
  90. +0 −1 src/textbuf.cpp
  91. +11 −8 src/tile_map.cpp
  92. +1 −1 src/tile_map.h
  93. +1 −1 src/tilematrix_type.hpp
  94. +1 −1 src/timetable_gui.cpp
  95. +5 −5 src/town_cmd.cpp
  96. +16 −16 src/train_cmd.cpp
  97. +1 −0 src/tunnelbridge_cmd.cpp
  98. +2 −2 src/vehicle.cpp
  99. +2 −2 src/vehicle_base.h
  100. +2 −2 src/vehicle_cmd.cpp
  101. +1 −1 src/vehicle_func.h
  102. +1 −1 src/vehicle_gui.cpp
  103. +1 −1 src/viewport_sprite_sorter_sse4.cpp
  104. +6 −6 src/widget.cpp
  105. +5 −5 src/widget_type.h
  106. +1 −1 src/widgets/cheat_widget.h
  107. +1 −2 src/widgets/dropdown.cpp
  108. +3 −4 src/window.cpp
@@ -14,7 +14,7 @@ PROJECT_NUMBER =
PROJECT_BRIEF =
PROJECT_LOGO =
OUTPUT_DIRECTORY = docs/source/
CREATE_SUBDIRS = NO
CREATE_SUBDIRS = YES
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
@@ -72,7 +72,7 @@ EXTRACT_PACKAGE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
EXTRACT_ANON_NSPACES = NO
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
@@ -130,7 +130,6 @@ RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = */3rdparty \
*/.svn \
*/script/api
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
@@ -183,7 +182,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
@@ -248,7 +248,7 @@ void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoff
* @param flags type of operation.
* @param e the engine to build.
* @param data unused.
* @param ret[out] the vehicle that has been built.
* @param[out] ret the vehicle that has been built.
* @return the cost of this operation or an error.
*/
CommandCost CmdBuildAircraft(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
@@ -694,9 +694,9 @@ int GetTileHeightBelowAircraft(const Vehicle *v)
* When the maximum is reached the vehicle should consider descending.
* When the minimum is reached the vehicle should consider ascending.
*
* @param v The vehicle to get the flight levels for.
* @param [out] min_level The minimum bounds for flight level.
* @param [out] max_level The maximum bounds for flight level.
* @param v The vehicle to get the flight levels for.
* @param[out] min_level The minimum bounds for flight level.
* @param[out] max_level The maximum bounds for flight level.
*/
void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_level)
{
@@ -728,7 +728,7 @@ void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_lev
/**
* Gets the maximum 'flight level' for the holding pattern of the aircraft,
* in pixels 'z_pos' 0, depending on terrain below..
* in pixels 'z_pos' 0, depending on terrain below.
*
* @param v The aircraft that may or may not need to decrease its altitude.
* @return Maximal aircraft holding altitude, while in normal flight, in pixels.
@@ -1889,7 +1889,7 @@ static bool FreeTerminal(Aircraft *v, byte i, byte last_terminal)
/**
* Get the number of terminals at the airport.
* @param afc Airport description.
* @param apc Airport description.
* @return Number of terminals.
*/
static uint GetNumTerminals(const AirportFTAClass *apc)
@@ -32,7 +32,6 @@ extern void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);
* Figure out if two engines got at least one type of cargo in common (refitting if needed)
* @param engine_a one of the EngineIDs
* @param engine_b the other EngineID
* @param type the type of the engines
* @return true if they can both carry the same type of cargo (or at least one of them got no capacity at all)
*/
static bool EnginesHaveCargoInCommon(EngineID engine_a, EngineID engine_b)
@@ -237,7 +236,7 @@ static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type, bool
* @param v The vehicle to find a replacement for
* @param c The vehicle's owner (it's faster to forward the pointer than refinding it)
* @param always_replace Always replace, even if not old.
* @param [out] e the EngineID of the replacement. INVALID_ENGINE if no replacement is found
* @param[out] e the EngineID of the replacement. INVALID_ENGINE if no replacement is found
* @return Error if the engine to build is not available
*/
static CommandCost GetNewEngineType(const Vehicle *v, const Company *c, bool always_replace, EngineID &e)
@@ -81,7 +81,7 @@ class ReplaceVehicleWindow : public Window {
EngineID sel_engine[2]; ///< Selected engine left and right.
GUIEngineList engines[2]; ///< Left and right list of engines.
bool replace_engines; ///< If \c true, engines are replaced, if \c false, wagons are replaced (only for trains).
bool reset_sel_engine; ///< Also reset #sel_engine while updating left and/or right (#update_left and/or #update_right) and no valid engine selected.
bool reset_sel_engine; ///< Also reset #sel_engine while updating left and/or right and no valid engine selected.
GroupID sel_group; ///< Group selected to replace.
int details_height; ///< Minimal needed height of the details panels (found so far).
byte sort_criteria; ///< Criteria of sorting vehicles.
@@ -7,7 +7,7 @@
* 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 <http://www.gnu.org/licenses/>.
*/
/** @file 32bpp_sse4_anim.cpp Implementation of the SSE4 32 bpp blitter with animation support. */
/** @file 32bpp_anim_sse4.cpp Implementation of the SSE4 32 bpp blitter with animation support. */
#ifdef WITH_SSE
@@ -7,7 +7,7 @@
* 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 <http://www.gnu.org/licenses/>.
*/
/** @file 32bpp_sse4_anim.hpp A SSE4 32 bpp blitter with animation support. */
/** @file 32bpp_anim_sse4.hpp A SSE4 32 bpp blitter with animation support. */
#ifndef BLITTER_32BPP_SSE4_ANIM_HPP
#define BLITTER_32BPP_SSE4_ANIM_HPP
@@ -7,10 +7,10 @@
* 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 <http://www.gnu.org/licenses/>.
*/
/** @file 32bpp_sse_type.hpp Types related to SSE 32 bpp blitter. */
/** @file 32bpp_sse_type.h Types related to SSE 32 bpp blitter. */
#ifndef BLITTER_32BPP_SSE_TYPE_HPP
#define BLITTER_32BPP_SSE_TYPE_HPP
#ifndef BLITTER_32BPP_SSE_TYPE_H
#define BLITTER_32BPP_SSE_TYPE_H
#ifdef WITH_SSE
@@ -55,4 +55,4 @@ typedef union ALIGN(16) um128i {
#define TRANSPARENT_NOM_BASE _mm_setr_epi16(256, 256, 256, 256, 256, 256, 256, 256)
#endif /* WITH_SSE */
#endif /* BLITTER_32BPP_SSE_TYPE_HPP */
#endif /* BLITTER_32BPP_SSE_TYPE_H */
@@ -56,7 +56,7 @@ TileIndex GetSouthernBridgeEnd(TileIndex t)
/**
* Starting at one bridge end finds the other bridge end
* @param t the bridge ramp tile to find the other bridge ramp for
* @param tile the bridge ramp tile to find the other bridge ramp for
*/
TileIndex GetOtherBridgeEnd(TileIndex tile)
{
@@ -66,7 +66,7 @@ TileIndex GetOtherBridgeEnd(TileIndex tile)
/**
* Get the height ('z') of a bridge.
* @param tile the bridge ramp tile to get the bridge height from
* @param t the bridge ramp tile to get the bridge height from
* @return the height of the bridge.
*/
int GetBridgeHeight(TileIndex t)
@@ -602,7 +602,7 @@ uint VehicleCargoList::Reassign<VehicleCargoList::MTA_DELIVER, VehicleCargoList:
* Returns reserved cargo to the station and removes it from the cache.
* @param max_move Maximum amount of cargo to move.
* @param dest Station the cargo is returned to.
* @param ID of next the station the cargo wants to go next.
* @param next ID of the next station the cargo wants to go to.
* @return Amount of cargo actually returned.
*/
uint VehicleCargoList::Return(uint max_move, StationCargoList *dest, StationID next)
@@ -668,7 +668,7 @@ uint VehicleCargoList::Truncate(uint max_move)
* @param dest List to prepend the cargo to.
* @param avoid Station to exclude from routing and current next hop of packets to reroute.
* @param avoid2 Additional station to exclude from routing.
* @oaram ge GoodsEntry to get the routing info from.
* @param ge GoodsEntry to get the routing info from.
*/
uint VehicleCargoList::Reroute(uint max_move, VehicleCargoList *dest, StationID avoid, StationID avoid2, const GoodsEntry *ge)
{
@@ -859,7 +859,7 @@ uint StationCargoList::Load(uint max_move, VehicleCargoList *dest, TileIndex loa
* @param dest List to append the cargo to.
* @param avoid Station to exclude from routing and current next hop of packets to reroute.
* @param avoid2 Additional station to exclude from routing.
* @oaram ge GoodsEntry to get the routing info from.
* @param ge GoodsEntry to get the routing info from.
*/
uint StationCargoList::Reroute(uint max_move, StationCargoList *dest, StationID avoid, StationID avoid2, const GoodsEntry *ge)
{
@@ -605,7 +605,6 @@ bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallbac
/**
* Helper to deduplicate the code for returning.
* @param cmd the command cost to return.
* @param clear whether to keep the storage changes or not.
*/
#define return_dcpi(cmd) { _docommand_recursive = 0; return cmd; }
@@ -91,7 +91,7 @@ struct CompanyProperties {
*/
bool is_ai;
Money yearly_expenses[3][EXPENSES_END]; ///< Expenses of the company for the last three years, in every #Expenses category.
Money yearly_expenses[3][EXPENSES_END]; ///< Expenses of the company for the last three years, in every #ExpensesType category.
CompanyEconomyEntry cur_economy; ///< Economic data of the company of this quarter.
CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]; ///< Economic data of the company of the last #MAX_HISTORY_QUARTERS quarters.
byte num_valid_stat_ent; ///< Number of valid statistical entries in #old_economy.
@@ -188,7 +188,7 @@ void InvalidateCompanyWindows(const Company *company)
/**
* Verify whether the company can pay the bill.
* @param cost [inout] Money to pay, is changed to an error if the company does not have enough money.
* @param[in,out] cost Money to pay, is changed to an error if the company does not have enough money.
* @return Function returns \c true if the company has enough money, else it returns \c false.
*/
bool CheckCompanyHasMoney(CommandCost &cost)
@@ -268,10 +268,7 @@ static const NWidgetPart _nested_company_finances_widgets[] = {
EndContainer(),
};
/**
* Window class displaying the company finances.
* @todo #money_width should be calculated dynamically.
*/
/** Window class displaying the company finances. */
struct CompanyFinancesWindow : Window {
static Money max_money; ///< The maximum amount of money a company has had this 'run'
bool small; ///< Window is toggled to 'small'.
@@ -1509,9 +1506,6 @@ static WindowDesc _select_company_manager_face_desc(
* Open the simple/advanced company manager face selection window
*
* @param parent the parent company window
* @param adv simple or advanced face selection window
* @param top previous top position of the window
* @param left previous left position of the window
*/
static void DoSelectCompanyManagerFace(Window *parent)
{
@@ -235,8 +235,8 @@ void IConsoleAddSorted(T **base, T *item_new)
/**
* Remove underscores from a string; the string will be modified!
* @param name The string to remove the underscores from.
* @return #name.
* @param[in,out] name String to remove the underscores from.
* @return \a name, with its contents modified.
*/
char *RemoveUnderscores(char *name)
{
@@ -62,7 +62,7 @@ class ConsoleFileList : public FileList {
/**
* (Re-)validate the file storage cache. Only makes a change if the storage was invalid, or if \a force_reload.
* @param Always reload the file storage cache.
* @param force_reload Always reload the file storage cache.
*/
void ValidateFileList(bool force_reload = false)
{
@@ -256,8 +256,8 @@ DEF_CONSOLE_CMD(ConResetTile)
/**
* Scroll to a tile on the map.
* @param arg1 tile tile number or tile x coordinate.
* @param arg2 optionally tile y coordinate.
* param x tile number or tile x coordinate.
* param y optional y coordinate.
* @note When only one argument is given it is intepreted as the tile number.
* When two arguments are given, they are interpreted as the tile's x
* and y coordinates.
@@ -304,7 +304,7 @@ DEF_CONSOLE_CMD(ConScrollToTile)
/**
* Save the map to a file.
* @param filename the filename to save the map to.
* param filename the filename to save the map to.
* @return True when help was displayed or the file attempted to be saved.
*/
DEF_CONSOLE_CMD(ConSave)
@@ -159,7 +159,7 @@ class SmallMatrix {
/**
* Erase a row, replacing it with the last one.
* @param x Position of the row.
* @param y Position of the row.
*/
void EraseRow(uint y)
{
@@ -174,7 +174,7 @@ class SmallMatrix {
/**
* Remove columns from the matrix while preserving the order of other columns.
* @param x First column to remove.
* @param y First column to remove.
* @param count Number of consecutive columns to remove.
*/
void EraseRowPreservingOrder(uint y, uint count = 1)
@@ -210,8 +210,8 @@ class SmallMatrix {
/**
* Set the size to a specific width and height, preserving item positions
* as far as possible in the process.
* @param width Target width.
* @param height Target height.
* @param new_width Target width.
* @param new_height Target height.
*/
inline void Resize(uint new_width, uint new_height)
{
@@ -297,7 +297,7 @@ class SmallMatrix {
/**
* Get column "number" (const)
*
* @param X Position of the column.
* @param x Position of the column.
* @return Column at "number".
*/
inline const T *operator[](uint x) const
@@ -309,7 +309,7 @@ class SmallMatrix {
/**
* Get column "number" (const)
*
* @param X Position of the column.
* @param x Position of the column.
* @return Column at "number".
*/
inline T *operator[](uint x)
@@ -217,22 +217,22 @@ enum Token {
TOKEN_LOCAL, ///< Read a local include
TOKEN_GLOBAL, ///< Read a global include
TOKEN_IDENTIFIER, ///< Identifier within the data.
TOKEN_DEFINE, ///< (#)define in code
TOKEN_IF, ///< (#)if in code
TOKEN_IFDEF, ///< (#)ifdef in code
TOKEN_IFNDEF, ///< (#)ifndef in code
TOKEN_ELIF, ///< (#)elif in code
TOKEN_ELSE, ///< (#)else in code
TOKEN_ENDIF, ///< (#)endif in code
TOKEN_UNDEF, ///< (#)undef in code
TOKEN_OR, ///< '||' within <tt>#if</tt> expression
TOKEN_AND, ///< '&&' within <tt>#if</tt> expression
TOKEN_DEFINED, ///< 'defined' within <tt>#if</tt> expression
TOKEN_OPEN, ///< '(' within <tt>#if</tt> expression
TOKEN_CLOSE, ///< ')' within <tt>#if</tt> expression
TOKEN_NOT, ///< '!' within <tt>#if</tt> expression
TOKEN_ZERO, ///< '0' within <tt>#if</tt> expression
TOKEN_INCLUDE, ///< (#)include in code
TOKEN_DEFINE, ///< \c \#define in code
TOKEN_IF, ///< \c \#if in code
TOKEN_IFDEF, ///< \c \#ifdef in code
TOKEN_IFNDEF, ///< \c \#ifndef in code
TOKEN_ELIF, ///< \c \#elif in code
TOKEN_ELSE, ///< \c \#else in code
TOKEN_ENDIF, ///< \c \#endif in code
TOKEN_UNDEF, ///< \c \#undef in code
TOKEN_OR, ///< '||' within \c \#if expression
TOKEN_AND, ///< '&&' within \c \#if expression
TOKEN_DEFINED, ///< 'defined' within \c \#if expression
TOKEN_OPEN, ///< '(' within \c \#if expression
TOKEN_CLOSE, ///< ')' within \c \#if expression
TOKEN_NOT, ///< '!' within \c \#if expression
TOKEN_ZERO, ///< '0' within \c \#if expression
TOKEN_INCLUDE, ///< \c \#include in code
};
/** Mapping from a C-style keyword representation to a Token. */
@@ -681,8 +681,8 @@ bool ExpressionOr(Lexer *lexer, StringSet *defines, bool verbose)
/** Enumerator to tell how long to ignore 'stuff'. */
enum Ignore {
NOT_IGNORE, ///< No ignoring.
IGNORE_UNTIL_ELSE, ///< Ignore till a #else is reached.
IGNORE_UNTIL_ENDIF, ///< Ignore till a #endif is reached.
IGNORE_UNTIL_ELSE, ///< Ignore till a \c \#else is reached.
IGNORE_UNTIL_ENDIF, ///< Ignore till a \c \#endif is reached.
};
/**
@@ -56,8 +56,8 @@ void CcPlaySound_SPLAT_WATER(const CommandCost &result, TileIndex tile, uint32 p
/**
* Gets the other end of the aqueduct, if possible.
* @param tile_from The begin tile for the aqueduct.
* @param [out] tile_to The tile till where to show a selection for the aqueduct.
* @param tile_from The begin tile for the aqueduct.
* @param[out] tile_to The tile till where to show a selection for the aqueduct.
* @return The other end of the aqueduct, or otherwise a tile in line with the aqueduct to cause the right error message.
*/
static TileIndex GetOtherAqueductEnd(TileIndex tile_from, TileIndex *tile_to = NULL)
@@ -1242,7 +1242,6 @@ Money CargoPayment::PayTransfer(const CargoPacket *cp, uint count)
/**
* Prepare the vehicle to be unloaded.
* @param curr_station the station where the consist is at the moment
* @param front_v the vehicle to be unloaded
*/
void PrepareUnload(Vehicle *front_v)
@@ -573,7 +573,7 @@ static bool IsWagon(EngineID index)
}
/**
* Update #reliability of engine \a e, (if needed) update the engine GUIs.
* Update #Engine::reliability and (if needed) update the engine GUIs.
* @param e %Engine to update.
*/
static void CalcEngineReliability(Engine *e)
Oops, something went wrong.

0 comments on commit f5b1115

Please sign in to comment.