diff options
314 files changed, 1285 insertions, 1528 deletions
diff --git a/crawl-ref/source/AppHdr.h b/crawl-ref/source/AppHdr.h index ab9062cbfe..121851bf9d 100644 --- a/crawl-ref/source/AppHdr.h +++ b/crawl-ref/source/AppHdr.h @@ -1,19 +1,16 @@ -/* - * File: AppHdr.h - * Summary: Precompiled header used by Crawl. - * Written by: Jesse Jones +/** + * @file + * @brief Precompiled header used by Crawl. * - * Abstract: CodeWarrior and MSVC both support precompiled headers which can - * significantly speed up compiles. Unlike CodeWarrior MSVC imposes - * some annoying restrictions on precompiled headers: the precompiled - * header *must* be the first include in all cc files. Any includes or - * other statements that occur before the pch include are ignored. This - * is really stupid and can lead to bizarre errors, but it does mean - * that we shouldn't run into any problems on systems without precompiled - * headers. - * - * Copyright © 1999 Jesse Jones. - */ + * CodeWarrior and MSVC both support precompiled headers which can + * significantly speed up compiles. Unlike CodeWarrior MSVC imposes + * some annoying restrictions on precompiled headers: the precompiled + * header *must* be the first include in all cc files. Any includes or + * other statements that occur before the pch include are ignored. This + * is really stupid and can lead to bizarre errors, but it does mean + * that we shouldn't run into any problems on systems without precompiled + * headers. +**/ #ifndef APPHDR_H diff --git a/crawl-ref/source/abl-show.cc b/crawl-ref/source/abl-show.cc index 172b0ccc1f..d63853024b 100644 --- a/crawl-ref/source/abl-show.cc +++ b/crawl-ref/source/abl-show.cc @@ -1,8 +1,7 @@ -/* - * File: abl-show.cc - * Summary: Functions related to special abilities. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions related to special abilities. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/abl-show.h b/crawl-ref/source/abl-show.h index af5018ad7a..17f48dce09 100644 --- a/crawl-ref/source/abl-show.h +++ b/crawl-ref/source/abl-show.h @@ -1,8 +1,7 @@ -/* - * File: abl-show.h - * Summary: Functions related to special abilities. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions related to special abilities. +**/ #ifndef ABLSHOW_H diff --git a/crawl-ref/source/abyss.cc b/crawl-ref/source/abyss.cc index 233287eb12..1cda22f222 100644 --- a/crawl-ref/source/abyss.cc +++ b/crawl-ref/source/abyss.cc @@ -1,8 +1,7 @@ -/* - * File: abyss.cc - * Summary: Misc abyss specific functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc abyss specific functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/abyss.h b/crawl-ref/source/abyss.h index 33b81675aa..2c1d197c8a 100644 --- a/crawl-ref/source/abyss.h +++ b/crawl-ref/source/abyss.h @@ -1,8 +1,7 @@ -/* - * File: abyss.h - * Summary: Misc abyss specific functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc abyss specific functions. +**/ #ifndef ABYSS_H diff --git a/crawl-ref/source/acquire.cc b/crawl-ref/source/acquire.cc index 280b2ada7e..c24f862715 100644 --- a/crawl-ref/source/acquire.cc +++ b/crawl-ref/source/acquire.cc @@ -1,7 +1,7 @@ -/* - * File: acquire.cc - * Summary: Acquirement and Trog/Oka/Sif gifts. - */ +/** + * @file + * @brief Acquirement and Trog/Oka/Sif gifts. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/acquire.h b/crawl-ref/source/acquire.h index 8bb554d70d..97015d2dea 100644 --- a/crawl-ref/source/acquire.h +++ b/crawl-ref/source/acquire.h @@ -1,7 +1,7 @@ -/* - * File: acquire.h - * Summary: Acquirement and Trog/Oka/Sif gifts. - */ +/** + * @file + * @brief Acquirement and Trog/Oka/Sif gifts. +**/ #ifndef ACQUIRE_H #define ACQUIRE_H diff --git a/crawl-ref/source/act-iter.h b/crawl-ref/source/act-iter.h index 40321a7bde..32ca776e67 100644 --- a/crawl-ref/source/act-iter.h +++ b/crawl-ref/source/act-iter.h @@ -1,7 +1,7 @@ -/* - * Provide a way to iterator over all actors, - * subject to a few common restrictions. - */ +/** + * @file + * @brief Provide a way to iterator over all actors, subject to a few common restrictions. +**/ #ifndef ACT_ITER_H #define ACT_ITER_H diff --git a/crawl-ref/source/areas.cc b/crawl-ref/source/areas.cc index 17b9a470ca..e4610aa67a 100644 --- a/crawl-ref/source/areas.cc +++ b/crawl-ref/source/areas.cc @@ -1,8 +1,8 @@ -/* - * File: areas.cc - * Summary: Tracking effects that affect areas for durations. - * Silence, sanctuary, halos, ... - */ +/** + * @file + * @brief Tracking effects that affect areas for durations. + * Silence, sanctuary, halos, ... +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/arena.cc b/crawl-ref/source/arena.cc index 596da6c5d6..affc2d9ea2 100644 --- a/crawl-ref/source/arena.cc +++ b/crawl-ref/source/arena.cc @@ -1,7 +1,7 @@ -/* - * File: arena.cc - * Summary: Functions related to the monster arena (stage and watch fights). - */ +/** + * @file + * @brief Functions related to the monster arena (stage and watch fights). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/arena.h b/crawl-ref/source/arena.h index db4e6ed666..d7b759f41c 100644 --- a/crawl-ref/source/arena.h +++ b/crawl-ref/source/arena.h @@ -1,7 +1,7 @@ -/* - * File: arena.h - * Summary: Functions related to the monster arena (stage and watch fights). - */ +/** + * @file + * @brief Functions related to the monster arena (stage and watch fights). +**/ #ifndef ARENA_H #define ARENA_H diff --git a/crawl-ref/source/art-func.h b/crawl-ref/source/art-func.h index d6f2571b72..5ed12564e8 100644 --- a/crawl-ref/source/art-func.h +++ b/crawl-ref/source/art-func.h @@ -1,8 +1,7 @@ -/* - * File: art-func.h - * Summary: Functions non-standard unrandarts uses. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Functions non-standard unrandarts uses. +**/ /* * util/art-data.pl scans through this file to grab the functions diff --git a/crawl-ref/source/artefact.cc b/crawl-ref/source/artefact.cc index 73e340053f..ae42eabbb1 100644 --- a/crawl-ref/source/artefact.cc +++ b/crawl-ref/source/artefact.cc @@ -1,8 +1,7 @@ -/* - * File: artefact.cc - * Summary: Random and unrandom artefact functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Random and unrandom artefact functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/artefact.h b/crawl-ref/source/artefact.h index 4458126353..06d57527c4 100644 --- a/crawl-ref/source/artefact.h +++ b/crawl-ref/source/artefact.h @@ -1,8 +1,7 @@ -/* - * File: artefact.h - * Summary: Random and unrandom artefact functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Random and unrandom artefact functions. +**/ #ifndef RANDART_H diff --git a/crawl-ref/source/attitude-change.cc b/crawl-ref/source/attitude-change.cc index 85b0c63dd7..998c9994c6 100644 --- a/crawl-ref/source/attitude-change.cc +++ b/crawl-ref/source/attitude-change.cc @@ -1,6 +1,7 @@ -/* - * Summary: Monster attitude changing due to religion. - */ +/** + * @file + * @brief Monster attitude changing due to religion. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/beam.cc b/crawl-ref/source/beam.cc index 11c4f84757..fb0b573ba6 100644 --- a/crawl-ref/source/beam.cc +++ b/crawl-ref/source/beam.cc @@ -1,8 +1,7 @@ -/* - * File: beam.cc - * Summary: Functions related to ranged attacks. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions related to ranged attacks. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/beam.h b/crawl-ref/source/beam.h index ac398a2056..b7b6af2949 100644 --- a/crawl-ref/source/beam.h +++ b/crawl-ref/source/beam.h @@ -1,8 +1,7 @@ -/* - * File: beam.h - * Summary: Functions related to ranged attacks. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions related to ranged attacks. +**/ #ifndef BEAM_H diff --git a/crawl-ref/source/behold.cc b/crawl-ref/source/behold.cc index b171ea66fa..6b6356f049 100644 --- a/crawl-ref/source/behold.cc +++ b/crawl-ref/source/behold.cc @@ -1,7 +1,7 @@ -/* - * File: behold.cc - * Summary: player methods dealing with mesmerisation. - */ +/** + * @file + * @brief player methods dealing with mesmerisation. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/bitary.cc b/crawl-ref/source/bitary.cc index 52de022dc2..144674699a 100644 --- a/crawl-ref/source/bitary.cc +++ b/crawl-ref/source/bitary.cc @@ -1,8 +1,7 @@ -/* - * File: bitary.cc - * Summary: Bit array data type. - * Created by: Robert Vollmert - */ +/** + * @file + * @brief Bit array data type. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/bitary.h b/crawl-ref/source/bitary.h index c8411d7e2d..7c210f1626 100644 --- a/crawl-ref/source/bitary.h +++ b/crawl-ref/source/bitary.h @@ -1,11 +1,10 @@ -/* - * File: bitary.h - * Summary: Bit array data type. - * Created by: Robert Vollmert +/** + * @file + * @brief Bit array data type. * * Just contains the operations required by los.cc * for the moment. - */ +**/ #ifndef BITARY_H #define BITARY_H diff --git a/crawl-ref/source/branch.h b/crawl-ref/source/branch.h index 12ad7ac805..a9f6abb7da 100644 --- a/crawl-ref/source/branch.h +++ b/crawl-ref/source/branch.h @@ -1,8 +1,7 @@ -/* - * File: branch.h - * Summary: Dungeon branch classes - * Written by: Haran Pilpel - */ +/** + * @file + * @brief Dungeon branch classes +**/ #ifndef BRANCH_H #define BRANCH_H diff --git a/crawl-ref/source/chardump.cc b/crawl-ref/source/chardump.cc index 3ae5c8c10d..ec04bf1c52 100644 --- a/crawl-ref/source/chardump.cc +++ b/crawl-ref/source/chardump.cc @@ -1,8 +1,7 @@ -/* - * File: chardump.cc - * Summary: Dumps character info out to the morgue file. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Dumps character info out to the morgue file. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/chardump.h b/crawl-ref/source/chardump.h index 16bead5861..1d0cee92fb 100644 --- a/crawl-ref/source/chardump.h +++ b/crawl-ref/source/chardump.h @@ -1,8 +1,7 @@ -/* - * File: chardump.h - * Summary: Dumps character info out to the morgue file. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Dumps character info out to the morgue file. +**/ #ifndef CHARDUMP_H diff --git a/crawl-ref/source/cio.cc b/crawl-ref/source/cio.cc index 783eaa9065..34156207ab 100644 --- a/crawl-ref/source/cio.cc +++ b/crawl-ref/source/cio.cc @@ -1,8 +1,7 @@ -/* - * File: cio.cc - * Summary: Platform-independent console IO functions. - * Created by: dshaligram on Wed Jun 20 19:00:52 2007 UTC - */ +/** + * @file + * @brief Platform-independent console IO functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/cio.h b/crawl-ref/source/cio.h index 173794ebbe..6e647ad40f 100644 --- a/crawl-ref/source/cio.h +++ b/crawl-ref/source/cio.h @@ -1,8 +1,7 @@ -/* - * File: cio.h - * Summary: System independent console IO functions - * Created by: dshaligram on Wed Jun 20 19:00:52 2007 UTC - */ +/** + * @file + * @brief System independent console IO functions +**/ #ifndef CIO_H #define CIO_H diff --git a/crawl-ref/source/cloud.cc b/crawl-ref/source/cloud.cc index 1e00c0991e..4f530e2df3 100644 --- a/crawl-ref/source/cloud.cc +++ b/crawl-ref/source/cloud.cc @@ -1,10 +1,9 @@ -/* - * File: cloud.cc - * Summary: Functions related to clouds. - * Written by: Brent Ross +/** + * @file + * @brief Functions related to clouds. * - * Creating a cloud module so all the cloud stuff can be isolated. - */ + * Creating a cloud module so all the cloud stuff can be isolated. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/cloud.h b/crawl-ref/source/cloud.h index dad11cdc87..1740cc1858 100644 --- a/crawl-ref/source/cloud.h +++ b/crawl-ref/source/cloud.h @@ -1,8 +1,7 @@ -/* - * File: cloud.h - * Summary: Functions related to clouds. - * Written by: Brent Ross - */ +/** + * @file + * @brief Functions related to clouds. +**/ #ifndef CLOUD_H diff --git a/crawl-ref/source/cluautil.h b/crawl-ref/source/cluautil.h index b4b18899ac..648ce86e0e 100644 --- a/crawl-ref/source/cluautil.h +++ b/crawl-ref/source/cluautil.h @@ -1,7 +1,7 @@ -/* - * File: cluautil.h - * Summary: Utility functions and macros for Lua bindings. - */ +/** + * @file + * @brief Utility functions and macros for Lua bindings. +**/ #ifndef CLUAUTIL_H #define CLUAUTIL_H diff --git a/crawl-ref/source/command.cc b/crawl-ref/source/command.cc index fe7ce0c716..8d77a11443 100644 --- a/crawl-ref/source/command.cc +++ b/crawl-ref/source/command.cc @@ -1,8 +1,7 @@ -/* - * File: command.cc - * Summary: Misc commands. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc commands. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/command.h b/crawl-ref/source/command.h index 6ebca3ce22..930f335e91 100644 --- a/crawl-ref/source/command.h +++ b/crawl-ref/source/command.h @@ -1,8 +1,7 @@ -/* - * File: command.h - * Summary: Misc commands. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc commands. +**/ #ifndef COMMAND_H diff --git a/crawl-ref/source/coordit.cc b/crawl-ref/source/coordit.cc index ef23d50704..0f16464314 100644 --- a/crawl-ref/source/coordit.cc +++ b/crawl-ref/source/coordit.cc @@ -1,7 +1,7 @@ -/* - * File: coordit.h - * Summary: Coordinate iterators. - */ +/** + * @file + * @brief Coordinate iterators. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/crash-d.cc b/crawl-ref/source/crash-d.cc index 642ddc1e04..fbaa5d6f1d 100644 --- a/crawl-ref/source/crash-d.cc +++ b/crawl-ref/source/crash-d.cc @@ -1,7 +1,7 @@ -/* - * File: crash-d.cc - * Summary: Dos specific crash handling functions. - */ +/** + * @file + * @brief Dos specific crash handling functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/crash-u.cc b/crawl-ref/source/crash-u.cc index 4db22905dd..d016607d5f 100644 --- a/crawl-ref/source/crash-u.cc +++ b/crawl-ref/source/crash-u.cc @@ -1,8 +1,7 @@ -/* - * File: crash-u.cc - * Summary: UNIX specific crash handling functions. - * Written by: Matthew Cline - */ +/** + * @file + * @brief UNIX specific crash handling functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/crash-w.cc b/crawl-ref/source/crash-w.cc index 14c1e5c4aa..30b50c2ac0 100644 --- a/crawl-ref/source/crash-w.cc +++ b/crawl-ref/source/crash-w.cc @@ -1,7 +1,7 @@ -/* - * File: crash-w.cc - * Summary: Windows specific crash handling functions. - */ +/** + * @file + * @brief Windows specific crash handling functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/crash.h b/crawl-ref/source/crash.h index 7f97b91eda..44a847d33a 100644 --- a/crawl-ref/source/crash.h +++ b/crawl-ref/source/crash.h @@ -1,8 +1,7 @@ -/* - * File: crash.h - * Summary: Platform specific crash handling functions. - * Written by: Matthew cline - */ +/** + * @file + * @brief Platform specific crash handling functions. +**/ #ifndef CRASH_H #define CRASH_H diff --git a/crawl-ref/source/ctest.cc b/crawl-ref/source/ctest.cc index cf0725fc9a..370d8ebfe2 100644 --- a/crawl-ref/source/ctest.cc +++ b/crawl-ref/source/ctest.cc @@ -1,16 +1,15 @@ -/* - * File: ctest.cc - * Summary: Crawl Lua test cases - * Written by: Darshan Shaligram +/** + * @file + * @brief Crawl Lua test cases * - * ctest runs Lua tests found in the test directory. The intent here - * is to test parts of Crawl that can be easily tested from within Crawl - * itself (such as LOS). As a side-effect, writing Lua bindings to support - * tests will expand the available Lua bindings. :-) + * ctest runs Lua tests found in the test directory. The intent here + * is to test parts of Crawl that can be easily tested from within Crawl + * itself (such as LOS). As a side-effect, writing Lua bindings to support + * tests will expand the available Lua bindings. :-) * - * Tests will run only with Crawl built in its source tree without - * DATA_DIR_PATH set. - */ + * Tests will run only with Crawl built in its source tree without + * DATA_DIR_PATH set. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/database.cc b/crawl-ref/source/database.cc index 6ecce35663..8a8572b559 100644 --- a/crawl-ref/source/database.cc +++ b/crawl-ref/source/database.cc @@ -1,9 +1,7 @@ -/* - * database.cc - * - * Created by Peter Berger on 4/15/07. - * Copyright 2007 __MyCompanyName__. All rights reserved. - */ +/** + * @file + * database.cc +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/database.h b/crawl-ref/source/database.h index 95e7bb7019..1e47790af5 100644 --- a/crawl-ref/source/database.h +++ b/crawl-ref/source/database.h @@ -1,8 +1,7 @@ -/* - * database.h - * - * Created by Peter Berger on 4/15/07. - */ +/** + * @file + * database.h +**/ #ifndef DATABASE_H diff --git a/crawl-ref/source/dbg-asrt.cc b/crawl-ref/source/dbg-asrt.cc index b29381e4ec..ed6fe58f17 100644 --- a/crawl-ref/source/dbg-asrt.cc +++ b/crawl-ref/source/dbg-asrt.cc @@ -1,8 +1,7 @@ -/* - * File: dbg-asrt.cc - * Summary: Assertions and crashing. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Assertions and crashing. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dbg-crsh.h b/crawl-ref/source/dbg-crsh.h index 0e9c3620bc..3fd7383850 100644 --- a/crawl-ref/source/dbg-crsh.h +++ b/crawl-ref/source/dbg-crsh.h @@ -1,8 +1,7 @@ -/* - * File: dbg-crsh.h - * Summary: Crash handler. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Crash handler. +**/ #ifndef DBGCRSH_H #define DBGCRSH_H diff --git a/crawl-ref/source/dbg-maps.cc b/crawl-ref/source/dbg-maps.cc index 92e635da7a..62e7a8c16c 100644 --- a/crawl-ref/source/dbg-maps.cc +++ b/crawl-ref/source/dbg-maps.cc @@ -1,8 +1,7 @@ -/* - * File: dbg-maps.cc - * Summary: Map generation statistics/testing. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Map generation statistics/testing. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dbg-maps.h b/crawl-ref/source/dbg-maps.h index d2058e2ec5..30414b005f 100644 --- a/crawl-ref/source/dbg-maps.h +++ b/crawl-ref/source/dbg-maps.h @@ -1,8 +1,7 @@ -/* - * File: dbd-maps.h - * Summary: Map generation statistics/testing. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Map generation statistics/testing. +**/ #ifndef DBGDGN_H #define DBGDGN_H diff --git a/crawl-ref/source/dbg-scan.cc b/crawl-ref/source/dbg-scan.cc index 839b7d36d7..f5821806b1 100644 --- a/crawl-ref/source/dbg-scan.cc +++ b/crawl-ref/source/dbg-scan.cc @@ -1,8 +1,7 @@ -/* - * File: dbg-scan.cc - * Summary: Debugging code to scan the list of items and monsters. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Debugging code to scan the list of items and monsters. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dbg-scan.h b/crawl-ref/source/dbg-scan.h index 8e6188d9b2..4dd935a050 100644 --- a/crawl-ref/source/dbg-scan.h +++ b/crawl-ref/source/dbg-scan.h @@ -1,8 +1,7 @@ -/* - * File: dbg-scan.h - * Summary: Debugging code to scan the list of items and monsters. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Debugging code to scan the list of items and monsters. +**/ #ifndef DBGSCAN_H #define DBGSCAN_H diff --git a/crawl-ref/source/dbg-util.cc b/crawl-ref/source/dbg-util.cc index e01f662f30..5c5a18c45d 100644 --- a/crawl-ref/source/dbg-util.cc +++ b/crawl-ref/source/dbg-util.cc @@ -1,8 +1,7 @@ -/* - * File: dbg-util.cc - * Summary: Miscellaneous debugging functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Miscellaneous debugging functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dbg-util.h b/crawl-ref/source/dbg-util.h index 561b68a6bb..f4b5856762 100644 --- a/crawl-ref/source/dbg-util.h +++ b/crawl-ref/source/dbg-util.h @@ -1,8 +1,7 @@ -/* - * File: dbg-util.h - * Summary: Miscellaneous debugging functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Miscellaneous debugging functions. +**/ #ifndef DBGUTIL_H #define DBGUTIL_H diff --git a/crawl-ref/source/debug.h b/crawl-ref/source/debug.h index da1f1b425e..c01bed0f7e 100644 --- a/crawl-ref/source/debug.h +++ b/crawl-ref/source/debug.h @@ -1,8 +1,7 @@ -/* - * File: debug.h - * Summary: Assertions and such. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Assertions and such. +**/ #ifndef DEBUG_H #define DEBUG_H diff --git a/crawl-ref/source/decks.cc b/crawl-ref/source/decks.cc index 374ac97294..8415bc809d 100644 --- a/crawl-ref/source/decks.cc +++ b/crawl-ref/source/decks.cc @@ -1,7 +1,7 @@ -/* - * File: decks.cc - * Summary: Functions with decks of cards. - */ +/** + * @file + * @brief Functions with decks of cards. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/decks.h b/crawl-ref/source/decks.h index 338cd04679..549fa1f5a3 100644 --- a/crawl-ref/source/decks.h +++ b/crawl-ref/source/decks.h @@ -1,7 +1,7 @@ -/* - * File: decks.h - * Summary: Functions with decks of cards. - */ +/** + * @file + * @brief Functions with decks of cards. +**/ #ifndef DECKS_H diff --git a/crawl-ref/source/defines.h b/crawl-ref/source/defines.h index 53006e42dc..c50e711fba 100644 --- a/crawl-ref/source/defines.h +++ b/crawl-ref/source/defines.h @@ -1,12 +1,9 @@ -/* - * File: defines.h - * Summary: Various definess used by Crawl. - * Written by: Linley Henzel +/** + * @file + * @brief Various definess used by Crawl. * - * Abstract: A variety of miscellaneous constant values are found here. - * - * Copyright © 1999 Brian Robinson. // Me? How come? - */ + * A variety of miscellaneous constant values are found here. +**/ #ifndef DEFINES_H #define DEFINES_H diff --git a/crawl-ref/source/delay.cc b/crawl-ref/source/delay.cc index 03778ee847..e46ecd2ab6 100644 --- a/crawl-ref/source/delay.cc +++ b/crawl-ref/source/delay.cc @@ -1,7 +1,7 @@ -/* - * File: delay.cc - * Summary: Functions for handling multi-turn actions. - */ +/** + * @file + * @brief Functions for handling multi-turn actions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/delay.h b/crawl-ref/source/delay.h index 73d104f3a5..19682281ac 100644 --- a/crawl-ref/source/delay.h +++ b/crawl-ref/source/delay.h @@ -1,7 +1,7 @@ -/* - * File: delay.h - * Summary: Functions for handling multi-turn actions. - */ +/** + * @file + * @brief Functions for handling multi-turn actions. +**/ #ifndef DELAY_H #define DELAY_H diff --git a/crawl-ref/source/describe.cc b/crawl-ref/source/describe.cc index 0f84c9cdb9..3a5e74895f 100644 --- a/crawl-ref/source/describe.cc +++ b/crawl-ref/source/describe.cc @@ -1,8 +1,7 @@ -/* - * File: describe.cc - * Summary: Functions used to print information about various game objects. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to print information about various game objects. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dgn-actions.cc b/crawl-ref/source/dgn-actions.cc index 51b2d04c94..4d5b76bcc9 100644 --- a/crawl-ref/source/dgn-actions.cc +++ b/crawl-ref/source/dgn-actions.cc @@ -1,8 +1,7 @@ -/* - * File: dgn-actions.cc - * Summary: Delayed level actions. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Delayed level actions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dgn-height.cc b/crawl-ref/source/dgn-height.cc index 74d8cba4d9..d41362d6d3 100644 --- a/crawl-ref/source/dgn-height.cc +++ b/crawl-ref/source/dgn-height.cc @@ -1,7 +1,7 @@ -/* - * File: dgn-height.cc - * Summary: Dungeon heightmap routines. - */ +/** + * @file + * @brief Dungeon heightmap routines. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dgn-overview.cc b/crawl-ref/source/dgn-overview.cc index f87817bc4a..cb3d75fa1f 100644 --- a/crawl-ref/source/dgn-overview.cc +++ b/crawl-ref/source/dgn-overview.cc @@ -1,8 +1,7 @@ -/* - * File: dgn-overview.cc - * Summary: Records location of stairs etc - * Written by: Linley Henzell - */ +/** + * @file + * @brief Records location of stairs etc +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dgn-overview.h b/crawl-ref/source/dgn-overview.h index 0231fb8c1a..2ccaf1b185 100644 --- a/crawl-ref/source/dgn-overview.h +++ b/crawl-ref/source/dgn-overview.h @@ -1,8 +1,7 @@ -/* - * File: dgn-overview.h - * Summary: "Overview" functionality - * Written by: Linley Henzell - */ +/** + * @file + * @brief "Overview" functionality +**/ #ifndef OVERMAP_H diff --git a/crawl-ref/source/dgnevent.cc b/crawl-ref/source/dgnevent.cc index 451813ea6f..f50718bfcb 100644 --- a/crawl-ref/source/dgnevent.cc +++ b/crawl-ref/source/dgnevent.cc @@ -1,8 +1,7 @@ -/* - * File: dgnevent.cc - * Summary: General dungeon events. - * Created by: dshaligram on Sat Jul 21 12:17:29 2007 UTC - */ +/** + * @file + * @brief General dungeon events. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dgnevent.h b/crawl-ref/source/dgnevent.h index f9c5731b1d..8395724686 100644 --- a/crawl-ref/source/dgnevent.h +++ b/crawl-ref/source/dgnevent.h @@ -1,8 +1,7 @@ -/* - * File: dgnevent.h - * Summary: General dungeon events. - * Created by: dshaligram on Sat Jul 21 12:17:29 2007 UTC - */ +/** + * @file + * @brief General dungeon events. +**/ #ifndef __DGNEVENT_H__ #define __DGNEVENT_H__ diff --git a/crawl-ref/source/directn.cc b/crawl-ref/source/directn.cc index 455207f7bc..703afdcd91 100644 --- a/crawl-ref/source/directn.cc +++ b/crawl-ref/source/directn.cc @@ -1,8 +1,7 @@ -/* - * File: direct.cc - * Summary: Functions used when picking squares. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when picking squares. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/directn.h b/crawl-ref/source/directn.h index 9ff4bd8b1f..63b7a0f4ac 100644 --- a/crawl-ref/source/directn.h +++ b/crawl-ref/source/directn.h @@ -1,8 +1,7 @@ -/* - * File: directn.h - * Summary: Functions used when picking squares. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when picking squares. +**/ #ifndef DIRECT_H diff --git a/crawl-ref/source/dlua.cc b/crawl-ref/source/dlua.cc index 2df429c3a6..ecc8291c68 100644 --- a/crawl-ref/source/dlua.cc +++ b/crawl-ref/source/dlua.cc @@ -1,8 +1,7 @@ -/* - * File: dlua.cc - * Summary: Dungeon-builder Lua interface. - * Created by: dshaligram on Sat Jun 23 20:02:09 2007 UTC - */ +/** + * @file + * @brief Dungeon-builder Lua interface. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dlua.h b/crawl-ref/source/dlua.h index 6cda3828b0..610cdd1951 100644 --- a/crawl-ref/source/dlua.h +++ b/crawl-ref/source/dlua.h @@ -1,8 +1,7 @@ -/* - * File: dlua.h - * Summary: Dungeon-builder Lua interface. - * Created by: dshaligram on Sat Jun 23 20:02:09 2007 UTC - */ +/** + * @file + * @brief Dungeon-builder Lua interface. +**/ #ifndef DLUA_H #define DLUA_H diff --git a/crawl-ref/source/dungeon.cc b/crawl-ref/source/dungeon.cc index 37c026f7cc..2255034d7e 100644 --- a/crawl-ref/source/dungeon.cc +++ b/crawl-ref/source/dungeon.cc @@ -1,8 +1,7 @@ -/* - * File: dungeon.cc - * Summary: Functions used when building new levels. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when building new levels. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/dungeon.h b/crawl-ref/source/dungeon.h index be42ac6448..686add427c 100644 --- a/crawl-ref/source/dungeon.h +++ b/crawl-ref/source/dungeon.h @@ -1,8 +1,7 @@ -/* - * File: dungeon.h - * Summary: Functions used when building new levels. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when building new levels. +**/ #ifndef DUNGEON_H diff --git a/crawl-ref/source/effects.cc b/crawl-ref/source/effects.cc index a88002f20c..5b96abad3b 100644 --- a/crawl-ref/source/effects.cc +++ b/crawl-ref/source/effects.cc @@ -1,8 +1,7 @@ -/* - * File: effects.cc - * Summary: Misc stuff. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc stuff. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/effects.h b/crawl-ref/source/effects.h index c55a2a2afc..41a121665f 100644 --- a/crawl-ref/source/effects.h +++ b/crawl-ref/source/effects.h @@ -1,8 +1,7 @@ -/* - * File: effects.h - * Summary: Misc stuff. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc stuff. +**/ #ifndef EFFECTS_H diff --git a/crawl-ref/source/enum.h b/crawl-ref/source/enum.h index 75d9bca3ba..4acfb7d5e3 100644 --- a/crawl-ref/source/enum.h +++ b/crawl-ref/source/enum.h @@ -1,8 +1,7 @@ -/* - * File: enum.h - * Summary: Global (ick) enums. - * Written by: Daniel Ligon - */ +/** + * @file + * @brief Global (ick) enums. +**/ #ifndef ENUM_H diff --git a/crawl-ref/source/errors.cc b/crawl-ref/source/errors.cc index ce5e2cd59f..8a335dde01 100644 --- a/crawl-ref/source/errors.cc +++ b/crawl-ref/source/errors.cc @@ -1,8 +1,7 @@ -/* - * File: errors.cc - * Summary: Handling of error conditions that are not program bugs. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Handling of error conditions that are not program bugs. +**/ #include <stdarg.h> #include <errno.h> diff --git a/crawl-ref/source/exclude.cc b/crawl-ref/source/exclude.cc index 63101f34f2..5c6fd6d790 100644 --- a/crawl-ref/source/exclude.cc +++ b/crawl-ref/source/exclude.cc @@ -1,7 +1,7 @@ -/* - * File: exclude.cc - * Summary: Code related to travel exclusions. - */ +/** + * @file + * @brief Code related to travel exclusions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/exercise.cc b/crawl-ref/source/exercise.cc index 654da744a4..d3110a74b5 100644 --- a/crawl-ref/source/exercise.cc +++ b/crawl-ref/source/exercise.cc @@ -1,8 +1,8 @@ -/* - * File: exercise.cc - * Summary: Collects all calls to skills.cc:exercise for - * easier changes to the training modell. - */ +/** + * @file + * @brief Collects all calls to skills.cc:exercise for + * easier changes to the training modell. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/exercise.h b/crawl-ref/source/exercise.h index b47abaa025..4415533cad 100644 --- a/crawl-ref/source/exercise.h +++ b/crawl-ref/source/exercise.h @@ -1,8 +1,8 @@ -/* - * File: exercise.h - * Summary: Collects all calls to skills.cc:exercise for - * easier changes to the training modell. - */ +/** + * @file + * @brief Collects all calls to skills.cc:exercise for + * easier changes to the training modell. +**/ #ifndef EXERCISE_H #define EXERCISE_H diff --git a/crawl-ref/source/externs.h b/crawl-ref/source/externs.h index 9bf6c869fe..e3c2a550f5 100644 --- a/crawl-ref/source/externs.h +++ b/crawl-ref/source/externs.h @@ -1,8 +1,7 @@ -/* - * File: externs.h - * Summary: Fixed size 2D vector class that asserts if you do something bad. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Fixed size 2D vector class that asserts if you do something bad. +**/ #ifndef EXTERNS_H #define EXTERNS_H diff --git a/crawl-ref/source/fearmonger.cc b/crawl-ref/source/fearmonger.cc index 84feddb77e..05fb53765a 100644 --- a/crawl-ref/source/fearmonger.cc +++ b/crawl-ref/source/fearmonger.cc @@ -1,7 +1,7 @@ -/* - * File: fearmonger.cc - * Summary: player methods dealing with mesmerisation. - */ +/** + * @file + * @brief player methods dealing with mesmerisation. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/fight.cc b/crawl-ref/source/fight.cc index c9496ca442..4a3cf75c1d 100644 --- a/crawl-ref/source/fight.cc +++ b/crawl-ref/source/fight.cc @@ -1,8 +1,7 @@ -/* - * File: fight.cc - * Summary: Functions used during combat. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used during combat. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/fight.h b/crawl-ref/source/fight.h index 5bb77aa645..95c330b071 100644 --- a/crawl-ref/source/fight.h +++ b/crawl-ref/source/fight.h @@ -1,8 +1,7 @@ -/* - * File: fight.h - * Summary: Functions used during combat. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used during combat. +**/ #ifndef FIGHT_H diff --git a/crawl-ref/source/files.cc b/crawl-ref/source/files.cc index f8b25b0807..eb0db1a4e7 100644 --- a/crawl-ref/source/files.cc +++ b/crawl-ref/source/files.cc @@ -1,8 +1,7 @@ -/* - * File: files.cc - * Summary: Functions used to save and load levels/games. - * Written by: Linley Henzell and Alexey Guzeev - */ +/** + * @file + * @brief Functions used to save and load levels/games. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/files.h b/crawl-ref/source/files.h index e927a35e9a..4b0aa917b2 100644 --- a/crawl-ref/source/files.h +++ b/crawl-ref/source/files.h @@ -1,8 +1,7 @@ -/* - * File: files.h - * Summary: Functions used to save and load levels/games. - * Written by: Linley Henzell and Alexey Guzeev - */ +/** + * @file + * @brief Functions used to save and load levels/games. +**/ #ifndef FILES_H diff --git a/crawl-ref/source/fineff.cc b/crawl-ref/source/fineff.cc index 116da6331e..239e029053 100644 --- a/crawl-ref/source/fineff.cc +++ b/crawl-ref/source/fineff.cc @@ -1,9 +1,8 @@ -/* - * File: fineff.cc - * Summary: Brand/ench/etc effects that might alter something in an - * unexpected way. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Brand/ench/etc effects that might alter something in an + * unexpected way. +**/ #include "AppHdr.h" #include <math.h> diff --git a/crawl-ref/source/fineff.h b/crawl-ref/source/fineff.h index 3f821ec94b..17ad864a91 100644 --- a/crawl-ref/source/fineff.h +++ b/crawl-ref/source/fineff.h @@ -1,9 +1,8 @@ -/* - * File: fineff.h - * Summary: Brand/ench/etc effects that might alter something in an - * unexpected way. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Brand/ench/etc effects that might alter something in an + * unexpected way. +**/ #ifndef FINEFF_H #define FINEFF_H diff --git a/crawl-ref/source/fixedarray.h b/crawl-ref/source/fixedarray.h index a46a4fd416..6425085912 100644 --- a/crawl-ref/source/fixedarray.h +++ b/crawl-ref/source/fixedarray.h @@ -1,8 +1,7 @@ -/* - * File: fixedarray.h - * Summary: Fixed size 2D vector class that asserts if you do something bad. - * Written by: Jesse Jones - */ +/** + * @file + * @brief Fixed size 2D vector class that asserts if you do something bad. +**/ #ifndef FIXARY_H #define FIXARY_H diff --git a/crawl-ref/source/fixedvector.h b/crawl-ref/source/fixedvector.h index ad8a666258..48bb0d6f88 100644 --- a/crawl-ref/source/fixedvector.h +++ b/crawl-ref/source/fixedvector.h @@ -1,8 +1,7 @@ -/* - * File: fixedvector.h - * Summary: Fixed size vector class that asserts if you do something bad. - * Written by: Jesse Jones - */ +/** + * @file + * @brief Fixed size vector class that asserts if you do something bad. +**/ #ifndef FIXVEC_H #define FIXVEC_H diff --git a/crawl-ref/source/flood_find.h b/crawl-ref/source/flood_find.h index b1b99cbd32..ad67487b73 100644 --- a/crawl-ref/source/flood_find.h +++ b/crawl-ref/source/flood_find.h @@ -1,7 +1,7 @@ -/* - * File: flood_find.h - * Summary: flood_find template - */ +/** + * @file + * @brief flood_find template +**/ #ifndef FLOOD_FIND_H #define FLOOD_FIND_H diff --git a/crawl-ref/source/food.cc b/crawl-ref/source/food.cc index 4d086f9068..17caa64bb7 100644 --- a/crawl-ref/source/food.cc +++ b/crawl-ref/source/food.cc @@ -1,8 +1,7 @@ -/* - * File: food.cc - * Summary: Functions for eating and butchering. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for eating and butchering. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/food.h b/crawl-ref/source/food.h index 04c9703479..320931140e 100644 --- a/crawl-ref/source/food.h +++ b/crawl-ref/source/food.h @@ -1,8 +1,7 @@ -/* - * File: food.h - * Summary: Functions for eating and butchering. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for eating and butchering. +**/ #ifndef FOOD_H diff --git a/crawl-ref/source/fprop.cc b/crawl-ref/source/fprop.cc index 69f9209ac1..5141e29cbd 100644 --- a/crawl-ref/source/fprop.cc +++ b/crawl-ref/source/fprop.cc @@ -1,7 +1,7 @@ -/* - * File: envmap.cc - * Summary: Functions dealing with env.map_knowledge. - */ +/** + * @file + * @brief Functions dealing with env.map_knowledge. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/geom2d.cc b/crawl-ref/source/geom2d.cc index ca0f1a2ed1..019a24af8c 100644 --- a/crawl-ref/source/geom2d.cc +++ b/crawl-ref/source/geom2d.cc @@ -1,7 +1,7 @@ -/* - * File: geom2d.cc - * Summary: Plane geometry for shooting rays. - */ +/** + * @file + * @brief Plane geometry for shooting rays. +**/ #include "AppHdr.h" #include "debug.h" diff --git a/crawl-ref/source/ghost.cc b/crawl-ref/source/ghost.cc index b62dc1f428..0c53c2b800 100644 --- a/crawl-ref/source/ghost.cc +++ b/crawl-ref/source/ghost.cc @@ -1,10 +1,7 @@ -/* - * File: ghost.cc - * Summary: Player ghost and random Pandemonium demon handling. - * - * Created for Dungeon Crawl Reference by dshaligram on - * Thu Mar 15 20:10:20 2007 UTC. - */ +/** + * @file + * @brief Player ghost and random Pandemonium demon handling. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/ghost.h b/crawl-ref/source/ghost.h index 930e75fac0..fe74a6eee1 100644 --- a/crawl-ref/source/ghost.h +++ b/crawl-ref/source/ghost.h @@ -1,10 +1,7 @@ -/* - * File: ghost.h - * Summary: Player ghost and random Pandemonium demon handling. - * - * Created for Dungeon Crawl Reference by dshaligram on - * Thu Mar 15 20:10:20 2007 UTC. - */ +/** + * @file + * @brief Player ghost and random Pandemonium demon handling. +**/ #ifndef GHOST_H #define GHOST_H diff --git a/crawl-ref/source/godabil.cc b/crawl-ref/source/godabil.cc index 358237e2dd..87db9aae5f 100644 --- a/crawl-ref/source/godabil.cc +++ b/crawl-ref/source/godabil.cc @@ -1,7 +1,7 @@ -/* - * File: godabil.cc - * Summary: God-granted abilities. - */ +/** + * @file + * @brief God-granted abilities. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/godabil.h b/crawl-ref/source/godabil.h index b755a11a93..aa11364c2e 100644 --- a/crawl-ref/source/godabil.h +++ b/crawl-ref/source/godabil.h @@ -1,7 +1,7 @@ -/* - * File: godabil.h - * Summary: God-granted abilities. - */ +/** + * @file + * @brief God-granted abilities. +**/ #ifndef GODABIL_H #define GODABIL_H diff --git a/crawl-ref/source/godconduct.h b/crawl-ref/source/godconduct.h index a004e4c647..355e1b5365 100644 --- a/crawl-ref/source/godconduct.h +++ b/crawl-ref/source/godconduct.h @@ -1,7 +1,7 @@ -/* - * File: godconduct.h - * Summary: Stuff related to conducts. - */ +/** + * @file + * @brief Stuff related to conducts. +**/ #ifndef GODCONDUCT_H #define GODCONDUCT_H diff --git a/crawl-ref/source/goditem.cc b/crawl-ref/source/goditem.cc index e0ef2d01db..8e811fd84b 100644 --- a/crawl-ref/source/goditem.cc +++ b/crawl-ref/source/goditem.cc @@ -1,7 +1,7 @@ -/* - * File: goditem.cc - * Summary: Gods' attitude towards items. - */ +/** + * @file + * @brief Gods' attitude towards items. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/godpassive.h b/crawl-ref/source/godpassive.h index 9e5dd74af7..20980b473f 100644 --- a/crawl-ref/source/godpassive.h +++ b/crawl-ref/source/godpassive.h @@ -1,7 +1,7 @@ -/* - * File: godpassive.h - * Summary: Passive god effects. - */ +/** + * @file + * @brief Passive god effects. +**/ #ifndef GODPASSIVE_H #define GODPASSIVE_H diff --git a/crawl-ref/source/godprayer.h b/crawl-ref/source/godprayer.h index 8a1caece4c..d3cce477d6 100644 --- a/crawl-ref/source/godprayer.h +++ b/crawl-ref/source/godprayer.h @@ -1,7 +1,7 @@ -/* - * File: godprayer.h - * Summary: Prayer and sacrifice. - */ +/** + * @file + * @brief Prayer and sacrifice. +**/ #ifndef GODPRAYER_H #define GODPRAYER_H diff --git a/crawl-ref/source/godwrath.cc b/crawl-ref/source/godwrath.cc index c9d49ddb9c..2a9b76e526 100644 --- a/crawl-ref/source/godwrath.cc +++ b/crawl-ref/source/godwrath.cc @@ -1,7 +1,7 @@ -/* - * File: godwrath.cc - * Summary: Divine retribution. - */ +/** + * @file + * @brief Divine retribution. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/godwrath.h b/crawl-ref/source/godwrath.h index 9d167138d1..b8fefeebe3 100644 --- a/crawl-ref/source/godwrath.h +++ b/crawl-ref/source/godwrath.h @@ -1,7 +1,7 @@ -/* - * File: godwrath.h - * Summary: Divine retribution. - */ +/** + * @file + * @brief Divine retribution. +**/ #ifndef GODWRATH_H diff --git a/crawl-ref/source/hints.cc b/crawl-ref/source/hints.cc index a99da9c902..9f2b27b1b7 100644 --- a/crawl-ref/source/hints.cc +++ b/crawl-ref/source/hints.cc @@ -1,10 +1,9 @@ -/* - * File: hints.cc - * Summary: A hints mode as an introduction on how to play Dungeon Crawl. - * Written by: j-p-e-g +/** + * @file + * @brief A hints mode as an introduction on how to play Dungeon Crawl. * - * Created on 2007-01-11. - */ + * Created on 2007-01-11. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/hints.h b/crawl-ref/source/hints.h index 3499a7bb7b..9ac477d47d 100644 --- a/crawl-ref/source/hints.h +++ b/crawl-ref/source/hints.h @@ -1,10 +1,7 @@ -/* - * File: hints.h - * Summary: Stuff needed for hints mode - * Written by: j-p-e-g - * - * Created on 2007-01-11. - */ +/** + * @file + * @brief Stuff needed for hints mode +**/ #ifndef HINTS_H #define HINTS_H diff --git a/crawl-ref/source/hiscores.cc b/crawl-ref/source/hiscores.cc index f949b8fc0e..1379ffe9f3 100644 --- a/crawl-ref/source/hiscores.cc +++ b/crawl-ref/source/hiscores.cc @@ -1,8 +1,7 @@ -/* - * File: highscore.cc - * Summary: deal with reading and writing of highscore file - * Written by: Gordon Lipford - */ +/** + * @file + * @brief deal with reading and writing of highscore file +**/ /* * ----------- MODIFYING THE PRINTED SCORE FORMAT --------------------- diff --git a/crawl-ref/source/hiscores.h b/crawl-ref/source/hiscores.h index 3aa15dae9e..3767d63ebf 100644 --- a/crawl-ref/source/hiscores.h +++ b/crawl-ref/source/hiscores.h @@ -1,8 +1,7 @@ -/* - * File: hiscores.h - * Summary: Scorefile manipulation functions - * Written by: Gordon Lipford - */ +/** + * @file + * @brief Scorefile manipulation functions +**/ #ifndef HISCORES_H diff --git a/crawl-ref/source/initfile.cc b/crawl-ref/source/initfile.cc index 3430396e4d..3bef3aab01 100644 --- a/crawl-ref/source/initfile.cc +++ b/crawl-ref/source/initfile.cc @@ -1,8 +1,7 @@ -/* - * File: initfile.cc - * Summary: Simple reading of an init file and system variables - * Written by: David Loewenstern - */ +/** + * @file + * @brief Simple reading of an init file and system variables +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/initfile.h b/crawl-ref/source/initfile.h index df87757728..8bec38df00 100644 --- a/crawl-ref/source/initfile.h +++ b/crawl-ref/source/initfile.h @@ -1,8 +1,7 @@ -/* - * File: initfile.h - * Summary: Simple reading of init file. - * Written by: David Loewenstern - */ +/** + * @file + * @brief Simple reading of init file. +**/ #ifndef INITFILE_H diff --git a/crawl-ref/source/invent.cc b/crawl-ref/source/invent.cc index 7e57a8eacd..ad77bd191a 100644 --- a/crawl-ref/source/invent.cc +++ b/crawl-ref/source/invent.cc @@ -1,8 +1,7 @@ -/* - * File: invent.cc - * Summary: Functions for inventory related commands. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for inventory related commands. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/invent.h b/crawl-ref/source/invent.h index c0a3ec40a3..150ba843da 100644 --- a/crawl-ref/source/invent.h +++ b/crawl-ref/source/invent.h @@ -1,8 +1,7 @@ -/* - * File: invent.h - * Summary: Functions for inventory related commands. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for inventory related commands. +**/ #ifndef INVENT_H diff --git a/crawl-ref/source/it_use3.cc b/crawl-ref/source/it_use3.cc index aa88a3d63f..3841be13df 100644 --- a/crawl-ref/source/it_use3.cc +++ b/crawl-ref/source/it_use3.cc @@ -1,8 +1,7 @@ -/* - * File: it_use3.cc - * Summary: Functions for using some of the wackier inventory items. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for using some of the wackier inventory items. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/it_use3.h b/crawl-ref/source/it_use3.h index e2e57268db..40426a1e02 100644 --- a/crawl-ref/source/it_use3.h +++ b/crawl-ref/source/it_use3.h @@ -1,8 +1,7 @@ -/* - * File: it_use3.h - * Summary: Functions for using some of the wackier inventory items. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for using some of the wackier inventory items. +**/ #ifndef IT_USE3_H diff --git a/crawl-ref/source/item_use.cc b/crawl-ref/source/item_use.cc index 3b010e0aaf..4d75e9c259 100644 --- a/crawl-ref/source/item_use.cc +++ b/crawl-ref/source/item_use.cc @@ -1,8 +1,7 @@ -/* - * File: item_use.cc - * Summary: Functions for making use of inventory items. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for making use of inventory items. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/item_use.h b/crawl-ref/source/item_use.h index 69d6bf2fb0..c51d2c1328 100644 --- a/crawl-ref/source/item_use.h +++ b/crawl-ref/source/item_use.h @@ -1,8 +1,7 @@ -/* - * File: item_use.h - * Summary: Functions for making use of inventory items. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for making use of inventory items. +**/ #ifndef ITEM_USE_H diff --git a/crawl-ref/source/itemname.cc b/crawl-ref/source/itemname.cc index ca6e9024be..cb7717d7a8 100644 --- a/crawl-ref/source/itemname.cc +++ b/crawl-ref/source/itemname.cc @@ -1,8 +1,7 @@ -/* - * File: itemname.cc - * Summary: Misc functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/itemname.h b/crawl-ref/source/itemname.h index 2f61522f43..ae9275bd3a 100644 --- a/crawl-ref/source/itemname.h +++ b/crawl-ref/source/itemname.h @@ -1,8 +1,7 @@ -/* - * File: itemname.h - * Summary: Misc functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc functions. +**/ #ifndef ITEMNAME_H diff --git a/crawl-ref/source/itemprop.cc b/crawl-ref/source/itemprop.cc index adcec81069..0ae59963cc 100644 --- a/crawl-ref/source/itemprop.cc +++ b/crawl-ref/source/itemprop.cc @@ -1,8 +1,7 @@ -/* - * File: itemprop.h - * Summary: Misc functions. - * Written by: Brent Ross - */ +/** + * @file + * @brief Misc functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/itemprop.h b/crawl-ref/source/itemprop.h index b7974e3947..454bb7f8df 100644 --- a/crawl-ref/source/itemprop.h +++ b/crawl-ref/source/itemprop.h @@ -1,8 +1,7 @@ -/* - * File: itemprop.h - * Summary: Misc functions. - * Written by: Brent Ross - */ +/** + * @file + * @brief Misc functions. +**/ #ifndef ITEMPROP_H diff --git a/crawl-ref/source/items.cc b/crawl-ref/source/items.cc index 4caaec3b6d..4b671e21b3 100644 --- a/crawl-ref/source/items.cc +++ b/crawl-ref/source/items.cc @@ -1,8 +1,7 @@ -/* - * File: items.cc - * Summary: Misc (mostly) inventory related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc (mostly) inventory related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/items.h b/crawl-ref/source/items.h index 9163e58a1f..036ea5924c 100644 --- a/crawl-ref/source/items.h +++ b/crawl-ref/source/items.h @@ -1,8 +1,7 @@ -/* - * File: items.h - * Summary: Misc (mostly) inventory related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc (mostly) inventory related functions. +**/ #ifndef ITEMS_H diff --git a/crawl-ref/source/kills.cc b/crawl-ref/source/kills.cc index f56e779ecb..a828d0c24c 100644 --- a/crawl-ref/source/kills.cc +++ b/crawl-ref/source/kills.cc @@ -1,8 +1,7 @@ -/* - * File: kills.cc - * Summary: Player kill tracking - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Player kill tracking +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/kills.h b/crawl-ref/source/kills.h index 6d68dd52cd..00e96e3036 100644 --- a/crawl-ref/source/kills.h +++ b/crawl-ref/source/kills.h @@ -1,8 +1,7 @@ -/* - * File: kills.h - * Summary: Tracks monsters the player has killed. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Tracks monsters the player has killed. +**/ #ifndef KILLS_H #define KILLS_H diff --git a/crawl-ref/source/l_colour.cc b/crawl-ref/source/l_colour.cc index 78955bfeaf..a406921f96 100644 --- a/crawl-ref/source/l_colour.cc +++ b/crawl-ref/source/l_colour.cc @@ -1,7 +1,7 @@ -/* - * File: l_colour.cc - * Summary: Colour related functions - */ +/** + * @file + * @brief Colour related functions +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_crawl.cc b/crawl-ref/source/l_crawl.cc index 1a59272535..54ad73a854 100644 --- a/crawl-ref/source/l_crawl.cc +++ b/crawl-ref/source/l_crawl.cc @@ -1,7 +1,7 @@ -/* - * File: l_crawl.cc - * Summary: General game bindings. - */ +/** + * @file + * @brief General game bindings. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_debug.cc b/crawl-ref/source/l_debug.cc index 0ca2ee8523..d0cf583b40 100644 --- a/crawl-ref/source/l_debug.cc +++ b/crawl-ref/source/l_debug.cc @@ -1,7 +1,7 @@ -/* - * File: l_debug.cc - * Summary: Various debugging bindings. - */ +/** + * @file + * @brief Various debugging bindings. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_defs.h b/crawl-ref/source/l_defs.h index 07c1605f74..058ec9d744 100644 --- a/crawl-ref/source/l_defs.h +++ b/crawl-ref/source/l_defs.h @@ -1,9 +1,8 @@ -/* - * File: l_defs.h - * Summary: Functions defined in the Lua bindings but used elsewhere. - * - * TODO: Move these where they belong. - */ +/** + * @file + * @brief Functions defined in the Lua bindings but used elsewhere. +**/ +// TODO: Move these where they belong. #ifndef L_DEFS_H #define L_DEFS_H diff --git a/crawl-ref/source/l_dgnbld.cc b/crawl-ref/source/l_dgnbld.cc index acf2daa7a4..6e58d9a4ff 100644 --- a/crawl-ref/source/l_dgnbld.cc +++ b/crawl-ref/source/l_dgnbld.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgnbld.cc - * Summary: Building routines (library "dgn"). - */ +/** + * @file + * @brief Building routines (library "dgn"). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_dgngrd.cc b/crawl-ref/source/l_dgngrd.cc index 6344755ea4..40bdfb22fc 100644 --- a/crawl-ref/source/l_dgngrd.cc +++ b/crawl-ref/source/l_dgngrd.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgngrd.cc - * Summary: Grid and dungeon_feature_type-related bindings. - */ +/** + * @file + * @brief Grid and dungeon_feature_type-related bindings. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_dgnit.cc b/crawl-ref/source/l_dgnit.cc index eadc8fc7e1..e180cfe658 100644 --- a/crawl-ref/source/l_dgnit.cc +++ b/crawl-ref/source/l_dgnit.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgnit.cc - * Summary: Item-related functions in lua library "dgn". - */ +/** + * @file + * @brief Item-related functions in lua library "dgn". +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_dgnlvl.cc b/crawl-ref/source/l_dgnlvl.cc index c93aca7944..a66088807d 100644 --- a/crawl-ref/source/l_dgnlvl.cc +++ b/crawl-ref/source/l_dgnlvl.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgnlvl.cc - * Summary: Level and branch bindings (library "dgn"). - */ +/** + * @file + * @brief Level and branch bindings (library "dgn"). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_dgnmon.cc b/crawl-ref/source/l_dgnmon.cc index 87e448349d..1cd73ec6dd 100644 --- a/crawl-ref/source/l_dgnmon.cc +++ b/crawl-ref/source/l_dgnmon.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgnmon.cc - * Summary: Monster-related functions in lua library "dgn". - */ +/** + * @file + * @brief Monster-related functions in lua library "dgn". +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_dgntil.cc b/crawl-ref/source/l_dgntil.cc index 707e2989fb..beaa39195f 100644 --- a/crawl-ref/source/l_dgntil.cc +++ b/crawl-ref/source/l_dgntil.cc @@ -1,7 +1,7 @@ -/* - * File: l_dgntile.cc - * Summary: Tiles-specific dungeon builder functions. - */ +/** + * @file + * @brief Tiles-specific dungeon builder functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_feat.cc b/crawl-ref/source/l_feat.cc index d19f4fe233..8f373ffd42 100644 --- a/crawl-ref/source/l_feat.cc +++ b/crawl-ref/source/l_feat.cc @@ -1,7 +1,7 @@ -/* - * File: l_feat.cc - * Summary: Boolean feat-related functions lua library "feat". - */ +/** + * @file + * @brief Boolean feat-related functions lua library "feat". +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_item.cc b/crawl-ref/source/l_item.cc index e11edb927a..3610aed557 100644 --- a/crawl-ref/source/l_item.cc +++ b/crawl-ref/source/l_item.cc @@ -1,7 +1,7 @@ -/* - * File: l_items.cc - * Summary: functions for managed Lua item manipulation - */ +/** + * @file + * @brief functions for managed Lua item manipulation +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_libs.h b/crawl-ref/source/l_libs.h index 1ca8b2ca87..14bf36a4d5 100644 --- a/crawl-ref/source/l_libs.h +++ b/crawl-ref/source/l_libs.h @@ -1,7 +1,7 @@ -/* - * File: l_libs.h - * Summary: Library definitions for dlua. - */ +/** + * @file + * @brief Library definitions for dlua. +**/ #ifndef L_LIBS_H #define L_LIBS_H diff --git a/crawl-ref/source/l_los.cc b/crawl-ref/source/l_los.cc index 75f3d1c6e6..18ad20d8e9 100644 --- a/crawl-ref/source/l_los.cc +++ b/crawl-ref/source/l_los.cc @@ -1,8 +1,7 @@ -/* - * File: l_los.cc - * Summary: Lua bindings for LOS. - * Created by: Robert Vollmert - */ +/** + * @file + * @brief Lua bindings for LOS. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_moninf.cc b/crawl-ref/source/l_moninf.cc index 5cb3d4fa9f..21eac329a1 100644 --- a/crawl-ref/source/l_moninf.cc +++ b/crawl-ref/source/l_moninf.cc @@ -1,7 +1,7 @@ -/* - * File: l_moninf.cc - * Summary: User-accessible monster info. - */ +/** + * @file + * @brief User-accessible monster info. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_spells.cc b/crawl-ref/source/l_spells.cc index ba9decae45..31336fd8f8 100644 --- a/crawl-ref/source/l_spells.cc +++ b/crawl-ref/source/l_spells.cc @@ -1,7 +1,7 @@ -/* - * File: l_spells.cc - * Summary: Boolean feat-related functions lua library "feat". - */ +/** + * @file + * @brief Boolean feat-related functions lua library "feat". +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_subvault.cc b/crawl-ref/source/l_subvault.cc index f15963b222..2a489e700d 100644 --- a/crawl-ref/source/l_subvault.cc +++ b/crawl-ref/source/l_subvault.cc @@ -1,7 +1,7 @@ -/* - * File: l_subvault.cc - * Summary: Subvault routines (library "dgn"). - */ +/** + * @file + * @brief Subvault routines (library "dgn"). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_travel.cc b/crawl-ref/source/l_travel.cc index 875b357b2b..d2c04b3245 100644 --- a/crawl-ref/source/l_travel.cc +++ b/crawl-ref/source/l_travel.cc @@ -1,7 +1,7 @@ -/* - * File: l_travel.cc - * Summary: Travel and exclusions. - */ +/** + * @file + * @brief Travel and exclusions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/l_view.cc b/crawl-ref/source/l_view.cc index 2897afbfe6..7e10fb41b0 100644 --- a/crawl-ref/source/l_view.cc +++ b/crawl-ref/source/l_view.cc @@ -1,7 +1,7 @@ -/* - * File: l_view.cc - * Summary: User interaction with env.show. - */ +/** + * @file + * @brief User interaction with env.show. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/lev-pand.cc b/crawl-ref/source/lev-pand.cc index 8a6a4c4d79..1817b8f8a1 100644 --- a/crawl-ref/source/lev-pand.cc +++ b/crawl-ref/source/lev-pand.cc @@ -1,8 +1,7 @@ -/* - * File: lev-pand.cc - * Summary: Functions used in Pandemonium. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used in Pandemonium. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/lev-pand.h b/crawl-ref/source/lev-pand.h index 8c8e18f6ff..d97d3e1033 100644 --- a/crawl-ref/source/lev-pand.h +++ b/crawl-ref/source/lev-pand.h @@ -1,8 +1,7 @@ -/* - * File: lev-pand.h - * Summary: Functions used in Pandemonium. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used in Pandemonium. +**/ #ifndef LEVPAND_H diff --git a/crawl-ref/source/libdos.cc b/crawl-ref/source/libdos.cc index db2eae669d..45ea370d5f 100644 --- a/crawl-ref/source/libdos.cc +++ b/crawl-ref/source/libdos.cc @@ -1,11 +1,7 @@ -/* - * File: libdos.cc - * Summary: Functions for DOS support. - * Needed by makefile.dos. - * Written by: Darshan Shaligram - * - * Added for Crawl Reference by dshaligram on Wed Nov 22 08:41:20 2006 UTC - */ +/** + * @file + * @brief Functions for DOS support. Needed by makefile.dos. +**/ // Every .cc must include AppHdr or bad things happen. #include "AppHdr.h" diff --git a/crawl-ref/source/libdos.h b/crawl-ref/source/libdos.h index 106bdc1d6b..057e4034df 100644 --- a/crawl-ref/source/libdos.h +++ b/crawl-ref/source/libdos.h @@ -1,10 +1,7 @@ -/* - * File: libdos.h - * Summary: Functions for DOS support. - * Written by: Darshan Shaligram - * - * Added for Crawl Reference by dshaligram on Wed Nov 22 08:41:20 2006 UTC - */ +/** + * @file + * @brief Functions for DOS support. +**/ #ifndef __LIBDOS_H__ #define __LIBDOS_H__ diff --git a/crawl-ref/source/libgui.cc b/crawl-ref/source/libgui.cc index e07794d5ea..cf9034ca79 100644 --- a/crawl-ref/source/libgui.cc +++ b/crawl-ref/source/libgui.cc @@ -1,8 +1,7 @@ -/* - * File: libgui.cc - * Summary: Functions that any display port needs to implement. - * Written by: M.Itakura - */ +/** + * @file + * @brief Functions that any display port needs to implement. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/libgui.h b/crawl-ref/source/libgui.h index 603731398b..f5612fab00 100644 --- a/crawl-ref/source/libgui.h +++ b/crawl-ref/source/libgui.h @@ -1,8 +1,7 @@ -/* - * File: libgui.cc - * Summary: Functions for x11 - * Written by: M.Itakura (?) - */ +/** + * @file + * @brief Functions for x11 +**/ // TODO enne - slowly morph this into tilesdl.h diff --git a/crawl-ref/source/libunix.cc b/crawl-ref/source/libunix.cc index 9408f3dfac..68268e56f0 100644 --- a/crawl-ref/source/libunix.cc +++ b/crawl-ref/source/libunix.cc @@ -1,8 +1,8 @@ -/* - * File: libunix.cc - * Summary: Functions for unix and curses support - * Needed by makefile.unix. - */ +/** + * @file + * @brief Functions for unix and curses support + * Needed by makefile.unix. +**/ /* Some replacement routines missing in gcc Some of these are inspired by/stolen from the Linux-conio package diff --git a/crawl-ref/source/libutil.cc b/crawl-ref/source/libutil.cc index 79e5745f7f..97141da52f 100644 --- a/crawl-ref/source/libutil.cc +++ b/crawl-ref/source/libutil.cc @@ -1,7 +1,7 @@ -/* - * File: libutil.cc - * Summary: Functions that may be missing from some systems - */ +/** + * @file + * @brief Functions that may be missing from some systems +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/libutil.h b/crawl-ref/source/libutil.h index dfd239f985..c12dc2b09c 100644 --- a/crawl-ref/source/libutil.h +++ b/crawl-ref/source/libutil.h @@ -1,7 +1,7 @@ -/* - * File: libutil.h - * Summary: System independent functions - */ +/** + * @file + * @brief System independent functions +**/ #ifndef LIBUTIL_H #define LIBUTIL_H diff --git a/crawl-ref/source/los.cc b/crawl-ref/source/los.cc index c4d50880d8..1f6158005d 100644 --- a/crawl-ref/source/los.cc +++ b/crawl-ref/source/los.cc @@ -1,6 +1,6 @@ -/* - * File: los.cc - * Summary: Line-of-sight algorithm. +/** + * @file + * @brief Line-of-sight algorithm. * * * @@ -38,7 +38,7 @@ * The code provides functions for filling LOS information * around a given center efficiently, and for querying rays * between two given cells. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/los.h b/crawl-ref/source/los.h index c18b3ee15b..4736aabd95 100644 --- a/crawl-ref/source/los.h +++ b/crawl-ref/source/los.h @@ -1,7 +1,7 @@ -/* - * File: los.h - * Summary: Line-of-sight algorithm. - */ +/** + * @file + * @brief Line-of-sight algorithm. +**/ #ifndef LOS_H #define LOS_H diff --git a/crawl-ref/source/los_def.cc b/crawl-ref/source/los_def.cc index 4286d56eba..1367a22bf4 100644 --- a/crawl-ref/source/los_def.cc +++ b/crawl-ref/source/los_def.cc @@ -1,7 +1,7 @@ -/* - * File: los_def.cc - * Summary: LOS wrapper class. - */ +/** + * @file + * @brief LOS wrapper class. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/losparam.cc b/crawl-ref/source/losparam.cc index 70b2c4be4e..bf35185c78 100644 --- a/crawl-ref/source/losparam.cc +++ b/crawl-ref/source/losparam.cc @@ -1,7 +1,7 @@ -/* - * File: losparam.h - * Summary: Parameters for the LOS algorithm - */ +/** + * @file + * @brief Parameters for the LOS algorithm +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/losparam.h b/crawl-ref/source/losparam.h index e702e129dc..517e7c253d 100644 --- a/crawl-ref/source/losparam.h +++ b/crawl-ref/source/losparam.h @@ -1,7 +1,7 @@ -/* - * File: losparam.h - * Summary: Parameters for the LOS algorithm - */ +/** + * @file + * @brief Parameters for the LOS algorithm +**/ #ifndef LOSPARAM_H #define LOSPARAM_H diff --git a/crawl-ref/source/luaterp.cc b/crawl-ref/source/luaterp.cc index a775057330..51f9074ae4 100644 --- a/crawl-ref/source/luaterp.cc +++ b/crawl-ref/source/luaterp.cc @@ -1,16 +1,16 @@ -/* - * File: luaterp.cc - * Summary: An interactive lua interpreter. +/** + * @file + * @brief An interactive lua interpreter. * * Based heavily on lua.c from the Lua distribution. * * Deficiencies: * - Currently requires defining a global function __echo - * to echo results. + * to echo results. * - Currently requires prefixing with '=' if you want results echoed. * - Appears to require delay_message_clear = true. * - Old input lines are not visible. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/macro.cc b/crawl-ref/source/macro.cc index 2162597f47..991d282e46 100644 --- a/crawl-ref/source/macro.cc +++ b/crawl-ref/source/macro.cc @@ -1,8 +1,7 @@ -/* - * File: macro.cc - * Summary: Crude macro-capability - * Written by: Juho Snellman <jsnell@lyseo.edu.ouka.fi> - */ +/** + * @file + * @brief Crude macro-capability +**/ /* * The macro-implementation works like this: diff --git a/crawl-ref/source/macro.h b/crawl-ref/source/macro.h index d4009e083d..0b7f5410ce 100644 --- a/crawl-ref/source/macro.h +++ b/crawl-ref/source/macro.h @@ -1,8 +1,7 @@ -/* - * File: macro.cc - * Summary: Crude macro-capability - * Written by: Juho Snellman <jsnell@lyseo.edu.ouka.fi> - */ +/** + * @file + * @brief Crude macro-capability +**/ #ifndef MACRO_H #define MACRO_H diff --git a/crawl-ref/source/main.cc b/crawl-ref/source/main.cc index 78820994c0..c4a4fc8686 100644 --- a/crawl-ref/source/main.cc +++ b/crawl-ref/source/main.cc @@ -1,8 +1,7 @@ -/* - * File: main.cc - * Summary: Main entry point, event loop, and some initialization functions - * Written by: Linley Henzell - */ +/** + * @file + * @brief Main entry point, event loop, and some initialization functions +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/makeitem.cc b/crawl-ref/source/makeitem.cc index 04f9842543..ac8d448a61 100644 --- a/crawl-ref/source/makeitem.cc +++ b/crawl-ref/source/makeitem.cc @@ -1,8 +1,7 @@ -/* - * File: makeitem.cc - * Summary: Item creation routines. - * Created by: haranp on Sat Apr 21 11:31:42 2007 UTC - */ +/** + * @file + * @brief Item creation routines. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/makeitem.h b/crawl-ref/source/makeitem.h index 4de0ccb51e..2c4bde2985 100644 --- a/crawl-ref/source/makeitem.h +++ b/crawl-ref/source/makeitem.h @@ -1,8 +1,7 @@ -/* - * File: makeitem.h - * Summary: Item creation routines. - * Created by: haranp on Sat Apr 21 11:31:42 2007 UTC - */ +/** + * @file + * @brief Item creation routines. +**/ #ifndef MAKEITEM_H #define MAKEITEM_H diff --git a/crawl-ref/source/mapmark.cc b/crawl-ref/source/mapmark.cc index f8607fc0dc..ab1e1e3844 100644 --- a/crawl-ref/source/mapmark.cc +++ b/crawl-ref/source/mapmark.cc @@ -1,8 +1,7 @@ -/* - * File: mapmark.cc - * Summary: Level markers (annotations). - * Created by: dshaligram on Sat Jul 21 12:17:29 2007 UTC - */ +/** + * @file + * @brief Level markers (annotations). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mapmark.h b/crawl-ref/source/mapmark.h index a26956aae1..3f699817a7 100644 --- a/crawl-ref/source/mapmark.h +++ b/crawl-ref/source/mapmark.h @@ -1,8 +1,7 @@ -/* - * File: mapmark.cc - * Summary: Level markers (annotations). - * Created by: dshaligram on Sat Jul 21 12:17:29 2007 UTC - */ +/** + * @file + * @brief Level markers (annotations). +**/ #ifndef __MAPMARK_H__ #define __MAPMARK_H__ diff --git a/crawl-ref/source/maps.cc b/crawl-ref/source/maps.cc index 946edd16ea..789bb80e44 100644 --- a/crawl-ref/source/maps.cc +++ b/crawl-ref/source/maps.cc @@ -1,8 +1,7 @@ -/* - * File: maps.cc - * Summary: Functions used to create vaults. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to create vaults. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/maps.h b/crawl-ref/source/maps.h index 638ab6dc54..dedf581e53 100644 --- a/crawl-ref/source/maps.h +++ b/crawl-ref/source/maps.h @@ -1,8 +1,7 @@ -/* - * File: maps.cc - * Summary: Functions used to create vaults. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to create vaults. +**/ #ifndef MAPS_H diff --git a/crawl-ref/source/matrix.h b/crawl-ref/source/matrix.h index 2165d7c696..1a27041903 100644 --- a/crawl-ref/source/matrix.h +++ b/crawl-ref/source/matrix.h @@ -1,7 +1,7 @@ -/* - * File: matrix.h - * Summary: Two-dimensional array class. - */ +/** + * @file + * @brief Two-dimensional array class. +**/ #ifndef MATRIX_H #define MATRIX_H diff --git a/crawl-ref/source/menu.cc b/crawl-ref/source/menu.cc index 01197168af..033e599432 100644 --- a/crawl-ref/source/menu.cc +++ b/crawl-ref/source/menu.cc @@ -1,8 +1,7 @@ -/* - * File: menu.cc - * Summary: Menus and associated malarkey. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Menus and associated malarkey. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/menu.h b/crawl-ref/source/menu.h index a82772b1b5..0ce553ec06 100644 --- a/crawl-ref/source/menu.h +++ b/crawl-ref/source/menu.h @@ -1,8 +1,7 @@ -/* - * File: menu.h - * Summary: Menus and associated malarkey. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Menus and associated malarkey. +**/ #ifndef __MENU_H__ #define __MENU_H__ diff --git a/crawl-ref/source/message.cc b/crawl-ref/source/message.cc index d1d9699a5a..232251795a 100644 --- a/crawl-ref/source/message.cc +++ b/crawl-ref/source/message.cc @@ -1,7 +1,7 @@ -/* - * File: message.cc - * Summary: Functions used to print messages. - */ +/** + * @file + * @brief Functions used to print messages. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/message.h b/crawl-ref/source/message.h index edde74283c..27b9551698 100644 --- a/crawl-ref/source/message.h +++ b/crawl-ref/source/message.h @@ -1,8 +1,7 @@ -/* - * File: message.cc - * Summary: Functions used to print messages. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to print messages. +**/ #ifndef MESSAGE_H #define MESSAGE_H diff --git a/crawl-ref/source/misc.cc b/crawl-ref/source/misc.cc index c750f0e009..a1c2a8adc8 100644 --- a/crawl-ref/source/misc.cc +++ b/crawl-ref/source/misc.cc @@ -1,8 +1,7 @@ -/* - * File: misc.cc - * Summary: Misc functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/misc.h b/crawl-ref/source/misc.h index caecbdc750..6e04d9804a 100644 --- a/crawl-ref/source/misc.h +++ b/crawl-ref/source/misc.h @@ -1,8 +1,7 @@ -/* - * File: misc.h - * Summary: Misc functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc functions. +**/ #ifndef MISC_H #define MISC_H diff --git a/crawl-ref/source/misc/header b/crawl-ref/source/misc/header deleted file mode 100644 index 9f91952461..0000000000 --- a/crawl-ref/source/misc/header +++ /dev/null @@ -1,10 +0,0 @@ -/* - * File: - * Summary: - * Written by: - * - * Change History (most recent first): - * - * <1> --/--/-- --- Created - */ - diff --git a/crawl-ref/source/mon-abil.cc b/crawl-ref/source/mon-abil.cc index 85cf214158..d919c1f676 100644 --- a/crawl-ref/source/mon-abil.cc +++ b/crawl-ref/source/mon-abil.cc @@ -1,8 +1,7 @@ -/* - * File: mon-abil.cc - * Summary: Monster abilities. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monster abilities. +**/ #include "AppHdr.h" #include "mon-abil.h" diff --git a/crawl-ref/source/mon-abil.h b/crawl-ref/source/mon-abil.h index a0888eacf8..d8904186d6 100644 --- a/crawl-ref/source/mon-abil.h +++ b/crawl-ref/source/mon-abil.h @@ -1,8 +1,7 @@ -/* - * File: mon-abil.h - * Summary: Monster abilities. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monster abilities. +**/ #ifndef MONABIL_H #define MONABIL_H diff --git a/crawl-ref/source/mon-act.cc b/crawl-ref/source/mon-act.cc index ca23aca723..f926aa1eb5 100644 --- a/crawl-ref/source/mon-act.cc +++ b/crawl-ref/source/mon-act.cc @@ -1,8 +1,7 @@ -/* - * File: mon-act.cc - * Summary: Monsters doing stuff (monsters acting). - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monsters doing stuff (monsters acting). +**/ #include "AppHdr.h" #include "mon-act.h" diff --git a/crawl-ref/source/mon-act.h b/crawl-ref/source/mon-act.h index cf8d90876e..510943bc57 100644 --- a/crawl-ref/source/mon-act.h +++ b/crawl-ref/source/mon-act.h @@ -1,8 +1,7 @@ -/* - * File: mon-act.h - * Summary: Monsters doing stuff (monsters acting). - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monsters doing stuff (monsters acting). +**/ #ifndef MONACT_H #define MONACT_H diff --git a/crawl-ref/source/mon-behv.cc b/crawl-ref/source/mon-behv.cc index 649514c03e..ed7877c5ed 100644 --- a/crawl-ref/source/mon-behv.cc +++ b/crawl-ref/source/mon-behv.cc @@ -1,8 +1,7 @@ -/* - * File: mon-behv.h - * Summary: Monster behaviour functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monster behaviour functions. +**/ #include "AppHdr.h" #include "mon-behv.h" diff --git a/crawl-ref/source/mon-behv.h b/crawl-ref/source/mon-behv.h index 8ced20962f..f6f3928406 100644 --- a/crawl-ref/source/mon-behv.h +++ b/crawl-ref/source/mon-behv.h @@ -1,8 +1,7 @@ -/* - * File: mon-behv.h - * Summary: Monster behaviour functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monster behaviour functions. +**/ #ifndef MONBEHV_H #define MONBEHV_H diff --git a/crawl-ref/source/mon-cast.h b/crawl-ref/source/mon-cast.h index deecbb1ba2..fec2d1c9a1 100644 --- a/crawl-ref/source/mon-cast.h +++ b/crawl-ref/source/mon-cast.h @@ -1,8 +1,7 @@ -/* - * File: mon-cast.h - * Summary: Monster spell casting. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monster spell casting. +**/ #ifndef MONCAST_H #define MONCAST_H diff --git a/crawl-ref/source/mon-death.h b/crawl-ref/source/mon-death.h index cbcca6d710..5224ce0783 100644 --- a/crawl-ref/source/mon-death.h +++ b/crawl-ref/source/mon-death.h @@ -1,7 +1,7 @@ -/* - * File: mon-death.h - * Summary: Monster death functionality (kraken, uniques, and so-on). - */ +/** + * @file + * @brief Monster death functionality (kraken, uniques, and so-on). +**/ #ifndef MONDEATH_H #define MONDEATH_H diff --git a/crawl-ref/source/mon-enum.h b/crawl-ref/source/mon-enum.h index 29507a1751..6a3ca642ef 100644 --- a/crawl-ref/source/mon-enum.h +++ b/crawl-ref/source/mon-enum.h @@ -1,9 +1,10 @@ -/* - * Summary: Monster-related enums. +/** + * @file + * @brief Monster-related enums. * * Extracted from mon-util.h to cut down on mon-util.h * dependencies. - */ +**/ #ifndef MON_ENUM_H #define MON_ENUM_H diff --git a/crawl-ref/source/mon-gear.cc b/crawl-ref/source/mon-gear.cc index 482f731473..fee50471e8 100644 --- a/crawl-ref/source/mon-gear.cc +++ b/crawl-ref/source/mon-gear.cc @@ -1,7 +1,7 @@ -/* - * File: mon-gear.cc - * Summary: Monsters' starting equipment. - */ +/** + * @file + * @brief Monsters' starting equipment. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-gear.h b/crawl-ref/source/mon-gear.h index ec1128a925..8510386df3 100644 --- a/crawl-ref/source/mon-gear.h +++ b/crawl-ref/source/mon-gear.h @@ -1,7 +1,7 @@ -/* - * File: mon-gear.h - * Summary: Monsters' initial equipment. - */ +/** + * @file + * @brief Monsters' initial equipment. +**/ #ifndef MON_GEAR_H #define MON_GEAR_H diff --git a/crawl-ref/source/mon-grow.cc b/crawl-ref/source/mon-grow.cc index 0ff3e481a6..ca1f5248cf 100644 --- a/crawl-ref/source/mon-grow.cc +++ b/crawl-ref/source/mon-grow.cc @@ -1,8 +1,7 @@ -/* - * File: mon-grow.cc - * Summary: Monster level-up code. - * Written by: dshaligram on Fri Oct 26 08:33:37 2007 UTC - */ +/** + * @file + * @brief Monster level-up code. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-grow.h b/crawl-ref/source/mon-grow.h index 0f60bff722..feee8fdb38 100644 --- a/crawl-ref/source/mon-grow.h +++ b/crawl-ref/source/mon-grow.h @@ -1,8 +1,7 @@ -/* - * File: mon-grow.cc - * Summary: Monster level-up code. - * Written by: dshaligram on Fri Oct 26 08:33:37 2007 UTC - */ +/** + * @file + * @brief Monster level-up code. +**/ #ifndef __MGROW_H__ #define __MGROW_H__ diff --git a/crawl-ref/source/mon-info.cc b/crawl-ref/source/mon-info.cc index ef938a7f58..fadce0932a 100644 --- a/crawl-ref/source/mon-info.cc +++ b/crawl-ref/source/mon-info.cc @@ -1,9 +1,9 @@ -/* - * File: mon-info.cc - * Summary: Monster information that may be passed to the user. +/** + * @file + * @brief Monster information that may be passed to the user. * * Used to fill the monster pane and to pass monster info to Lua. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-iter.h b/crawl-ref/source/mon-iter.h index 7a5630ceef..754a0dd19c 100644 --- a/crawl-ref/source/mon-iter.h +++ b/crawl-ref/source/mon-iter.h @@ -1,10 +1,9 @@ -/* +/** + * @file * Provide a way to iterator over all monsters, * subject to a few common restrictions. - * - * TODO: - * - Iterate over actors? - */ +**/ +// TODO: Iterate over actors? #ifndef MON_ITER_H #define MON_ITER_H diff --git a/crawl-ref/source/mon-pick.cc b/crawl-ref/source/mon-pick.cc index 8f05910e9e..7e829a4f9b 100644 --- a/crawl-ref/source/mon-pick.cc +++ b/crawl-ref/source/mon-pick.cc @@ -1,8 +1,7 @@ -/* - * File: mon-pick.cc - * Summary: Functions used to help determine which monsters should appear. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to help determine which monsters should appear. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-pick.h b/crawl-ref/source/mon-pick.h index c0322b164e..e8d0e18a4d 100644 --- a/crawl-ref/source/mon-pick.h +++ b/crawl-ref/source/mon-pick.h @@ -1,8 +1,7 @@ -/* - * File: mon-pick.h - * Summary: Functions used to help determine which monsters should appear. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to help determine which monsters should appear. +**/ #ifndef MONPICK_H diff --git a/crawl-ref/source/mon-place.cc b/crawl-ref/source/mon-place.cc index 77d9982321..be8d69a6b2 100644 --- a/crawl-ref/source/mon-place.cc +++ b/crawl-ref/source/mon-place.cc @@ -1,8 +1,7 @@ -/* - * File: mon-place.cc - * Summary: Functions used when placing monsters in the dungeon. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when placing monsters in the dungeon. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-place.h b/crawl-ref/source/mon-place.h index 49a8035b4d..a2c6f1b06a 100644 --- a/crawl-ref/source/mon-place.h +++ b/crawl-ref/source/mon-place.h @@ -1,8 +1,7 @@ -/* - * File: mon-place.h - * Summary: Functions used when placing monsters in the dungeon. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when placing monsters in the dungeon. +**/ #ifndef MONPLACE_H diff --git a/crawl-ref/source/mon-project.cc b/crawl-ref/source/mon-project.cc index 0ae9aff964..a0b7e5d66e 100644 --- a/crawl-ref/source/mon-project.cc +++ b/crawl-ref/source/mon-project.cc @@ -1,8 +1,7 @@ -/* - * File: mon-project.cc - * Summary: Slow projectiles, done as monsters. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Slow projectiles, done as monsters. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-project.h b/crawl-ref/source/mon-project.h index 28bb95a58c..1b3e22f046 100644 --- a/crawl-ref/source/mon-project.h +++ b/crawl-ref/source/mon-project.h @@ -1,8 +1,7 @@ -/* - * File: mon-project.cc - * Summary: Slow projectiles, done as monsters. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Slow projectiles, done as monsters. +**/ #ifndef MON_PROJECT_H #define MON_PROJECT_H diff --git a/crawl-ref/source/mon-speak.cc b/crawl-ref/source/mon-speak.cc index 101f0205c0..a1dd88cf60 100644 --- a/crawl-ref/source/mon-speak.cc +++ b/crawl-ref/source/mon-speak.cc @@ -1,7 +1,7 @@ -/* - * File: mon-speak.cc - * Summary: Functions to handle speaking monsters - */ +/** + * @file + * @brief Functions to handle speaking monsters +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-speak.h b/crawl-ref/source/mon-speak.h index 7c00326a22..8be5c34b78 100644 --- a/crawl-ref/source/mon-speak.h +++ b/crawl-ref/source/mon-speak.h @@ -1,7 +1,7 @@ -/* - * File: mon-speak.h - * Summary: Functions to handle speaking monsters - */ +/** + * @file + * @brief Functions to handle speaking monsters +**/ #ifndef MONSPEAK_H #define MONSPEAK_H diff --git a/crawl-ref/source/mon-stealth.cc b/crawl-ref/source/mon-stealth.cc index 23b4cbbc10..05cc640ac7 100644 --- a/crawl-ref/source/mon-stealth.cc +++ b/crawl-ref/source/mon-stealth.cc @@ -1,7 +1,7 @@ -/* - * File: mon-stealth.cc - * Summary: Monsters stealth methods. - */ +/** + * @file + * @brief Monsters stealth methods. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-stuff.cc b/crawl-ref/source/mon-stuff.cc index cd4ef827d1..6155e6f616 100644 --- a/crawl-ref/source/mon-stuff.cc +++ b/crawl-ref/source/mon-stuff.cc @@ -1,8 +1,7 @@ -/* - * File: mon-stuff.cc - * Summary: Misc monster related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc monster related functions. +**/ #include "AppHdr.h" #include "mon-stuff.h" diff --git a/crawl-ref/source/mon-stuff.h b/crawl-ref/source/mon-stuff.h index 1052ae411c..9d66c5e8cd 100644 --- a/crawl-ref/source/mon-stuff.h +++ b/crawl-ref/source/mon-stuff.h @@ -1,8 +1,7 @@ -/* - * File: mon-stuff.h - * Summary: Misc monster related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc monster related functions. +**/ #ifndef MONSTUFF_H diff --git a/crawl-ref/source/mon-transit.cc b/crawl-ref/source/mon-transit.cc index 06a0ff52ac..696cb69249 100644 --- a/crawl-ref/source/mon-transit.cc +++ b/crawl-ref/source/mon-transit.cc @@ -1,8 +1,7 @@ -/* - * File: mon-transit.cc - * Summary: Tracks monsters that are in suspended animation between levels. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Tracks monsters that are in suspended animation between levels. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mon-transit.h b/crawl-ref/source/mon-transit.h index 4ba9ec4572..04314d6a3f 100644 --- a/crawl-ref/source/mon-transit.h +++ b/crawl-ref/source/mon-transit.h @@ -1,8 +1,7 @@ -/* - * File: mon-transit.h - * Summary: Tracking monsters in transit between levels. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Tracking monsters in transit between levels. +**/ #ifndef MON_TRANSIT_H #define MON_TRANSIT_H diff --git a/crawl-ref/source/mon-util.cc b/crawl-ref/source/mon-util.cc index bf333f24ac..bf6949bd65 100644 --- a/crawl-ref/source/mon-util.cc +++ b/crawl-ref/source/mon-util.cc @@ -1,8 +1,7 @@ -/* - * File: mon-util.cc - * Summary: Misc monster related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc monster related functions. +**/ // $pellbinder: (c) D.G.S.E 1998 // some routines snatched from former monsstat.cc diff --git a/crawl-ref/source/mon-util.h b/crawl-ref/source/mon-util.h index a6002ec815..732b88f2bb 100644 --- a/crawl-ref/source/mon-util.h +++ b/crawl-ref/source/mon-util.h @@ -1,8 +1,7 @@ -/* - * File: mon-util.h - * Summary: Misc monster related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc monster related functions. +**/ #ifndef MONUTIL_H diff --git a/crawl-ref/source/monster.cc b/crawl-ref/source/monster.cc index 13ebd1bd9c..3116d04bc0 100644 --- a/crawl-ref/source/monster.cc +++ b/crawl-ref/source/monster.cc @@ -1,8 +1,7 @@ -/* - * File: monster.cc - * Summary: Monsters class methods - * Written by: Linley Henzell - */ +/** + * @file + * @brief Monsters class methods +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/mpr.h b/crawl-ref/source/mpr.h index a4557a9093..bf3eee9ca7 100644 --- a/crawl-ref/source/mpr.h +++ b/crawl-ref/source/mpr.h @@ -1,8 +1,7 @@ -/* - * File: mpr.h - * Summary: Functions used to print simple messages. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to print simple messages. +**/ #ifndef MPR_H #define MPR_H diff --git a/crawl-ref/source/msvc.h b/crawl-ref/source/msvc.h index fb64c50ec9..0ea3a4dc82 100644 --- a/crawl-ref/source/msvc.h +++ b/crawl-ref/source/msvc.h @@ -1,8 +1,7 @@ -/* - * File: msvc.h - * Summary: Header file for MSVC compiles - * Written by: Paul Du Bois - */ +/** + * @file + * @brief Header file for MSVC compiles +**/ #ifndef __msvc_h #define __msvc_h diff --git a/crawl-ref/source/mutation.cc b/crawl-ref/source/mutation.cc index 0b77ffec6b..1b636b4d99 100644 --- a/crawl-ref/source/mutation.cc +++ b/crawl-ref/source/mutation.cc @@ -1,8 +1,7 @@ -/* - * File: mutation.cc - * Summary: Functions for handling player mutations. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for handling player mutations. +**/ #include "AppHdr.h" #include "mutation.h" diff --git a/crawl-ref/source/mutation.h b/crawl-ref/source/mutation.h index 553298e0c1..740aaec15b 100644 --- a/crawl-ref/source/mutation.h +++ b/crawl-ref/source/mutation.h @@ -1,8 +1,7 @@ -/* - * File: mutation.cc - * Summary: Functions for handling player mutations. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions for handling player mutations. +**/ #ifndef MUTATION_H diff --git a/crawl-ref/source/newgame.cc b/crawl-ref/source/newgame.cc index 038178a449..fe4a226d90 100644 --- a/crawl-ref/source/newgame.cc +++ b/crawl-ref/source/newgame.cc @@ -1,8 +1,7 @@ -/* - * File: newgame.cc - * Summary: Functions used when starting a new game. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when starting a new game. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/newgame.h b/crawl-ref/source/newgame.h index c4e4a301ee..a2f9749c99 100644 --- a/crawl-ref/source/newgame.h +++ b/crawl-ref/source/newgame.h @@ -1,8 +1,7 @@ -/* - * File: newgame.h - * Summary: Functions used when starting a new game. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when starting a new game. +**/ #ifndef NEWGAME_H diff --git a/crawl-ref/source/ng-init.cc b/crawl-ref/source/ng-init.cc index e36c3ef981..afcb4f2c24 100644 --- a/crawl-ref/source/ng-init.cc +++ b/crawl-ref/source/ng-init.cc @@ -1,8 +1,8 @@ -/* - * File: ng-init.cc - * Summary: Initializing non-player-related parts of a new game. - * - * TODO: 'you' shouldn't occur here. +/** + * @file + * @brief Initializing non-player-related parts of a new game. +**/ +/* TODO: 'you' shouldn't occur here. * Some of these might fit better elsewhere. */ diff --git a/crawl-ref/source/ng-restr.cc b/crawl-ref/source/ng-restr.cc index 12b6de32c1..4074dc9335 100644 --- a/crawl-ref/source/ng-restr.cc +++ b/crawl-ref/source/ng-restr.cc @@ -1,10 +1,10 @@ -/* - * File: ng-restr.cc - * Summary: Character choice restrictions. +/** + * @file + * @brief Character choice restrictions. * * The functions in this file are "pure": They don't * access any global data. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/ng-setup.h b/crawl-ref/source/ng-setup.h index 942b640454..83ca732386 100644 --- a/crawl-ref/source/ng-setup.h +++ b/crawl-ref/source/ng-setup.h @@ -1,7 +1,7 @@ -/* - * File: ng-setup.h - * Summary: Setup "you" for a new game. - */ +/** + * @file + * @brief Setup "you" for a new game. +**/ #ifndef NG_SETUP_H #define NG_SETUP_H diff --git a/crawl-ref/source/notes.cc b/crawl-ref/source/notes.cc index d7ac7ecc36..ed05ef5b4a 100644 --- a/crawl-ref/source/notes.cc +++ b/crawl-ref/source/notes.cc @@ -1,8 +1,7 @@ -/* - * File: notes.cc - * Summary: Notetaking stuff - * Written by: Haran Pilpel - */ +/** + * @file + * @brief Notetaking stuff +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/notes.h b/crawl-ref/source/notes.h index 3cb8149cc0..603057fcf2 100644 --- a/crawl-ref/source/notes.h +++ b/crawl-ref/source/notes.h @@ -1,8 +1,7 @@ -/* - * File: notes.h - * Summary: Notetaking stuff - * Written by: Haran Pilpel - */ +/** + * @file + * @brief Notetaking stuff +**/ #ifndef NOTES_H #define NOTES_H diff --git a/crawl-ref/source/ouch.cc b/crawl-ref/source/ouch.cc index 6cfd079832..faaf97b522 100644 --- a/crawl-ref/source/ouch.cc +++ b/crawl-ref/source/ouch.cc @@ -1,8 +1,7 @@ -/* - * File: ouch.cc - * Summary: Functions used when Bad Things happen to the player. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when Bad Things happen to the player. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/ouch.h b/crawl-ref/source/ouch.h index 1dba26f5f1..594a05bb79 100644 --- a/crawl-ref/source/ouch.h +++ b/crawl-ref/source/ouch.h @@ -1,8 +1,7 @@ -/* - * File: ouch.h - * Summary: Functions used when Bad Things happen to the player. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used when Bad Things happen to the player. +**/ #ifndef OUCH_H diff --git a/crawl-ref/source/output.cc b/crawl-ref/source/output.cc index 4a2e9277ae..eb386a8581 100644 --- a/crawl-ref/source/output.cc +++ b/crawl-ref/source/output.cc @@ -1,8 +1,7 @@ -/* - * File: output.cc - * Summary: Functions used to print player related info. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to print player related info. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/output.h b/crawl-ref/source/output.h index 4b151038d1..4dc1ecbb0b 100644 --- a/crawl-ref/source/output.h +++ b/crawl-ref/source/output.h @@ -1,8 +1,7 @@ -/* - * File: output.h - * Summary: Functions used to print player related info. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Functions used to print player related info. +**/ #ifndef OUTPUT_H diff --git a/crawl-ref/source/package.cc b/crawl-ref/source/package.cc index 09f29b0914..7c3c50b608 100644 --- a/crawl-ref/source/package.cc +++ b/crawl-ref/source/package.cc @@ -1,8 +1,7 @@ -/* - * File: package.cc - * Summary: A container for chunks that make up the save file. - * Written by: Adam Borowski - */ +/** + * @file + * @brief A container for chunks that make up the save file. +**/ /* Guarantees: diff --git a/crawl-ref/source/place.cc b/crawl-ref/source/place.cc index 24ae3d6260..9ac775c5e6 100644 --- a/crawl-ref/source/place.cc +++ b/crawl-ref/source/place.cc @@ -1,8 +1,7 @@ -/* - * File: place.cc - * Summary: Place related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Place related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/place.h b/crawl-ref/source/place.h index 84bb8a5535..1fcf990fc1 100644 --- a/crawl-ref/source/place.h +++ b/crawl-ref/source/place.h @@ -1,8 +1,7 @@ -/* - * File: place.h - * Summary: Place related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Place related functions. +**/ #ifndef PLACE_H #define PLACE_H diff --git a/crawl-ref/source/player-act.cc b/crawl-ref/source/player-act.cc index d401b338eb..f3e286325b 100644 --- a/crawl-ref/source/player-act.cc +++ b/crawl-ref/source/player-act.cc @@ -1,7 +1,7 @@ -/* - * File: player-act.cc - * Summary: Implementing the actor interface for player. - */ +/** + * @file + * @brief Implementing the actor interface for player. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/player.cc b/crawl-ref/source/player.cc index c3fae90b96..40cdda5f63 100644 --- a/crawl-ref/source/player.cc +++ b/crawl-ref/source/player.cc @@ -1,8 +1,7 @@ -/* - * File: player.cc - * Summary: Player related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Player related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/player.h b/crawl-ref/source/player.h index 9098f3a35d..7c41d93f5a 100644 --- a/crawl-ref/source/player.h +++ b/crawl-ref/source/player.h @@ -1,8 +1,7 @@ -/* - * File: player.cc - * Summary: Player related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Player related functions. +**/ #ifndef PLAYER_H diff --git a/crawl-ref/source/potion.cc b/crawl-ref/source/potion.cc index 3e7923de76..c2307fb0f1 100644 --- a/crawl-ref/source/potion.cc +++ b/crawl-ref/source/potion.cc @@ -1,8 +1,7 @@ -/* - * File: potion.cc - * Summary: Potion and potion-like effects. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Potion and potion-like effects. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/potion.h b/crawl-ref/source/potion.h index 94ea798fa4..f3007565ff 100644 --- a/crawl-ref/source/potion.h +++ b/crawl-ref/source/potion.h @@ -1,8 +1,7 @@ -/* - * File: potion.h - * Summary: Potion and potion-like effects. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Potion and potion-like effects. +**/ #ifndef IT_USE2_H #define IT_USE2_H diff --git a/crawl-ref/source/quiver.cc b/crawl-ref/source/quiver.cc index 3999fee78e..dc690d05a6 100644 --- a/crawl-ref/source/quiver.cc +++ b/crawl-ref/source/quiver.cc @@ -1,11 +1,11 @@ -/* - * File: quiver.cc - * Summary: Player quiver functionality +/** + * @file + * @brief Player quiver functionality * - * - Only change last_used when actually using - * - Not changing Qv; nobody knows about internals - * - Track last_used of each type so each weapon can do the right thing - */ + * - Only change last_used when actually using + * - Not changing Qv; nobody knows about internals + * - Track last_used of each type so each weapon can do the right thing +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/quiver.h b/crawl-ref/source/quiver.h index 13143dae37..e6da9155fc 100644 --- a/crawl-ref/source/quiver.h +++ b/crawl-ref/source/quiver.h @@ -1,7 +1,7 @@ -/* - * File: quiver.h - * Summary: Player quiver functionality - */ +/** + * @file + * @brief Player quiver functionality +**/ #ifndef QUIVER_H #define QUIVER_H diff --git a/crawl-ref/source/ray.cc b/crawl-ref/source/ray.cc index 346fde788d..9344a66bf3 100644 --- a/crawl-ref/source/ray.cc +++ b/crawl-ref/source/ray.cc @@ -1,6 +1,6 @@ -/* - * File: ray.cc - * Summary: Diamond grid wrapper around geom::ray. +/** + * @file + * @brief Diamond grid wrapper around geom::ray. * * The geom::grid diamonds is a checkerboard grid rotated * by 45 degrees such that the black cells ("diamonds") lie just @@ -9,7 +9,7 @@ * ray_def provides for advancing and reflecting rays in * map coordinates, where a ray touches a given cell if it * meets the diamond. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/ray.h b/crawl-ref/source/ray.h index 242c8f76f2..f9bc4f003f 100644 --- a/crawl-ref/source/ray.h +++ b/crawl-ref/source/ray.h @@ -1,7 +1,7 @@ -/* - * File: ray.h - * Summary: Ray definition - */ +/** + * @file + * @brief Ray definition +**/ #ifndef RAY_H #define RAY_H diff --git a/crawl-ref/source/religion.cc b/crawl-ref/source/religion.cc index 8fc1f9905a..5880881e1b 100644 --- a/crawl-ref/source/religion.cc +++ b/crawl-ref/source/religion.cc @@ -1,8 +1,7 @@ -/* - * File: religion.cc - * Summary: Misc religion related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc religion related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/religion.h b/crawl-ref/source/religion.h index 23aead7c7a..a00ab1bb64 100644 --- a/crawl-ref/source/religion.h +++ b/crawl-ref/source/religion.h @@ -1,8 +1,7 @@ -/* - * File: religion.h - * Summary: Misc religion related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc religion related functions. +**/ #ifndef RELIGION_H diff --git a/crawl-ref/source/rng.cc b/crawl-ref/source/rng.cc index 6584dd87b9..bbab2d61ff 100644 --- a/crawl-ref/source/rng.cc +++ b/crawl-ref/source/rng.cc @@ -1,7 +1,7 @@ -/* - * File: rng.cc - * Summary: Random number generator wrapping. - */ +/** + * @file + * @brief Random number generator wrapping. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/shopping.cc b/crawl-ref/source/shopping.cc index f4b194fa16..da149c6690 100644 --- a/crawl-ref/source/shopping.cc +++ b/crawl-ref/source/shopping.cc @@ -1,8 +1,7 @@ -/* - * File: shopping.cc - * Summary: Shop keeper functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Shop keeper functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/shopping.h b/crawl-ref/source/shopping.h index 209232d854..463e1cf5f4 100644 --- a/crawl-ref/source/shopping.h +++ b/crawl-ref/source/shopping.h @@ -1,8 +1,7 @@ -/* - * File: shopping.h - * Summary: Shop keeper functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Shop keeper functions. +**/ #ifndef SHOPPING_H diff --git a/crawl-ref/source/shout.cc b/crawl-ref/source/shout.cc index df03fdf934..c1a45eabbd 100644 --- a/crawl-ref/source/shout.cc +++ b/crawl-ref/source/shout.cc @@ -1,7 +1,7 @@ -/* - * File: shout.cc - * Summary: Stealth, noise, shouting. - */ +/** + * @file + * @brief Stealth, noise, shouting. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/showsymb.cc b/crawl-ref/source/showsymb.cc index 575644634d..1fa878f1b1 100644 --- a/crawl-ref/source/showsymb.cc +++ b/crawl-ref/source/showsymb.cc @@ -1,9 +1,9 @@ -/* - * File: showsymb.cc - * Summary: Rendering of map_cell to glyph and colour. +/** + * @file + * @brief Rendering of map_cell to glyph and colour. * * This only needs the information within one object of type map_cell. - */ +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/skills.cc b/crawl-ref/source/skills.cc index 069cd6b671..18f436fe9a 100644 --- a/crawl-ref/source/skills.cc +++ b/crawl-ref/source/skills.cc @@ -1,8 +1,7 @@ -/* - * File: skills.cc - * Summary: Skill exercising functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Skill exercising functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/skills.h b/crawl-ref/source/skills.h index c5bcc7e20a..f2b8ea81ed 100644 --- a/crawl-ref/source/skills.h +++ b/crawl-ref/source/skills.h @@ -1,8 +1,7 @@ -/* - * File: skills.h - * Summary: Skill exercising functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Skill exercising functions. +**/ #ifndef SKILLS_H diff --git a/crawl-ref/source/skills2.cc b/crawl-ref/source/skills2.cc index b46adc69fd..e98ba77b1c 100644 --- a/crawl-ref/source/skills2.cc +++ b/crawl-ref/source/skills2.cc @@ -1,8 +1,7 @@ -/* - * File: skills2.cc - * Summary: More skill related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief More skill related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/skills2.h b/crawl-ref/source/skills2.h index 8061ace9d1..979e833a3c 100644 --- a/crawl-ref/source/skills2.h +++ b/crawl-ref/source/skills2.h @@ -1,8 +1,7 @@ -/* - * File: skills2.h - * Summary: More skill related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief More skill related functions. +**/ #ifndef SKILLS2_H diff --git a/crawl-ref/source/spl-book.cc b/crawl-ref/source/spl-book.cc index c098226e82..f2a9afb794 100644 --- a/crawl-ref/source/spl-book.cc +++ b/crawl-ref/source/spl-book.cc @@ -1,8 +1,7 @@ -/* - * File: spl-book.cc - * Summary: Spellbook/Staff contents array and management functions - * Written by: Josh Fishman - */ +/** + * @file + * @brief Spellbook/Staff contents array and management functions +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-book.h b/crawl-ref/source/spl-book.h index e801c4ee0d..7f9264ad0a 100644 --- a/crawl-ref/source/spl-book.h +++ b/crawl-ref/source/spl-book.h @@ -1,8 +1,7 @@ -/* - * File: spl-book.h - * Summary: Some spellbook related functions. - * Written by: Josh Fishman - */ +/** + * @file + * @brief Some spellbook related functions. +**/ #ifndef SPL_BOOK_H diff --git a/crawl-ref/source/spl-cast.cc b/crawl-ref/source/spl-cast.cc index 43727c719b..aac69bfcd5 100644 --- a/crawl-ref/source/spl-cast.cc +++ b/crawl-ref/source/spl-cast.cc @@ -1,8 +1,7 @@ -/* - * File: spl-cast.cc - * Summary: Spell casting and miscast functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Spell casting and miscast functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-cast.h b/crawl-ref/source/spl-cast.h index 4a84c8b52a..456b17165f 100644 --- a/crawl-ref/source/spl-cast.h +++ b/crawl-ref/source/spl-cast.h @@ -1,8 +1,7 @@ -/* - * File: spl-cast.h - * Summary: Spell casting functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Spell casting functions. +**/ #ifndef SPL_CAST_H diff --git a/crawl-ref/source/spl-clouds.cc b/crawl-ref/source/spl-clouds.cc index 331669deec..d45bcf878e 100644 --- a/crawl-ref/source/spl-clouds.cc +++ b/crawl-ref/source/spl-clouds.cc @@ -1,7 +1,7 @@ -/* - * File: spl-clouds.cc - * Summary: Cloud creating spells. - */ +/** + * @file + * @brief Cloud creating spells. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-damage.cc b/crawl-ref/source/spl-damage.cc index ae24419a2a..da8729c927 100644 --- a/crawl-ref/source/spl-damage.cc +++ b/crawl-ref/source/spl-damage.cc @@ -1,8 +1,8 @@ -/* - * File: spl-damage.cc - * Summary: Damage-dealing spells not already handled elsewhere. - * Other targeted spells are covered in spl-zap.cc. - */ +/** + * @file + * @brief Damage-dealing spells not already handled elsewhere. + * Other targeted spells are covered in spl-zap.cc. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-data.h b/crawl-ref/source/spl-data.h index 71e286fe72..a43668fa49 100644 --- a/crawl-ref/source/spl-data.h +++ b/crawl-ref/source/spl-data.h @@ -1,9 +1,8 @@ -/* - * File: spl-data.h - * Summary: Spell definitions and descriptions. See spell_desc struct in - * spl-util.cc. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Spell definitions and descriptions. See spell_desc struct in + * spl-util.cc. +**/ #ifndef SPLDATA_H #define SPLDATA_H diff --git a/crawl-ref/source/spl-goditem.cc b/crawl-ref/source/spl-goditem.cc index cd31a98f5e..b62a0bc003 100644 --- a/crawl-ref/source/spl-goditem.cc +++ b/crawl-ref/source/spl-goditem.cc @@ -1,7 +1,7 @@ -/* - * File: spl-goditem.cc - * Summary: Pseudo spells triggered by gods and various items. - */ +/** + * @file + * @brief Pseudo spells triggered by gods and various items. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-miscast.cc b/crawl-ref/source/spl-miscast.cc index 23e78b963e..f4b5b97f50 100644 --- a/crawl-ref/source/spl-miscast.cc +++ b/crawl-ref/source/spl-miscast.cc @@ -1,8 +1,7 @@ -/* - * File: spl-miscast.cc - * Summary: Spell miscast class. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Spell miscast class. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-miscast.h b/crawl-ref/source/spl-miscast.h index 66acc49567..347e578ca4 100644 --- a/crawl-ref/source/spl-miscast.h +++ b/crawl-ref/source/spl-miscast.h @@ -1,8 +1,7 @@ -/* - * File: spl-miscast.h - * Summary: Spell miscast class. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Spell miscast class. +**/ #ifndef SPL_MISCAST_H #define SPL_MISCAST_H diff --git a/crawl-ref/source/spl-monench.cc b/crawl-ref/source/spl-monench.cc index 5593a4d4cb..ac8d78dd29 100644 --- a/crawl-ref/source/spl-monench.cc +++ b/crawl-ref/source/spl-monench.cc @@ -1,8 +1,8 @@ -/* - * File: spl-monench.cc - * Summary: Monster-affecting enchantment spells. - * Other targeted enchantments are handled in spl-zap.cc. - */ +/** + * @file + * @brief Monster-affecting enchantment spells. + * Other targeted enchantments are handled in spl-zap.cc. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-other.cc b/crawl-ref/source/spl-other.cc index 68ba52bb58..eb0ac0f270 100644 --- a/crawl-ref/source/spl-other.cc +++ b/crawl-ref/source/spl-other.cc @@ -1,8 +1,8 @@ -/* - * File: spl-other.cc - * Summary: Non-enchantment spells that didn't fit anywhere else. - * Mostly Transmutations. - */ +/** + * @file + * @brief Non-enchantment spells that didn't fit anywhere else. + * Mostly Transmutations. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-selfench.cc b/crawl-ref/source/spl-selfench.cc index a40bdc8371..861ade30f4 100644 --- a/crawl-ref/source/spl-selfench.cc +++ b/crawl-ref/source/spl-selfench.cc @@ -1,7 +1,7 @@ -/* - * File: spl-selfench.cc - * Summary: Self-enchantment spells. - */ +/** + * @file + * @brief Self-enchantment spells. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-summoning.cc b/crawl-ref/source/spl-summoning.cc index fe64453e07..94dc5ee911 100644 --- a/crawl-ref/source/spl-summoning.cc +++ b/crawl-ref/source/spl-summoning.cc @@ -1,7 +1,7 @@ -/* - * File: spl-summoning.cc - * Summary: Summoning spells and other effects creating monsters. - */ +/** + * @file + * @brief Summoning spells and other effects creating monsters. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-transloc.cc b/crawl-ref/source/spl-transloc.cc index c0a16dd337..ebef04ff49 100644 --- a/crawl-ref/source/spl-transloc.cc +++ b/crawl-ref/source/spl-transloc.cc @@ -1,7 +1,7 @@ -/* - * File: spl-transloc.cc - * Summary: Translocation spells. - */ +/** + * @file + * @brief Translocation spells. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-util.cc b/crawl-ref/source/spl-util.cc index 6d06da172d..115b431e05 100644 --- a/crawl-ref/source/spl-util.cc +++ b/crawl-ref/source/spl-util.cc @@ -1,8 +1,7 @@ -/* - * File: spl-util.cc * - * Summary: data handlers for player-available spell list * - * Written by: don brodale <dbrodale@bigfootinteractive.com> * - */ +/** + * @file + * @brief data handlers for player-available spell list +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/spl-util.h b/crawl-ref/source/spl-util.h index 29753d41c5..b8f4fc208e 100644 --- a/crawl-ref/source/spl-util.h +++ b/crawl-ref/source/spl-util.h @@ -1,8 +1,7 @@ -/* - * File: spl-util.h - * Summary: data handlers for player spell list - * Written by: don brodale <dbrodale@bigfootinteractive.com> - */ +/** + * @file + * @brief data handlers for player spell list +**/ #ifndef SPL_UTIL_H diff --git a/crawl-ref/source/spl-wpnench.cc b/crawl-ref/source/spl-wpnench.cc index e06231310c..12106616af 100644 --- a/crawl-ref/source/spl-wpnench.cc +++ b/crawl-ref/source/spl-wpnench.cc @@ -1,7 +1,7 @@ -/* - * File: spl-wpnench.cc - * Summary: Weapon enchantment spells. - */ +/** + * @file + * @brief Weapon enchantment spells. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/sqldbm.cc b/crawl-ref/source/sqldbm.cc index aff6ed8411..fbde80cbe6 100644 --- a/crawl-ref/source/sqldbm.cc +++ b/crawl-ref/source/sqldbm.cc @@ -1,8 +1,7 @@ -/* - * File: sqldbm.cc - * Summary: dbm wrapper for SQLite - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief dbm wrapper for SQLite +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/sqldbm.h b/crawl-ref/source/sqldbm.h index 35cff068d0..965ea3fc3e 100644 --- a/crawl-ref/source/sqldbm.h +++ b/crawl-ref/source/sqldbm.h @@ -1,8 +1,7 @@ -/* - * File: sqldbm.cc - * Summary: dbm wrapper for SQLite - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief dbm wrapper for SQLite +**/ #ifndef SQLDBM_H #define SQLDBM_H diff --git a/crawl-ref/source/stairs.h b/crawl-ref/source/stairs.h index ea79d84651..286ffaefb0 100644 --- a/crawl-ref/source/stairs.h +++ b/crawl-ref/source/stairs.h @@ -1,7 +1,7 @@ -/* - * File: stairs.h - * Summary: Moving between levels. - */ +/** + * @file + * @brief Moving between levels. +**/ #ifndef STAIRS_H #define STAIRS_H diff --git a/crawl-ref/source/startup.cc b/crawl-ref/source/startup.cc index 20df291df9..70d8128d32 100644 --- a/crawl-ref/source/startup.cc +++ b/crawl-ref/source/startup.cc @@ -1,8 +1,7 @@ -/* - * File: startup.cc - * Summary: Collection of startup related functions and objects - * Written by: - */ +/** + * @file + * @brief Collection of startup related functions and objects +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/startup.h b/crawl-ref/source/startup.h index 882d5b75cf..ab025a4096 100644 --- a/crawl-ref/source/startup.h +++ b/crawl-ref/source/startup.h @@ -1,8 +1,7 @@ -/* - * File: startup.h - * Summary: Collection of startup related functions and objects - * Written by: - */ +/** + * @file + * @brief Collection of startup related functions and objects +**/ #ifndef STARTUP_H #define STARTUP_H diff --git a/crawl-ref/source/stash.cc b/crawl-ref/source/stash.cc index 8607e7d887..3fb840281f 100644 --- a/crawl-ref/source/stash.cc +++ b/crawl-ref/source/stash.cc @@ -1,8 +1,7 @@ -/* - * File: stash.cc - * Summary: Classes tracking player stashes - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Classes tracking player stashes +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/stash.h b/crawl-ref/source/stash.h index cca68c037b..8ad6a2faaa 100644 --- a/crawl-ref/source/stash.h +++ b/crawl-ref/source/stash.h @@ -1,8 +1,7 @@ -/* - * File: stash.h - * Summary: Classes tracking player stashes - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Classes tracking player stashes +**/ #ifndef STASH_H #define STASH_H diff --git a/crawl-ref/source/state.cc b/crawl-ref/source/state.cc index 51c896b836..4e6089e222 100644 --- a/crawl-ref/source/state.cc +++ b/crawl-ref/source/state.cc @@ -1,8 +1,7 @@ -/* - * File: state.cc - * Summary: Game state functions. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Game state functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/state.h b/crawl-ref/source/state.h index 7977e5e180..6e2578eeb0 100644 --- a/crawl-ref/source/state.h +++ b/crawl-ref/source/state.h @@ -1,8 +1,7 @@ -/* - * File: state.h - * Summary: Game state. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Game state. +**/ #ifndef STATE_H #define STATE_H diff --git a/crawl-ref/source/status.h b/crawl-ref/source/status.h index 74e65495ca..dcc1337482 100644 --- a/crawl-ref/source/status.h +++ b/crawl-ref/source/status.h @@ -1,7 +1,7 @@ -/* - * File: status.h - * Summary: Collects information for output of status effects. - */ +/** + * @file + * @brief Collects information for output of status effects. +**/ #ifndef STATUS_H #define STATUS_H diff --git a/crawl-ref/source/store.cc b/crawl-ref/source/store.cc index 1dbaf8cb4e..0dd72725bd 100644 --- a/crawl-ref/source/store.cc +++ b/crawl-ref/source/store.cc @@ -1,9 +1,8 @@ -/* - * File: store.cc - * Summary: Saveable hash-table and vector capable of storing - * multiple types of data. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Saveable hash-table and vector capable of storing + * multiple types of data. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/store.h b/crawl-ref/source/store.h index 9f4ba3c623..a7befbe63b 100644 --- a/crawl-ref/source/store.h +++ b/crawl-ref/source/store.h @@ -1,9 +1,8 @@ -/* - * File: store.h - * Summary: Saveable hash-table and vector capable of storing - * multiple types of data. - * Written by: Matthew Cline - */ +/** + * @file + * @brief Saveable hash-table and vector capable of storing + * multiple types of data. +**/ #ifndef STORE_H #define STORE_H diff --git a/crawl-ref/source/stuff.cc b/crawl-ref/source/stuff.cc index 1a3bf42eb5..cd5ea2bfb4 100644 --- a/crawl-ref/source/stuff.cc +++ b/crawl-ref/source/stuff.cc @@ -1,8 +1,7 @@ -/* - * File: stuff.cc - * Summary: Misc stuff. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc stuff. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/stuff.h b/crawl-ref/source/stuff.h index de7a516222..64755c7e8e 100644 --- a/crawl-ref/source/stuff.h +++ b/crawl-ref/source/stuff.h @@ -1,8 +1,7 @@ -/* - * File: stuff.h - * Summary: Misc stuff. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc stuff. +**/ #ifndef STUFF_H diff --git a/crawl-ref/source/syscalls.cc b/crawl-ref/source/syscalls.cc index f80dedb076..894c8f7545 100644 --- a/crawl-ref/source/syscalls.cc +++ b/crawl-ref/source/syscalls.cc @@ -1,8 +1,7 @@ -/* - * File: syscalls.cc - * Summary: Wrappers for sys/libc calls, mostly for charset purposes. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Wrappers for sys/libc calls, mostly for charset purposes. +**/ #include "AppHdr.h" #include "syscalls.h" diff --git a/crawl-ref/source/syscalls.h b/crawl-ref/source/syscalls.h index 41dde1e424..5870111ad2 100644 --- a/crawl-ref/source/syscalls.h +++ b/crawl-ref/source/syscalls.h @@ -1,8 +1,7 @@ -/* - * File: syscalls.h - * Summary: Wrappers for sys/libc calls, mostly for charset purposes. - * Written by: Adam Borowski - */ +/** + * @file + * @brief Wrappers for sys/libc calls, mostly for charset purposes. +**/ #ifndef SYSCALLS_H #define SYSCALLS_H diff --git a/crawl-ref/source/tags.cc b/crawl-ref/source/tags.cc index 6cdb732232..6ce7b304c3 100644 --- a/crawl-ref/source/tags.cc +++ b/crawl-ref/source/tags.cc @@ -1,8 +1,7 @@ -/* - * File: tags.cc - * Summary: Auxilary functions to make savefile versioning simpler. - * Written by: Gordon Lipford - */ +/** + * @file + * @brief Auxilary functions to make savefile versioning simpler. +**/ /* The marshalling and unmarshalling of data is done in big endian and diff --git a/crawl-ref/source/tags.h b/crawl-ref/source/tags.h index 26a0f69227..bdd3622aba 100644 --- a/crawl-ref/source/tags.h +++ b/crawl-ref/source/tags.h @@ -1,8 +1,7 @@ -/* - * File: tags.h - * Summary: Auxilary functions to make savefile versioning simpler. - * Written by: Gordon Lipford - */ +/** + * @file + * @brief Auxilary functions to make savefile versioning simpler. +**/ #ifndef TAGS_H #define TAGS_H diff --git a/crawl-ref/source/tagstring.h b/crawl-ref/source/tagstring.h index 351fbcc0a3..5f62ff47de 100644 --- a/crawl-ref/source/tagstring.h +++ b/crawl-ref/source/tagstring.h @@ -1,7 +1,7 @@ -/* - * File: tagstring.h - * Summary: Code related to tagged strings. - */ +/** + * @file + * @brief Code related to tagged strings. +**/ #ifndef TAGSTRING_H #define TAGSTRING_H diff --git a/crawl-ref/source/teleport.cc b/crawl-ref/source/teleport.cc index 13f4cc490e..6470dfc6bb 100644 --- a/crawl-ref/source/teleport.cc +++ b/crawl-ref/source/teleport.cc @@ -1,7 +1,7 @@ -/* - * File: teleport.cc - * Summary: Functions related to teleportation and blinking. - */ +/** + * @file + * @brief Functions related to teleportation and blinking. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/terrain.cc b/crawl-ref/source/terrain.cc index 1a32d098eb..1970e32122 100644 --- a/crawl-ref/source/terrain.cc +++ b/crawl-ref/source/terrain.cc @@ -1,8 +1,7 @@ -/* - * File: terrain.cc - * Summary: Terrain related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Terrain related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/terrain.h b/crawl-ref/source/terrain.h index 41b7142988..779a348455 100644 --- a/crawl-ref/source/terrain.h +++ b/crawl-ref/source/terrain.h @@ -1,8 +1,7 @@ -/* - * File: terrain.h - * Summary: Terrain related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Terrain related functions. +**/ #ifndef TERRAIN_H #define TERRAIN_H diff --git a/crawl-ref/source/tilebuf.cc b/crawl-ref/source/tilebuf.cc index a96ccc480d..6588b21a05 100644 --- a/crawl-ref/source/tilebuf.cc +++ b/crawl-ref/source/tilebuf.cc @@ -1,9 +1,7 @@ -/* - * File: tilebuf.cc - * Summary: Vertex buffer implementaions - * - * Created by: ennewalker on Sat Jan 5 01:33:53 2008 UTC - */ +/** + * @file + * @brief Vertex buffer implementaions +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/tiledoll.cc b/crawl-ref/source/tiledoll.cc index 41674551d5..0a4d91064e 100644 --- a/crawl-ref/source/tiledoll.cc +++ b/crawl-ref/source/tiledoll.cc @@ -1,9 +1,7 @@ -/* - * File: tiledoll.cc - * Summary: Region system implementations - * - * Created by: ennewalker on Sat Jan 5 01:33:53 2008 UTC - */ +/** + * @file + * @brief Region system implementations +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/tilemcache.h b/crawl-ref/source/tilemcache.h index 4876a0e3c8..c2ca882fe5 100644 --- a/crawl-ref/source/tilemcache.h +++ b/crawl-ref/source/tilemcache.h @@ -1,8 +1,7 @@ -/* - * File: tilemcache.h - * Summary: Monster cache support - * Written by: Enne Walker - */ +/** + * @file + * @brief Monster cache support +**/ #ifdef USE_TILE #ifndef TILEMCACHE_H diff --git a/crawl-ref/source/tilepick-p.h b/crawl-ref/source/tilepick-p.h index cd5afccab1..5cc75c7db5 100644 --- a/crawl-ref/source/tilepick-p.h +++ b/crawl-ref/source/tilepick-p.h @@ -1,7 +1,7 @@ -/* - * File: tilepick-p.h - * Summary: Look-up functions for player tiles. - */ +/** + * @file + * @brief Look-up functions for player tiles. +**/ #ifndef TILEPICK_P_H #define TILEPICK_P_H diff --git a/crawl-ref/source/tilepick.h b/crawl-ref/source/tilepick.h index dbffaf66fd..e8ea93cd7e 100644 --- a/crawl-ref/source/tilepick.h +++ b/crawl-ref/source/tilepick.h @@ -1,7 +1,7 @@ -/* - * File: tilepick.h - * Summary: Look-up functions for dungeon and item tiles. - */ +/** + * @file + * @brief Look-up functions for dungeon and item tiles. +**/ #ifndef TILEPICK_H #define TILEPICK_H diff --git a/crawl-ref/source/tilereg.cc b/crawl-ref/source/tilereg.cc index a983f041de..c91ee6bb95 100644 --- a/crawl-ref/source/tilereg.cc +++ b/crawl-ref/source/tilereg.cc @@ -1,9 +1,7 @@ -/* - * File: tilereg.cc - * Summary: Region system implementations - * - * Created by: ennewalker on Sat Jan 5 01:33:53 2008 UTC - */ +/** + * @file + * @brief Region system implementations +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/tilesdl.h b/crawl-ref/source/tilesdl.h index fdaf9e2a8a..20ad74b37a 100644 --- a/crawl-ref/source/tilesdl.h +++ b/crawl-ref/source/tilesdl.h @@ -1,8 +1,7 @@ -/* - * File: tilesdl.h - * Summary: SDL-related functionality for the tiles port - * Written by: Enne Walker - */ +/** + * @file + * @brief SDL-related functionality for the tiles port +**/ #ifdef USE_TILE #ifndef TILESDL_H diff --git a/crawl-ref/source/tiletex.h b/crawl-ref/source/tiletex.h index e22c93a34a..5488fd8764 100644 --- a/crawl-ref/source/tiletex.h +++ b/crawl-ref/source/tiletex.h @@ -1,8 +1,7 @@ -/* - * File: tiletex.h - * Summary: PNG and texture loading functionality - * Written by: Enne Walker - */ +/** + * @file + * @brief PNG and texture loading functionality +**/ #ifndef TILETEX_H #define TILETEX_H diff --git a/crawl-ref/source/transform.cc b/crawl-ref/source/transform.cc index fe6dad5d52..be44c35804 100644 --- a/crawl-ref/source/transform.cc +++ b/crawl-ref/source/transform.cc @@ -1,8 +1,7 @@ -/* - * File: transform.cc - * Summary: Misc function related to player transformations. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc function related to player transformations. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/transform.h b/crawl-ref/source/transform.h index 35b8775c5e..5d738610cc 100644 --- a/crawl-ref/source/transform.h +++ b/crawl-ref/source/transform.h @@ -1,8 +1,7 @@ -/* - * File: transform.h - * Summary: Misc function related to player transformations. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc function related to player transformations. +**/ #ifndef TRANSFOR_H diff --git a/crawl-ref/source/traps.cc b/crawl-ref/source/traps.cc index 7396f2c695..c657c9be4c 100644 --- a/crawl-ref/source/traps.cc +++ b/crawl-ref/source/traps.cc @@ -1,8 +1,7 @@ -/* - * File: traps.cc - * Summary: Traps related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Traps related functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/traps.h b/crawl-ref/source/traps.h index 6b615f0dce..0a70ff4227 100644 --- a/crawl-ref/source/traps.h +++ b/crawl-ref/source/traps.h @@ -1,8 +1,7 @@ -/* - * File: traps.h - * Summary: Traps related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Traps related functions. +**/ #ifndef TRAPS_H #define TRAPS_H diff --git a/crawl-ref/source/travel.cc b/crawl-ref/source/travel.cc index e2d0eadb56..6d947928a2 100644 --- a/crawl-ref/source/travel.cc +++ b/crawl-ref/source/travel.cc @@ -1,9 +1,8 @@ -/* - * File: travel.cc - * Summary: Travel stuff - * Written by: Darshan Shaligram - * - * Known issues: +/** + * @file + * @brief Travel stuff +**/ +/* Known issues: * Hardcoded dungeon features all over the place - this thing is a devil to * refactor. */ diff --git a/crawl-ref/source/travel.h b/crawl-ref/source/travel.h index ab12eaf679..5a21c8ec86 100644 --- a/crawl-ref/source/travel.h +++ b/crawl-ref/source/travel.h @@ -1,8 +1,7 @@ -/* - * File: travel.h - * Summary: Travel stuff - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Travel stuff +**/ #ifndef TRAVEL_H #define TRAVEL_H diff --git a/crawl-ref/source/travel_defs.h b/crawl-ref/source/travel_defs.h index 9d95a589e2..56f0a9f13b 100644 --- a/crawl-ref/source/travel_defs.h +++ b/crawl-ref/source/travel_defs.h @@ -1,8 +1,7 @@ -/* - * File: travel_defs.h - * Summary: Just because typedefs can't be forward declared. Argh. - * Written by: Darshan Shaligram - */ +/** + * @file + * @brief Just because typedefs can't be forward declared. Argh. +**/ #ifndef TRAVEL_DEFS_H #define TRAVEL_DEFS_H diff --git a/crawl-ref/source/tutorial.cc b/crawl-ref/source/tutorial.cc index a8972d0dac..fcefdd00b2 100644 --- a/crawl-ref/source/tutorial.cc +++ b/crawl-ref/source/tutorial.cc @@ -1,7 +1,7 @@ -/* - * File: tutorial.cc - * Summary: Collection of tutorial related functions. - */ +/** + * @file + * @brief Collection of tutorial related functions. +**/ #include "AppHdr.h" #include "tutorial.h" diff --git a/crawl-ref/source/tutorial.h b/crawl-ref/source/tutorial.h index 2ae26c6a9a..43fcc88fe5 100644 --- a/crawl-ref/source/tutorial.h +++ b/crawl-ref/source/tutorial.h @@ -1,7 +1,7 @@ -/* - * File: tutorial.h - * Summary: Collection of tutorial related functions. - */ +/** + * @file + * @brief Collection of tutorial related functions. +**/ #ifndef TUTORIAL_H #define TUTORIAL_H diff --git a/crawl-ref/source/util/art-data.pl b/crawl-ref/source/util/art-data.pl index 75603df5a4..8cbc7bd5b4 100755 --- a/crawl-ref/source/util/art-data.pl +++ b/crawl-ref/source/util/art-data.pl @@ -569,10 +569,7 @@ sub write_data (my $guard = $ART_DATA) =~ tr/a-zA-Z/_/c; print HEADER <<"ENDofTEXT"; -/* - * File: $ART_DATA - * Summary: Definitions for unrandom artefacts. - */ +/* Definitions for unrandom artefacts. */ /********************************************************************** * WARNING! diff --git a/crawl-ref/source/version.cc b/crawl-ref/source/version.cc index c70fe42a93..f2809c015a 100644 --- a/crawl-ref/source/version.cc +++ b/crawl-ref/source/version.cc @@ -1,8 +1,7 @@ -/* - * File: version.cc - * Summary: Version (and revision) functionality. - * Written by: Steven Noonan - */ +/** + * @file + * @brief Version (and revision) functionality. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/version.h b/crawl-ref/source/version.h index 52c8d0e470..b8685e454c 100644 --- a/crawl-ref/source/version.h +++ b/crawl-ref/source/version.h @@ -1,7 +1,7 @@ -/* - * File: version.h - * Summary: Contains version information - */ +/** + * @file + * @brief Contains version information +**/ #ifndef VERSION_H #define VERSION_H diff --git a/crawl-ref/source/view.cc b/crawl-ref/source/view.cc index 8db230f3a4..c3cff08050 100644 --- a/crawl-ref/source/view.cc +++ b/crawl-ref/source/view.cc @@ -1,8 +1,7 @@ -/* - * File: view.cc - * Summary: Misc function used to render the dungeon. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc function used to render the dungeon. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/view.h b/crawl-ref/source/view.h index 724b7229e6..67927b4642 100644 --- a/crawl-ref/source/view.h +++ b/crawl-ref/source/view.h @@ -1,8 +1,7 @@ -/* - * File: view.h - * Summary: Misc function used to render the dungeon. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc function used to render the dungeon. +**/ #ifndef VIEW_H diff --git a/crawl-ref/source/viewmap.cc b/crawl-ref/source/viewmap.cc index 3641acfed3..d2b4aaa6f4 100644 --- a/crawl-ref/source/viewmap.cc +++ b/crawl-ref/source/viewmap.cc @@ -1,7 +1,7 @@ -/* - * File: viewmap.cc - * Summary: Showing the level map (X and background). - */ +/** + * @file + * @brief Showing the level map (X and background). +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-dgn.cc b/crawl-ref/source/wiz-dgn.cc index ed6d998539..c940368883 100644 --- a/crawl-ref/source/wiz-dgn.cc +++ b/crawl-ref/source/wiz-dgn.cc @@ -1,8 +1,7 @@ -/* - * File: wiz-dgn.h - * Summary: Dungeon related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Dungeon related wizard functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-dgn.h b/crawl-ref/source/wiz-dgn.h index d0e9fb96b2..1db7deb6aa 100644 --- a/crawl-ref/source/wiz-dgn.h +++ b/crawl-ref/source/wiz-dgn.h @@ -1,8 +1,7 @@ -/* - * File: wiz-dgn.h - * Summary: Dungeon related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Dungeon related wizard functions. +**/ #ifndef WIZDGN_H #define WIZDGN_H diff --git a/crawl-ref/source/wiz-fsim.cc b/crawl-ref/source/wiz-fsim.cc index 67748e8ed5..e5da44346e 100644 --- a/crawl-ref/source/wiz-fsim.cc +++ b/crawl-ref/source/wiz-fsim.cc @@ -1,8 +1,7 @@ -/* - * File: wiz-fsim.cc - * Summary: Fight simualtion wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Fight simualtion wizard functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-fsim.h b/crawl-ref/source/wiz-fsim.h index ff6061e9bb..1422feb9d3 100644 --- a/crawl-ref/source/wiz-fsim.h +++ b/crawl-ref/source/wiz-fsim.h @@ -1,8 +1,7 @@ -/* - * File: wiz-fsim.h - * Summary: Fight simualtion wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Fight simualtion wizard functions. +**/ #ifndef WIZFSIM_H #define WIZFSIM_H diff --git a/crawl-ref/source/wiz-item.cc b/crawl-ref/source/wiz-item.cc index 84f8e22e2d..054bb15e7c 100644 --- a/crawl-ref/source/wiz-item.cc +++ b/crawl-ref/source/wiz-item.cc @@ -1,8 +1,7 @@ -/* - * File: wiz-item.cc - * Summary: Item related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Item related wizard functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-item.h b/crawl-ref/source/wiz-item.h index 5164396a26..d3369c4a66 100644 --- a/crawl-ref/source/wiz-item.h +++ b/crawl-ref/source/wiz-item.h @@ -1,8 +1,7 @@ -/* - * File: wiz-item.h - * Summary: Item related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Item related wizard functions. +**/ #ifndef WIZITEM_H #define WIZITEM_H diff --git a/crawl-ref/source/wiz-mon.cc b/crawl-ref/source/wiz-mon.cc index 1a2cd2ee94..88809b0267 100644 --- a/crawl-ref/source/wiz-mon.cc +++ b/crawl-ref/source/wiz-mon.cc @@ -1,8 +1,7 @@ -/* - * File: dbg-mon.cc - * Summary: Monster related debugging functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Monster related debugging functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-mon.h b/crawl-ref/source/wiz-mon.h index d091c22d3e..a0ab09f017 100644 --- a/crawl-ref/source/wiz-mon.h +++ b/crawl-ref/source/wiz-mon.h @@ -1,8 +1,7 @@ -/* - * File: wiz-mon.h - * Summary: Monster related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Monster related wizard functions. +**/ #ifndef WIZMON_H #define WIZMON_H diff --git a/crawl-ref/source/wiz-you.cc b/crawl-ref/source/wiz-you.cc index 4d3ed51c64..89a33b8659 100644 --- a/crawl-ref/source/wiz-you.cc +++ b/crawl-ref/source/wiz-you.cc @@ -1,8 +1,7 @@ -/* - * File: wiz-you.cc - * Summary: Player related debugging functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Player related debugging functions. +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/wiz-you.h b/crawl-ref/source/wiz-you.h index c9c4fe4689..bcfa59a1a0 100644 --- a/crawl-ref/source/wiz-you.h +++ b/crawl-ref/source/wiz-you.h @@ -1,8 +1,7 @@ -/* - * File: wiz-you.h - * Summary: Player related wizard functions. - * Written by: Linley Henzell and Jesse Jones - */ +/** + * @file + * @brief Player related wizard functions. +**/ #ifndef WIZYOU_H #define WIZYOU_H diff --git a/crawl-ref/source/xom.cc b/crawl-ref/source/xom.cc index 5a97035993..d3b54ac4fc 100644 --- a/crawl-ref/source/xom.cc +++ b/crawl-ref/source/xom.cc @@ -1,8 +1,7 @@ -/* - * File: xom.cc - * Summary: All things Xomly - * Written by: Zooko - */ +/** + * @file + * @brief All things Xomly +**/ #include "AppHdr.h" diff --git a/crawl-ref/source/xom.h b/crawl-ref/source/xom.h index 26a19bc5a4..55936b282f 100644 --- a/crawl-ref/source/xom.h +++ b/crawl-ref/source/xom.h @@ -1,8 +1,7 @@ -/* - * File: xom.h - * Summary: Misc Xom related functions. - * Written by: Linley Henzell - */ +/** + * @file + * @brief Misc Xom related functions. +**/ #ifndef XOM_H #define XOM_H diff --git a/crawl-ref/source/zap-data.h b/crawl-ref/source/zap-data.h index aa0380e05f..4cd985fb8f 100644 --- a/crawl-ref/source/zap-data.h +++ b/crawl-ref/source/zap-data.h @@ -1,7 +1,7 @@ -/* - * File: zap-data.h - * Summary: Zap definitions. See zap_info struct in beam.cc. - */ +/** + * @file + * @brief Zap definitions. See zap_info struct in beam.cc. +**/ #ifndef ZAP_DATA_H #define ZAP_DATA_H diff --git a/crawl-ref/source/zotdef.cc b/crawl-ref/source/zotdef.cc index 04030208cf..71e081235d 100644 --- a/crawl-ref/source/zotdef.cc +++ b/crawl-ref/source/zotdef.cc @@ -1,8 +1,7 @@ -/* - * File: zotdef.cc - * Summary: Zot Def specific functions - * Written by: Mark Mackey - */ +/** + * @file + * @brief Zot Def specific functions +**/ #include "AppHdr.h" |