Author: mordante
Date: Sat Sep 20 11:43:54 2008
New Revision: 29571
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29571&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/serialization/preprocessor.cpp
trunk/src/serialization/preprocessor.hpp
Modified: trunk/src/serialization/preprocessor.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/serialization/preprocessor.cpp?rev=29571&r1=29570&r2=29571&view=diff
==============================================================================
--- trunk/src/serialization/preprocessor.cpp (original)
+++ trunk/src/serialization/preprocessor.cpp Sat Sep 20 11:43:54 2008
@@ -13,8 +13,10 @@
See the COPYING file for more details.
*/
-//! @file serialization/preprocessor.cpp
-//! WML preprocessor.
+/**
+ * @file serialization/preprocessor.cpp
+ * WML preprocessor.
+ */
#include "../global.hpp"
@@ -353,7 +355,7 @@
{
struct token_desc
{
- //! @todo FIXME: add enum for token type, with explanation of
the different types
+ /** @todo FIXME: add enum for token type, with explanation of
the different types. */
char type;
int stack_pos;
int linenum;
@@ -363,8 +365,11 @@
std::vector< std::string > strings_;
std::vector< token_desc > tokens_;
bool is_macro;
- int slowpath_, //! @todo FIXME: add explanation of this variable
- skipping_, //will get set to true when skipping text(e.g.
#ifdef that evaluates to false)
+ int slowpath_, /** @todo FIXME: add explanation of this variable. */
+ skipping_, /**<
+ * Will get set to true when skipping text
+ * (e.g. #ifdef that evaluates to false)
+ */
linenum_;
std::string read_word();
@@ -812,14 +817,16 @@
preproc_map::const_iterator macro =
target_.defines_->find(symbol);
if(macro != target_.defines_->end()) {
-//! @todo it seems some addons use other names instead of include so disable
-//! the code for now. Once 1.4 has been released we can try to fix it again or
-//! make it mandatory to use INCLUDE for this purpose.
-//
-//! ESR says: No, it was a fundamentally mistaken idea to do this here;
wmllint
-//! could do the same direct-recursion check without imposing runtime overhead
-//! or causing the problems this code did. Leaving this code in for
-//! documentation purposes only, don't re-enable it.
+/**
+ * @todo it seems some addons use other names instead of include so disable the
+ * code for now. Once 1.4 has been released we can try to fix it again or make
+ * it mandatory to use INCLUDE for this purpose.
+ *
+ * ESR says: No, it was a fundamentally mistaken idea to do this here; wmllint
+ * could do the same direct-recursion check without imposing runtime overhead
+ * or causing the problems this code did. Leaving this code in for
+ * documentation purposes only, don't re-enable it.
+ */
#if 0
// INCLUDE is special and is allowed to be used
recusively.
if(symbol != "INCLUDE") {
Modified: trunk/src/serialization/preprocessor.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/serialization/preprocessor.hpp?rev=29571&r1=29570&r2=29571&view=diff
==============================================================================
--- trunk/src/serialization/preprocessor.hpp (original)
+++ trunk/src/serialization/preprocessor.hpp Sat Sep 20 11:43:54 2008
@@ -13,7 +13,7 @@
See the COPYING file for more details.
*/
-//! @file serialization/preprocessor.hpp
+/** @file serialization/preprocessor.hpp. */
#ifndef SERIALIZATION_PREPROCESSOR_HPP_INCLUDED
#define SERIALIZATION_PREPROCESSOR_HPP_INCLUDED
@@ -64,9 +64,13 @@
std::ostream& operator<<(std::ostream& stream, const preproc_map::value_type&
def);
-//! Function to use the WML preprocessor on a file,
-//! and returns the resulting preprocessed file data.
-//! defines is a map of symbols defined.
+/**
+ * Function to use the WML preprocessor on a file.
+ *
+ * @param defines A map of symbols defined.
+ *
+ * @returns The resulting preprocessed file data.
+ */
std::istream *preprocess_file(std::string const &fname,
preproc_map *defines = NULL, std::string
*error_log=NULL);
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
