[Scummvm-git-logs] scummvm master -> c52f7e0e0402054ecb43ecef413f9eb0f2182b84
sev-
sev at scummvm.org
Mon Oct 5 11:45:13 UTC 2020
This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
c52f7e0e04 DOXYGEN: doxygen changes in header files 2
Commit: c52f7e0e0402054ecb43ecef413f9eb0f2182b84
https://github.com/scummvm/scummvm/commit/c52f7e0e0402054ecb43ecef413f9eb0f2182b84
Author: Bartosz Gentkowski (bartosz.gentkowski at nordicsemi.no)
Date: 2020-10-05T13:45:08+02:00
Commit Message:
DOXYGEN: doxygen changes in header files 2
Edited files in the common folder:
- bufferedstream.h
- callback.h
- config-manager.h
- coroutines.h
- cosinetables.h
- dcl.h
- debug.h
- debug-channels.h
Changed paths:
common/bufferedstream.h
common/callback.h
common/config-manager.h
common/coroutines.h
common/cosinetables.h
common/dcl.h
common/dct.h
common/debug-channels.h
common/debug.h
diff --git a/common/bufferedstream.h b/common/bufferedstream.h
index 94117276bc..21c4d319d4 100644
--- a/common/bufferedstream.h
+++ b/common/bufferedstream.h
@@ -38,36 +38,48 @@ namespace Common {
*/
/**
- * Take an arbitrary ReadStream and wrap it in a custom stream which
+ * Take an arbitrary ReadStream and wrap it in a custom stream that
* transparently provides buffering.
- * Users can specify how big the buffer should be, and whether the wrapped
+ * You can specify how big the buffer should be, and whether the wrapped
* stream should be disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
+ *
+ * @param parentStream The ReadStream to wrap in a custom stream.
+ * @param bufSize Size of the buffer.
+ * @param disposeParentStream Flag indicating whether to dispose of the wrapped stream.
*/
ReadStream *wrapBufferedReadStream(ReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream);
/**
- * Take an arbitrary SeekableReadStream and wrap it in a custom stream which
+ * Take an arbitrary SeekableReadStream and wrap it in a custom stream that
* transparently provides buffering.
- * Users can specify how big the buffer should be, and whether the wrapped
+ * You can specify how big the buffer should be, and whether the wrapped
* stream should be disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
+ *
+ * @param parentStream The SeekableReadStream to wrap in a custom stream.
+ * @param bufSize Size of the buffer.
+ * @param disposeParentStream Flag indicating whether to dispose of the wrapped stream.
*/
SeekableReadStream *wrapBufferedSeekableReadStream(SeekableReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream);
/**
- * Take an arbitrary WriteStream and wrap it in a custom stream which
+ * Take an arbitrary WriteStream and wrap it in a custom stream that
* transparently provides buffering.
- * Users can specify how big the buffer should be. Currently, the
+ * You can specify how big the buffer should be. Currently, the
* parent stream is \em always disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
+ *
+ * @param parentStream The WriteStream to wrap in a custom stream.
+ * @param bufSize Size of the buffer.
*/
+
WriteStream *wrapBufferedWriteStream(WriteStream *parentStream, uint32 bufSize);
/** @} */
diff --git a/common/callback.h b/common/callback.h
index c1ada14c34..7ee15476d9 100644
--- a/common/callback.h
+++ b/common/callback.h
@@ -29,37 +29,36 @@ namespace Common {
* @defgroup common_callback Callbacks
* @ingroup common
*
- * @brief Callback templates.
- *
+ * @brief Callback class templates.
* @{
*/
/**
* BaseCallback<S> is a simple base class for object-oriented callbacks.
*
- * Object-oriented callbacks are such callbacks that know exact instance
- * which method must be called.
+ * Object-oriented callbacks are callbacks that know the exact instance
+ * of the method that must be called.
*
- * For backwards compatibility purposes, there is a GlobalFunctionCallback,
+ * For backward compatibility purposes, GlobalFunctionCallback is available,
* which is BaseCallback<void *>, so it can be used with global C-like
* functions too.
*
- * <S> is the type, which is passed to operator() of this callback.
- * This allows you to specify that you accept a callback, which wants
- * to receive an <S> object.
+ * \<S\> is the type that is passed to operator() of this callback.
+ * This allows you to specify that you accept a callback that wants
+ * to receive an \<S\> object.
*/
template<typename S = void *> class BaseCallback {
public:
BaseCallback() {}
virtual ~BaseCallback() {}
- virtual void operator()(S data) = 0;
+ virtual void operator()(S data) = 0; /*!< Type of the object passed to the operator. */
};
/**
* GlobalFunctionCallback<T> is a simple wrapper for global C functions.
*
- * If there is a method, which accepts BaseCallback<T>, you can
- * easily pass your C function by passing
+ * If a method accepts BaseCallback<T>, you can
+ * pass your C function by passing
* new GlobalFunctionCallback<T>(yourFunction)
*/
template<typename T> class GlobalFunctionCallback: public BaseCallback<T> {
@@ -69,7 +68,7 @@ template<typename T> class GlobalFunctionCallback: public BaseCallback<T> {
public:
GlobalFunctionCallback(GlobalFunction cb): _callback(cb) {}
virtual ~GlobalFunctionCallback() {}
- virtual void operator()(T data) {
+ virtual void operator()(T data) { /*!< C function passed to the operator. */
if (_callback) _callback(data);
}
};
@@ -77,35 +76,37 @@ public:
/**
* Callback<T, S> implements an object-oriented callback.
*
- * <T> stands for a class which method you want to call.
- * <S>, again, is the type of an object passed to operator().
+ * \<T\> stands for a class whose method you want to call.
+ * \<S\> is the type of the object passed to operator().
*
* So, if you have void MyClass::myMethod(AnotherClass) method,
* the corresponding callback is Callback<MyClass, AnotherClass>.
- * You create it similarly to this:
+ * You can create it in the following way:
+ * @code
* new Callback<MyClass, AnotherClass>(
* pointerToMyClassObject,
* &MyClass::myMethod
* )
+ * @endcode
*/
template<class T, typename S = void *> class Callback: public BaseCallback<S> {
protected:
typedef void(T::*TMethod)(S);
T *_object;
- TMethod _method;
+ ;
public:
Callback(T *object, TMethod method): _object(object), _method(method) {}
virtual ~Callback() {}
- void operator()(S data) { (_object->*_method)(data); }
+ void operator()(S data) { (_object->*_method)(data); } /*!< Type of the object passed to the operator. */
};
/**
- * CallbackBridge<T, OS, S> helps you to chain callbacks.
+ * CallbackBridge<T, OS, S> allows you to chain callbacks.
*
* CallbackBridge keeps a pointer to BaseCallback<OS>.
* When its operator() is called, it passes this pointer
- * along with the actual data (of type <S>) to the method
- * of <T> class.
+ * along with the actual data (of type \<S\>) to the method
+ * of \<T\> class.
*
* This is needed when you have to call a callback only
* when your own callback is called. So, your callback
@@ -119,9 +120,9 @@ public:
* So, if you receive a BaseCallback<SomeClass> callback
* and you want to call it from your MyClass::myMethod method,
* you should create CallbackBridge<MyClass, SomeClass, S>,
- * where <S> is data type you want to receive in MyClass::myMethod.
+ * where \<S\> is the data type you want to receive in MyClass::myMethod.
*
- * You create it similarly to this:
+ * You can create it in the following way:
* new Callback<MyClass, SomeClass, AnotherClass>(
* pointerToMyClassObject,
* &MyClass::myMethod,
@@ -139,7 +140,7 @@ public:
CallbackBridge(T *object, TCallbackMethod method, BaseCallback<OS> *outerCallback):
_object(object), _method(method), _outerCallback(outerCallback) {}
virtual ~CallbackBridge() {}
- void operator()(S data) { (_object->*_method)(_outerCallback, data); }
+ void operator()(S data) { (_object->*_method)(_outerCallback, data); } /*!< Type of the object passed to the operator. */
};
/** @} */
diff --git a/common/config-manager.h b/common/config-manager.h
index f2cfd7b145..185535d5e0 100644
--- a/common/config-manager.h
+++ b/common/config-manager.h
@@ -48,7 +48,7 @@ class SeekableReadStream;
* The (singleton) configuration manager, used to query & set configuration
* values using string keys.
*
- * @todo Implement the callback based notification system (outlined below)
+ * TBD: Implement the callback based notification system (outlined below)
* which sends out notifications to interested parties whenever the value
* of some specific (or any) configuration key changes.
*/
@@ -107,55 +107,64 @@ public:
static char const *const kCloudDomain;
#endif
- void loadDefaultConfigFile();
- void loadConfigFile(const String &filename);
+ void loadDefaultConfigFile(); /*!< Load the default configuration file. */
+ void loadConfigFile(const String &filename); /*!< Load a specific configuration file. */
/**
* Retrieve the config domain with the given name.
- * @param domName the name of the domain to retrieve
- * @return pointer to the domain, or 0 if the domain doesn't exist.
+ * @param domName Name of the domain to retrieve.
+ * @return Pointer to the domain, or 0 if the domain does not exist.
*/
Domain * getDomain(const String &domName);
- const Domain * getDomain(const String &domName) const;
+ const Domain * getDomain(const String &domName) const; /*!< @overload */
- //
- // Generic access methods: No domain specified, use the values from the
- // various domains in the order of their priority.
- //
+ /**
+ * @name Generic access methods
+ * @brief No domain specified, use the values from the
+ * various domains in the order of their priority.
+ * @{
+ */
bool hasKey(const String &key) const;
const String & get(const String &key) const;
void set(const String &key, const String &value);
-
+ /** @} */
+
/**
* Update a configuration entry for the active domain and flush
- * the configuration file to disk if the value changed
+ * the configuration file to disk if the value changed.
*/
void setAndFlush(const String &key, const Common::String &value);
#if 1
- //
- // Domain specific access methods: Acces *one specific* domain and modify it.
- // TODO: I'd like to get rid of most of those if possible, or at least reduce
- // their usage, by using getDomain as often as possible. For example in the
- // options dialog code...
- //
+ /**
+ * @name Domain-specific access methods
+ * @brief Access one specific domain and modify it.
+ *
+ * TBD: Get rid of most of those if possible, or at least reduce
+ * their usage, by using getDomain as often as possible. For example in the
+ * options dialog code.
+ * @{
+ */
bool hasKey(const String &key, const String &domName) const;
const String & get(const String &key, const String &domName) const;
void set(const String &key, const String &value, const String &domName);
void removeKey(const String &key, const String &domName);
+ /** @} */
#endif
- //
- // Some additional convenience accessors.
- //
- int getInt(const String &key, const String &domName = String()) const;
- bool getBool(const String &key, const String &domName = String()) const;
- void setInt(const String &key, int value, const String &domName = String());
- void setBool(const String &key, bool value, const String &domName = String());
+ /**
+ * @name Additional convenience accessors
+ * @{
+ */
+
+ int getInt(const String &key, const String &domName = String()) const; /*!< Get integer value. */
+ bool getBool(const String &key, const String &domName = String()) const; /*!< Get Boolean value. */
+ void setInt(const String &key, int value, const String &domName = String()); /*!< Set integer value. */
+ void setBool(const String &key, bool value, const String &domName = String()); /*!< Set integer value. */
void registerDefault(const String &key, const String &value);
@@ -163,20 +172,20 @@ public:
void registerDefault(const String &key, int value);
void registerDefault(const String &key, bool value);
- void flushToDisk();
+ void flushToDisk(); /*!< Flush configuration to disk. */
- void setActiveDomain(const String &domName);
- Domain * getActiveDomain() { return _activeDomain; }
- const Domain * getActiveDomain() const { return _activeDomain; }
- const String & getActiveDomainName() const { return _activeDomainName; }
+ void setActiveDomain(const String &domName); /*!< Set the given domain as active. */
+ Domain * getActiveDomain() { return _activeDomain; } /*!< Get the active domain. */
+ const Domain * getActiveDomain() const { return _activeDomain; } /*!< @overload */
+ const String & getActiveDomainName() const { return _activeDomainName; } /*!< Get the name of the active domain. */
- void addGameDomain(const String &domName);
- void removeGameDomain(const String &domName);
- void renameGameDomain(const String &oldName, const String &newName);
+ void addGameDomain(const String &domName); /*!< Add a new game domain. */
+ void removeGameDomain(const String &domName); /*!< Remove a game domain. */
+ void renameGameDomain(const String &oldName, const String &newName); /*!< Rename a game domain. */
- void addMiscDomain(const String &domName);
- void removeMiscDomain(const String &domName);
- void renameMiscDomain(const String &oldName, const String &newName);
+ void addMiscDomain(const String &domName); /*!< Add a miscellaneous domain. */
+ void removeMiscDomain(const String &domName); /*!< Remove a miscellaneous domain. */
+ void renameMiscDomain(const String &oldName, const String &newName); /*!< Rename a miscellaneous domain. */
bool hasGameDomain(const String &domName) const;
bool hasMiscDomain(const String &domName) const;
@@ -187,7 +196,7 @@ public:
static void defragment(); // move in memory to reduce fragmentation
void copyFrom(ConfigManager &source);
-
+ /** @} */
private:
friend class Singleton<SingletonBaseType>;
ConfigManager();
diff --git a/common/coroutines.h b/common/coroutines.h
index 68f0fa692d..924133267a 100644
--- a/common/coroutines.h
+++ b/common/coroutines.h
@@ -60,12 +60,12 @@ struct CoroBaseContext {
const char *_funcName;
#endif
/**
- * Creates a coroutine context
+ * Create a coroutine context.
*/
CoroBaseContext(const char *func);
/**
- * Destructor for coroutine context
+ * Destructor for coroutine context.
*/
virtual ~CoroBaseContext();
};
@@ -74,7 +74,7 @@ typedef CoroBaseContext *CoroContext;
/** This is a special constant that can be temporarily used as a parameter to call coroutine-ised
- * methods from code that haven't yet been converted to being a coroutine, so code at least
+ * methods from code that have not yet been converted to being a coroutine, so code at least
* compiles correctly. Be aware, though, that an error will occur if a coroutine that was passed
* the nullContext tries to sleep or yield control.
*/
@@ -82,9 +82,9 @@ extern CoroContext nullContext;
/**
* Wrapper class which holds a pointer to a pointer to a CoroBaseContext.
- * The interesting part is the destructor, which kills the context being held,
+ * Note that the destructor kills the context being held,
* but ONLY if the _sleep val of that context is zero. This way, a coroutine
- * can just 'return' w/o having to worry about freeing the allocated context
+ * can just 'return' without freeing the allocated context
* (in Simon Tatham's original code, one had to use a special macro to
* return from a coroutine).
*/
@@ -104,30 +104,30 @@ public:
}
};
-/** Methods that have been converted to being a coroutine should have this as the first parameter */
+/** Set this as the first parameter for methods that have been converted to being a coroutine. */
#define CORO_PARAM Common::CoroContext &coroParam
/**
* Begin the declaration of a coroutine context.
* This allows declaring variables which are 'persistent' during the
- * lifetime of the coroutine. An example use would be:
- *
+ * lifetime of the coroutine. Example usage:
+ * @code
* CORO_BEGIN_CONTEXT;
* int var;
* char *foo;
* CORO_END_CONTEXT(_ctx);
- *
+ * @endcode
* It is not possible to initialize variables here, due to the way this
* macro is implemented. Furthermore, to use the variables declared in
- * the coroutine context, you have to access them via the context variable
- * name that was specified as parameter to CORO_END_CONTEXT, e.g.
+ * the coroutine context, you must access them through the context variable
+ * name that was specified as a parameter to @c CORO_END_CONTEXT, e.g.
* _ctx->var = 0;
*
* @see CORO_END_CONTEXT
*
- * @note We declare a variable 'DUMMY' to allow the user to specify an 'empty'
- * context, and so compilers won't complain about ";" following the macro.
+ * @note A 'DUMMY' variable is declared to allow the user to specify an 'empty'
+ * context, and so that compilers do not complain about ";" following the macro.
*/
#define CORO_BEGIN_CONTEXT \
struct CoroContextTag : Common::CoroBaseContext { \
@@ -136,15 +136,14 @@ public:
/**
* End the declaration of a coroutine context.
- * @param x name of the coroutine context
+ * @param x Name of the coroutine context.
* @see CORO_BEGIN_CONTEXT
*/
#define CORO_END_CONTEXT(x) } *x = (CoroContextTag *)coroParam
/**
* Begin the code section of a coroutine.
- * @param x name of the coroutine context
- * @see CORO_BEGIN_CODE
+ * @param x Name of the coroutine context.
*/
#define CORO_BEGIN_CODE(x) \
if (&coroParam == &Common::nullContext) assert(!Common::nullContext); \
@@ -155,7 +154,6 @@ public:
/**
* End the code section of a coroutine.
- * @see CORO_END_CODE
*/
#define CORO_END_CODE \
if (&coroParam == &Common::nullContext) { \
@@ -181,9 +179,9 @@ public:
/**
* Stop the currently running coroutine and all calling coroutines.
*
- * This sets _sleep to -1 rather than 0 so that the context doesn't get
- * deleted by CoroContextHolder, since we want CORO_INVOKE_ARGS to
- * propogate the _sleep value and return immediately (the scheduler will
+ * This sets _sleep to -1 rather than 0 so that the context does not get
+ * deleted by CoroContextHolder, since we want @ref CORO_INVOKE_ARGS to
+ * propagate the _sleep value and return immediately (the scheduler will
* then delete the entire coroutine's state, including all subcontexts).
*/
#define CORO_KILL_SELF() \
@@ -191,8 +189,8 @@ public:
/**
- * This macro is to be used in conjunction with CORO_INVOKE_ARGS and
- * similar macros for calling coroutines-enabled subroutines.
+ * Use this macro in conjunction with @ref CORO_INVOKE_ARGS and
+ * similar macros for calling coroutine-enabled subroutines.
*/
#define CORO_SUBCTX coroParam->_subctx
@@ -206,10 +204,10 @@ public:
* If the subcontext is null, the coroutine ended normally, and we can
* simply break out of the loop and continue execution.
*
- * @param subCoro name of the coroutine-enabled function to invoke
- * @param ARGS list of arguments to pass to subCoro
+ * @param subCoro Name of the coroutine-enabled function to invoke.
+ * @param ARGS List of arguments to pass to subCoro.
*
- * @note ARGS must be surrounded by parentheses, and the first argument
+ * @note @p ARGS must be surrounded by parentheses, and the first argument
* in this list must always be CORO_SUBCTX. For example, the
* regular function call
* myFunc(a, b);
@@ -230,9 +228,9 @@ public:
} while (0)
/**
- * Invoke another coroutine. Similar to CORO_INVOKE_ARGS,
+ * Invoke another coroutine. Similar to @ref CORO_INVOKE_ARGS,
* but allows specifying a return value which is returned
- * if invoked coroutine yields (thus causing the current
+ * if the invoked coroutine yields (thus causing the current
* coroutine to yield, too).
*/
#define CORO_INVOKE_ARGS_V(subCoro, RESULT, ARGS) \
@@ -249,14 +247,14 @@ public:
} while (0)
/**
- * Convenience wrapper for CORO_INVOKE_ARGS for invoking a coroutine
+ * Convenience wrapper for @ref CORO_INVOKE_ARGS for invoking a coroutine
* with no parameters.
*/
#define CORO_INVOKE_0(subCoroutine) \
CORO_INVOKE_ARGS(subCoroutine, (CORO_SUBCTX))
/**
- * Convenience wrapper for CORO_INVOKE_ARGS for invoking a coroutine
+ * Convenience wrapper for @ref CORO_INVOKE_ARGS for invoking a coroutine
* with one parameter.
*/
#define CORO_INVOKE_1(subCoroutine, a0) \
@@ -270,7 +268,7 @@ public:
CORO_INVOKE_ARGS(subCoroutine, (CORO_SUBCTX, a0, a1))
/**
- * Convenience wrapper for CORO_INVOKE_ARGS for invoking a coroutine
+ * Convenience wrapper for @ref CORO_INVOKE_ARGS for invoking a coroutine
* with three parameters.
*/
#define CORO_INVOKE_3(subCoroutine, a0,a1,a2) \
@@ -285,10 +283,10 @@ public:
-// the size of process specific info
+/** Size of process-specific information. */
#define CORO_PARAM_SIZE 32
-// the maximum number of processes
+/** Maximum number of processes. */
#define CORO_NUM_PROCESS 100
#define CORO_MAX_PROCESSES 100
#define CORO_MAX_PID_WAITING 5
@@ -296,26 +294,26 @@ public:
#define CORO_INFINITE 0xffffffff
#define CORO_INVALID_PID_VALUE 0
-/** Coroutine parameter for methods converted to coroutines */
+/** Coroutine parameter for methods converted to coroutines. */
typedef void (*CORO_ADDR)(CoroContext &, const void *);
/** process structure */
struct PROCESS {
- PROCESS *pNext; ///< pointer to next process in active or free list
- PROCESS *pPrevious; ///< pointer to previous process in active or free list
+ PROCESS *pNext; ///< Pointer to the next process in an active or free list.
+ PROCESS *pPrevious; ///< Pointer to the previous process in an active or free list.
- CoroContext state; ///< the state of the coroutine
- CORO_ADDR coroAddr; ///< the entry point of the coroutine
+ CoroContext state; ///< State of the coroutine.
+ CORO_ADDR coroAddr; ///< Entry point of the coroutine.
- int sleepTime; ///< number of scheduler cycles to sleep
- uint32 pid; ///< process ID
- uint32 pidWaiting[CORO_MAX_PID_WAITING]; ///< Process ID(s) process is currently waiting on
- char param[CORO_PARAM_SIZE]; ///< process specific info
+ int sleepTime; ///< Number of scheduler cycles to sleep.
+ uint32 pid; ///< Process ID.
+ uint32 pidWaiting[CORO_MAX_PID_WAITING]; ///< Process ID(s) that the process is currently waiting on.
+ char param[CORO_PARAM_SIZE]; ///< Process-specific information.
};
typedef PROCESS *PPROCESS;
-/** Event structure */
+/** Event structure. */
struct EVENT {
uint32 pid;
bool manualReset;
@@ -325,7 +323,7 @@ struct EVENT {
/**
- * Creates and manages "processes" (really coroutines).
+ * Create and manage "processes" (really coroutines).
*/
class CoroutineScheduler : public Singleton<CoroutineScheduler> {
public:
@@ -336,42 +334,42 @@ private:
friend class Singleton<CoroutineScheduler>;
/**
- * Constructor
+ * Constructor.
*/
CoroutineScheduler();
/**
- * Destructor
+ * Destructor.
*/
~CoroutineScheduler();
- /** list of all processes */
+ /** List of all processes. */
PROCESS *processList;
- /** active process list - also saves scheduler state */
+ /** Active process list. Saves scheduler state. */
PROCESS *active;
- /** pointer to free process list */
+ /** Pointer to the free process list. */
PROCESS *pFreeProcesses;
- /** the currently active process */
+ /** Currently active process. */
PROCESS *pCurrent;
- /** Auto-incrementing process Id */
+ /** Auto-incrementing process ID. */
int pidCounter;
- /** Event list */
+ /** Event list. */
Common::List<EVENT *> _events;
#ifdef DEBUG
- // diagnostic process counters
+ /** Diagnostic process counters. */
int numProcs;
int maxProcs;
/**
- * Checks both the active and free process list to insure all the links are valid,
- * and that no processes have been lost
+ * Check both the active and free process list to ensure that all links are valid,
+ * and that no processes have been lost.
*/
void checkStack();
#endif
@@ -386,24 +384,24 @@ private:
EVENT *getEvent(uint32 pid);
public:
/**
- * Kills all processes and places them on the free list.
+ * Kill all processes and place them on the free list.
*/
void reset();
#ifdef DEBUG
/**
- * Shows the maximum number of process used at once.
+ * Show the maximum number of processes used at once.
*/
void printStats();
#endif
/**
- * Give all active processes a chance to run
+ * Give all active processes a chance to run.
*/
void schedule();
/**
- * Reschedules all the processes to run again this tick
+ * Reschedule all processes to run again this tick.
*/
void rescheduleAll();
@@ -414,151 +412,155 @@ public:
void reschedule(PPROCESS pReSchedProc = nullptr);
/**
- * Moves the specified process to the end of the dispatch queue
+ * Move the specified process to the end of the dispatch queue
* allowing it to run again within the current game cycle.
- * @param pGiveProc Which process
+ * @param pReSchedProc The process to move.
*/
void giveWay(PPROCESS pReSchedProc = nullptr);
/**
- * Continously makes a given process wait for another process to finish or event to signal.
+ * Continously make a given process wait for another process to finish or event to signal.
*
- * @param pid Process/Event identifier
- * @param duration Duration in milliseconds
- * @param expired If specified, set to true if delay period expired
+ * @param pid Process/Event identifier.
+ * @param duration Duration in milliseconds.
+ * @param expired If specified, set to true if the delay period expired.
*/
void waitForSingleObject(CORO_PARAM, int pid, uint32 duration, bool *expired = nullptr);
/**
- * Continously makes a given process wait for given prcesses to finished or events to be set
+ * Continously make a given process wait for given processes to finish or events to be set.
*
- * @param nCount Number of Id's being passed
- * @param evtList List of pids to wait for
- * @param bWaitAll Specifies whether all or any of the processes/events
- * @param duration Duration in milliseconds
- * @param expired Set to true if delay period expired
+ * @param nCount Number of IDs being passed.
+ * @param pidList List of process IDs to wait for.
+ * @param bWaitAll Whether to wait for all or any of the processes/events.
+ * @param duration Duration in milliseconds.
+ * @param expired Set to true if the delay period expired.
*/
void waitForMultipleObjects(CORO_PARAM, int nCount, uint32 *pidList, bool bWaitAll,
uint32 duration, bool *expired = nullptr);
/**
- * Make the active process sleep for the given duration in milliseconds
+ * Make the active process sleep for the given duration in milliseconds.
*
* @param duration Duration in milliseconds
- * @remarks This duration won't be precise, since it relies on the frequency the
- * scheduler is called.
+ * @remarks This duration is not precise, since it relies on the frequency the
+ * scheduler is called.
*/
void sleep(CORO_PARAM, uint32 duration);
/**
- * Creates a new process.
+ * Create a new process.
*
- * @param pid process identifier
- * @param coroAddr Coroutine start address
- * @param pParam Process specific info
- * @param sizeParam Size of process specific info
+ * @param pid Process identifier.
+ * @param coroAddr Coroutine start address.
+ * @param pParam Process-specific information.
+ * @param sizeParam Size of the process-specific information.
*/
PROCESS *createProcess(uint32 pid, CORO_ADDR coroAddr, const void *pParam, int sizeParam);
/**
- * Creates a new process with an auto-incrementing Process Id.
+ * Create a new process with an auto-incrementing Process ID.
*
- * @param coroAddr Coroutine start address
- * @param pParam Process specific info
- * @param sizeParam Size of process specific info
+ * @param coroAddr Coroutine start address.
+ * @param pParam Process-specific information.
+ * @param sizeParam Size of process-specific information.
*/
uint32 createProcess(CORO_ADDR coroAddr, const void *pParam, int sizeParam);
/**
- * Creates a new process with an auto-incrementing Process Id, and a single pointer parameter.
+ * Create a new process with an auto-incrementing Process ID and a single pointer parameter.
*
- * @param coroAddr Coroutine start address
- * @param pParam Process specific info
+ * @param coroAddr Coroutine start address.
+ * @param pParam Process-specific information.
*/
uint32 createProcess(CORO_ADDR coroAddr, const void *pParam);
/**
- * Kills the specified process.
+ * Kill the specified process.
*
- * @param pKillProc Which process to kill
+ * @param pKillProc The process to kill.
*/
void killProcess(PROCESS *pKillProc);
/**
- * Returns a pointer to the currently running process.
+ * Return a pointer to the currently running process.
*/
PROCESS *getCurrentProcess();
/**
- * Returns the process identifier of the currently running process.
+ * Return the process identifier of the currently running process.
*/
int getCurrentPID() const;
/**
- * Kills any process matching the specified PID. The current
+ * Kill any process matching the specified PID. The current
* process cannot be killed.
*
- * @param pidKill Process identifier of process to kill
- * @param pidMask Mask to apply to process identifiers before comparison
- * @return The number of processes killed is returned.
+ * @param pidKill Process identifier of the process to kill.
+ * @param pidMask Mask to apply to process identifiers before comparison.
+ * @return The number of processes killed.
*/
int killMatchingProcess(uint32 pidKill, int pidMask = -1);
/**
* Set pointer to a function to be called by killProcess().
*
- * May be called by a resource allocator, the function supplied is
+ * May be called by a resource allocator. The function supplied is
* called by killProcess() to allow the resource allocator to free
* resources allocated to the dying process.
*
- * @param pFunc Function to be called by killProcess()
+ * @param pFunc Function to be called by killProcess().
*/
void setResourceCallback(VFPTRPP pFunc);
- /* Event methods */
+ /** @name Event methods
+ * @{
+ */
/**
- * Creates a new event (semaphore) object
+ * Create a new event (semaphore) object.
*
* @param bManualReset Events needs to be manually reset. Otherwise,
* events will be automatically reset after a
- * process waits on the event finishes
+ * process waits for the event to finish.
* @param bInitialState Specifies whether the event is signalled or not
- * initially
+ * initially.
*/
uint32 createEvent(bool bManualReset, bool bInitialState);
/**
- * Destroys the given event
- * @param pidEvent Event Process Id
+ * Destroy the given event.
+ * @param pidEvent Event Process ID.
*/
void closeEvent(uint32 pidEvent);
/**
- * Sets the event
- * @param pidEvent Event Process Id
+ * Set the event.
+ * @param pidEvent Event Process ID.
*/
void setEvent(uint32 pidEvent);
/**
- * Resets the event
- * @param pidEvent Event Process Id
+ * Reset the event.
+ * @param pidEvent Event Process ID.
*/
void resetEvent(uint32 pidEvent);
/**
- * Temporarily sets a given event to true, and then runs all waiting
- * processes,allowing any processes waiting on the event to be fired. It
+ * Temporarily set a given event to true, and then run all waiting
+ * processes, allowing any processes waiting on the event to be fired. It
* then immediately resets the event again.
*
- * @param pidEvent Event Process Id
+ * @param pidEvent Event Process ID.
*
- * @remarks Should not be run inside of another process
+ * @remarks Should not be run inside of another process.
*/
void pulseEvent(uint32 pidEvent);
};
/** @} */
+/** @} */
+
} // end of namespace Common
#endif // COMMON_COROUTINES_H
diff --git a/common/cosinetables.h b/common/cosinetables.h
index d790c757ad..7359874cdc 100644
--- a/common/cosinetables.h
+++ b/common/cosinetables.h
@@ -37,15 +37,15 @@ namespace Common {
class CosineTable {
public:
/**
- * Construct a cosine table given the number of points
+ * Construct a cosine table given the number of points.
*
- * @param nPoints Number of distinct radian points, which must be in range [16,65536] and be divisible by 4
+ * @param nPoints Number of distinct radian points that must be in range [16,65536] and be divisible by 4.
*/
CosineTable(int nPoints);
~CosineTable();
/**
- * Get pointer to table.
+ * Get a pointer to a table.
*
* This table contains nPoints/2 entries.
* Prefer to use at()
@@ -58,9 +58,9 @@ public:
const float *getTable() { return _tableEOS; }
/**
- * Returns cos(2*pi * index / nPoints )
+ * Return cos(2*pi * index / nPoints )
* Index must be in range [0, nPoints - 1]
- * Faster than atLegacy
+ * Faster than atLegacy.
*/
float at(int index) const;
diff --git a/common/dcl.h b/common/dcl.h
index fa7b95d6be..31da9da948 100644
--- a/common/dcl.h
+++ b/common/dcl.h
@@ -20,11 +20,6 @@
*
*/
-/**
- *
-
- */
-
#ifndef COMMON_DCL_H
#define COMMON_DCL_H
@@ -36,35 +31,43 @@ namespace Common {
* @defgroup common_dcl Data compression library
* @ingroup common
*
- * @brief PKWARE data compression library.
+ * @brief PKWARE data compression library (DCL).
*
* @details PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
- * - agos (exclusively for Simon 2 setup.shr file)
- * - mohawk
- * - neverhood
- * - sci
- *
+ * - AGOS (exclusively for Simon 2 setup.shr file)
+ * - Mohawk
+ * - Neverhood
+ * - SCI
* @{
*/
-
+
class ReadStream;
class SeekableReadStream;
/**
- * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns true if
- * successful.
+ * Decompress a PKWARE DCL compressed stream.
+ *
+ * @return Returns true if successful.
*/
bool decompressDCL(ReadStream *sourceStream, byte *dest, uint32 packedSize, uint32 unpackedSize);
/**
- * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns a valid pointer
- * if successful and 0 otherwise.
+ * @overload
+ *
+ * Decompress a PKWARE DCL compressed stream.
+ *
+ * @return Returns a valid pointer if successful or 0 otherwise.
*/
SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize);
/**
- * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns a valid pointer
- * if successful and 0 otherwise. This method is meant for cases, where the unpacked size is not known.
+ * @overload
+ *
+ * Decompress a PKWARE DCL compressed stream.
+ *
+ * This method is meant for cases, where the unpacked size is not known.
+ *
+ * @return Returns a valid pointer if successful or 0 otherwise.
*/
SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream);
diff --git a/common/dct.h b/common/dct.h
index c8d025d517..bd947005ae 100644
--- a/common/dct.h
+++ b/common/dct.h
@@ -50,7 +50,7 @@ namespace Common {
* (Inverse) Discrete Cosine Transforms.
*
* Used in engines:
- * - scumm
+ * - Scumm
*/
class DCT {
public:
diff --git a/common/debug-channels.h b/common/debug-channels.h
index 2cef6b40be..73fbe7fa36 100644
--- a/common/debug-channels.h
+++ b/common/debug-channels.h
@@ -36,10 +36,9 @@ namespace Common {
/**
* @defgroup common_debug_channels Debug channels
- * @ingroup common_debug
+ * @ingroup common
*
* @brief Functions for managing debug channels.
- *
* @{
*/
@@ -52,68 +51,69 @@ public:
DebugChannel(uint32 c, const String &n, const String &d)
: name(n), description(d), channel(c), enabled(false) {}
- String name;
- String description;
+ String name; /*!< Name of the channel */
+ String description; /*!< Description of the channel */
- uint32 channel;
- bool enabled;
+ uint32 channel; /*!< Channel number. */
+ bool enabled; /*!< Whether the channel is enabled. */
};
/**
- * Adds a debug channel.
+ * Add a debug channel.
*
- * A debug channel is considered roughly similar to what our debug levels described by
+ * A debug channel is considered roughly similar to what the debug levels described by
* gDebugLevel try to achieve:
*
- * Debug channels should only affect the display of additional debug output, based on
- * their state. That is if they are enabled, channel specific debug messages should
- * be shown. If they are disabled on the other hand, those messages will be hidden.
+ * Debug channels should only affect the display of additional debug output, based on
+ * their state. That is, if they are enabled, channel-specific debug messages should
+ * be shown. If they are disabled on the other hand, those messages will be hidden.
*
- * @see gDebugLevel.
+ * @see gDebugLevel
*
- * Note that we have debug* functions which depend both on the debug level set and
+ * Note that we have debug* functions that depend both on the debug level set and
* specific debug channels. Those functions will only show output, when *both* criteria
* are satisfied.
*
- * @param channel the channel flag (should be OR-able i.e. first one should be 1 then 2, 4, etc.)
- * @param name the option name which is used in the debugger/on the command line to enable
- * this special debug level (case will be ignored)
- * @param description the description which shows up in the debugger
- * @return true on success false on failure
+ * @param channel Channel flag (should be OR-able i.e. first one should be 1 then 2, 4, etc.).
+ * @param name The option name that is used in the debugger/on the command line to enable
+ * this special debug level (case will be ignored).
+ * @param description The description that shows up in the debugger.
+ *
+ * @return True on success, false on failure.
*/
bool addDebugChannel(uint32 channel, const String &name, const String &description);
/**
- * Resets all engine specific debug channels.
+ * Reset all engine-specific debug channels.
*/
void clearAllDebugChannels();
/**
- * Enables a debug channel.
+ * Enable a debug channel.
*
- * @param name the name of the debug channel to enable
- * @return true on success, false on failure
+ * @param name Name of the debug channel to enable.
+ * @return True on success, false on failure.
*/
bool enableDebugChannel(const String &name);
/**
- * Enables a debug channel.
+ * @overload enableDebugChannel(uint32 channel)
*
- * @param channel The debug channel
- * @return true on success, false on failure
+ * @param channel Debug channel.
+ * @return True on success, false on failure.
*/
bool enableDebugChannel(uint32 channel);
/**
- * Disables a debug channel.
+ * Disable a debug channel.
*
- * @param name the name of the debug channel to disable
- * @return true on success, false on failure
+ * @param name Name of the debug channel to disable.
+ * @return True on success, false on failure.
*/
bool disableDebugChannel(const String &name);
/**
- * Disables a debug channel.
+ * @overload bool disableDebugChannel(uint32 channel)
*
* @param channel The debug channel
* @return true on success, false on failure
@@ -154,7 +154,7 @@ private:
DebugManager() : gDebugChannelsEnabled(0) {}
};
-/** Shortcut for accessing the debug manager. */
+/** Shortcut for accessing the Debug Manager. */
#define DebugMan Common::DebugManager::instance()
/** @} */
diff --git a/common/debug.h b/common/debug.h
index 7beef8acb0..eb70f958cf 100644
--- a/common/debug.h
+++ b/common/debug.h
@@ -42,8 +42,7 @@ inline void debugCN(uint32 debugChannels, const char *s, ...) {}
* @defgroup common_debug Debug functions
* @ingroup common
*
- * @brief Debug functions.
- *
+ * @brief Functions for printing debug messages.
* @{
*/
@@ -118,28 +117,29 @@ void debugCN(uint32 debugChannels, const char *s, ...) GCC_PRINTF(2, 3);
#endif
/**
- * Returns true if the debug level is set to the specified level
+ * Check whether the debug level is set to the specified level.
*/
bool debugLevelSet(int level);
/**
- * Returns true if the debug level and channel are active
+ * Check whether the debug level and channel are active.
*
- * @param level debug level to check against. If set to -1, only channel check is active
+ * @param level Debug level to check against. If set to -1, only channel check is active.
+ * @param debugChannels Debug channel to check against.
* @see enableDebugChannel
*/
bool debugChannelSet(int level, uint32 debugChannels);
/**
* The debug level. Initially set to -1, indicating that no debug output
- * should be shown. Positive values usually imply an increasing number of
- * debug output shall be generated, the higher the value, the more verbose the
+ * should be shown. Positive values usually imply that an increasing number of
+ * debug output shall be generated. The higher the value, the more verbose the
* information (although the exact semantics are up to the engines).
*/
extern int gDebugLevel;
/**
- * Specify if we want to show only the debug channels and suppress
+ * Specify whether to show only the debug channels and suppress
* the non-channeled output.
*
* This option is useful when you want to have higher levels of channels
@@ -147,7 +147,7 @@ extern int gDebugLevel;
*/
extern bool gDebugChannelsOnly;
-//Global constant for EventRecorder debug channel
+/** Global constant for EventRecorder debug channel. */
enum GlobalDebugLevels {
kDebugLevelEventRec = 1 << 30
};
More information about the Scummvm-git-logs
mailing list