[Scummvm-git-logs] scummvm master -> ec24687ce4100ca6c9477c9c8327786707026ecb
sev-
sev at scummvm.org
Sun Oct 4 16:25:55 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:
ec24687ce4 DOXYGEN: Add doxygen groups to header files in the common folder
Commit: ec24687ce4100ca6c9477c9c8327786707026ecb
https://github.com/scummvm/scummvm/commit/ec24687ce4100ca6c9477c9c8327786707026ecb
Author: Bartosz Gentkowski (bartosz.gentkowski at nordicsemi.no)
Date: 2020-10-04T18:25:50+02:00
Commit Message:
DOXYGEN: Add doxygen groups to header files in the common folder
Adding @defgroup and @ingroup doxygen tags into all headers
in the common folder that contain doxygen blocks.
This improves the structure, readability, and findability
of information in the resulting output.
This commit targets purely structure and does not deal with
the content of the currently existing doxygen documentation.
Changed paths:
common/achievements.h
common/algorithm.h
common/archive.h
common/array.h
common/bitstream.h
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
common/dialogs.h
common/encoding.h
common/endian.h
common/error.h
common/events.h
common/fft.h
common/file.h
common/frac.h
common/fs.h
common/func.h
common/gui_options.h
common/hash-ptr.h
common/hashmap.h
common/huffman.h
common/iff_container.h
common/ini-file.h
common/installshield_cab.h
common/keyboard.h
common/language.h
common/list.h
common/localization.h
common/lua/double_serialization.h
common/macresman.h
common/md5.h
common/memory.h
common/memorypool.h
common/memstream.h
common/mutex.h
common/noncopyable.h
common/osd_message_queue.h
common/platform.h
common/ptr.h
common/queue.h
common/quicktime.h
common/random.h
common/rational.h
common/rdft.h
common/rect.h
common/rendermode.h
common/safe-bool.h
common/savefile.h
common/serializer.h
common/sinetables.h
common/singleton.h
common/stack.h
common/str-array.h
common/str.h
common/stream.h
common/substream.h
common/system.h
common/taskbar.h
common/text-to-speech.h
common/textconsole.h
common/timer.h
common/tokenizer.h
common/translation.h
common/unarj.h
common/unzip.h
common/updates.h
common/ustr.h
common/util.h
common/winexe.h
common/winexe_ne.h
common/winexe_pe.h
common/xmlparser.h
common/zlib.h
diff --git a/common/achievements.h b/common/achievements.h
index 550aecd8e4..0355374ed8 100644
--- a/common/achievements.h
+++ b/common/achievements.h
@@ -30,6 +30,15 @@
namespace Common {
+/**
+ * @defgroup common_achieve Achievements
+ * @ingroup common
+ *
+ * @brief API related to in-game achievements.
+ *
+ * @{
+ */
+
/**
* List of game achievements provider platforms.
* Possible candidates are XBOX Gamerscore, PSN Trophies, Kongregate Badges, etc...
@@ -96,6 +105,7 @@ private:
/** Shortcut for accessing the achievements manager. */
#define AchMan Common::AchievementsManager::instance()
+/** @} */
} // End of namespace Common
diff --git a/common/algorithm.h b/common/algorithm.h
index 1aac0376db..5e669e7e11 100644
--- a/common/algorithm.h
+++ b/common/algorithm.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_alg Algorithms
+ * @ingroup common
+ *
+ * @brief Templates for algorithms used to manipulate data.
+ *
+ * @{
+ */
+
/**
* Copies data from the range [first, last) to [dst, dst + (last - first)).
* It requires the range [dst, dst + (last - first)) to be valid.
@@ -308,5 +317,9 @@ void replace(It begin, It end, const Dat &original, const Dat &replaced) {
}
}
+/** @} */
+
+
} // End of namespace Common
+
#endif
diff --git a/common/archive.h b/common/archive.h
index 2cf7555371..c7a0f731f7 100644
--- a/common/archive.h
+++ b/common/archive.h
@@ -30,6 +30,18 @@
namespace Common {
+/**
+ * @defgroup common_arch Archive
+ * @ingroup common
+ *
+ * @brief The Archive module allows managing the member of arbitrary containers in a uniform
+ * fashion.
+ * It also supports looking up by names and file names, opening a file, and returning usable input stream.
+ *
+ * @{
+ */
+
+
class FSNode;
class SeekableReadStream;
@@ -276,6 +288,8 @@ private:
/** Shortcut for accessing the search manager. */
#define SearchMan Common::SearchManager::instance()
+/** @} */
+
} // namespace Common
#endif
diff --git a/common/array.h b/common/array.h
index 96e1ca270b..191febf3c3 100644
--- a/common/array.h
+++ b/common/array.h
@@ -34,6 +34,16 @@
namespace Common {
+/**
+ * @defgroup common_array Arrays
+ * @ingroup common
+ *
+ * @brief Functions for working on arrays.
+ *
+ * @{
+ */
+
+
/**
* This class implements a dynamically sized container, which
* can be accessed similar to a regular C++ array. Accessing
@@ -498,6 +508,8 @@ private:
Comparator _comparator;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/bitstream.h b/common/bitstream.h
index 81976efdc8..775a83abaa 100644
--- a/common/bitstream.h
+++ b/common/bitstream.h
@@ -33,6 +33,15 @@
namespace Common {
+/**
+ * @defgroup common_bitstream Bit stream
+ * @ingroup common
+ *
+ * @brief API for implementing a bit stream.
+ *
+ * @{
+ */
+
/**
* A template implementing a bit stream for different data memory layouts.
*
@@ -470,6 +479,7 @@ typedef BitStreamImpl<BitStreamMemoryStream, 32, false, true > BitStreamMemory32
/** 32-bit big-endian data, LSB to MSB. */
typedef BitStreamImpl<BitStreamMemoryStream, 32, false, false> BitStreamMemory32BELSB;
+/** @} */
} // End of namespace Common
diff --git a/common/bufferedstream.h b/common/bufferedstream.h
index bbd25722a8..94117276bc 100644
--- a/common/bufferedstream.h
+++ b/common/bufferedstream.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_buffstream Buffered stream
+ * @ingroup common
+ *
+ * @brief API for implementing a buffered stream.
+ *
+ * @{
+ */
+
/**
* Take an arbitrary ReadStream and wrap it in a custom stream which
* transparently provides buffering.
@@ -61,6 +70,8 @@ SeekableReadStream *wrapBufferedSeekableReadStream(SeekableReadStream *parentStr
*/
WriteStream *wrapBufferedWriteStream(WriteStream *parentStream, uint32 bufSize);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/callback.h b/common/callback.h
index c6c249a511..c1ada14c34 100644
--- a/common/callback.h
+++ b/common/callback.h
@@ -25,6 +25,15 @@
namespace Common {
+/**
+ * @defgroup common_callback Callbacks
+ * @ingroup common
+ *
+ * @brief Callback templates.
+ *
+ * @{
+ */
+
/**
* BaseCallback<S> is a simple base class for object-oriented callbacks.
*
@@ -133,6 +142,8 @@ public:
void operator()(S data) { (_object->*_method)(_outerCallback, data); }
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/config-manager.h b/common/config-manager.h
index 0295abf170..f2cfd7b145 100644
--- a/common/config-manager.h
+++ b/common/config-manager.h
@@ -31,6 +31,16 @@
namespace Common {
+/**
+ * @defgroup common_config Configuration manager
+ * @ingroup common
+ *
+ * @brief The (singleton) configuration manager, used to query & set configuration
+ * values using string keys.
+ *
+ * @{
+ */
+
class WriteStream;
class SeekableReadStream;
@@ -207,6 +217,8 @@ private:
String _filename;
};
+/** @} */
+
} // End of namespace Common
/** Shortcut for accessing the configuration manager. */
diff --git a/common/coroutines.h b/common/coroutines.h
index 10e0bb28da..68f0fa692d 100644
--- a/common/coroutines.h
+++ b/common/coroutines.h
@@ -31,14 +31,16 @@
namespace Common {
/**
- * @defgroup Coroutine support for simulating multi-threading.
+ * @defgroup common_coroutine Coroutine support for simulating multi-threading
+ * @ingroup common
*
- * The following is loosely based on an article by Simon Tatham:
- * <http://www.chiark.greenend.org.uk/~sgtatham/coroutines.html>.
- * However, many improvements and tweaks have been made, in particular
- * by taking advantage of C++ features not available in C.
+ * @brief The following implementation is loosely based on an article by Simon Tatham:
+ * @linkCoroutine.
+ * However, many improvements and tweaks have been made, in particular
+ * by taking advantage of C++ features not available in C.
+ *
+ * @{
*/
-//@{
#define CoroScheduler (Common::CoroutineScheduler::instance())
@@ -555,7 +557,7 @@ public:
void pulseEvent(uint32 pidEvent);
};
-//@}
+/** @} */
} // end of namespace Common
diff --git a/common/cosinetables.h b/common/cosinetables.h
index 65cfc2e6b9..d790c757ad 100644
--- a/common/cosinetables.h
+++ b/common/cosinetables.h
@@ -25,6 +25,15 @@
namespace Common {
+/**
+ * @defgroup common_cosinetables Cosine tables
+ * @ingroup common
+ *
+ * @brief Functions for working with cosine tables.
+ *
+ * @{
+ */
+
class CosineTable {
public:
/**
@@ -69,6 +78,8 @@ private:
int _nPoints; // range of operator[]
};
+/** @} */
+
} // End of namespace Common
#endif // COMMON_COSINETABLES_H
diff --git a/common/dcl.h b/common/dcl.h
index ade7ebd985..fa7b95d6be 100644
--- a/common/dcl.h
+++ b/common/dcl.h
@@ -21,12 +21,8 @@
*/
/**
- * @file
- * PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
- * - agos (exclusively for Simon 2 setup.shr file)
- * - mohawk
- * - neverhood
- * - sci
+ *
+
*/
#ifndef COMMON_DCL_H
@@ -36,6 +32,21 @@
namespace Common {
+/**
+ * @defgroup common_dcl Data compression library
+ * @ingroup common
+ *
+ * @brief PKWARE data compression library.
+ *
+ * @details PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
+ * - agos (exclusively for Simon 2 setup.shr file)
+ * - mohawk
+ * - neverhood
+ * - sci
+ *
+ * @{
+ */
+
class ReadStream;
class SeekableReadStream;
@@ -57,6 +68,8 @@ SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream, uint32 packe
*/
SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/dct.h b/common/dct.h
index 882856a8a9..c8d025d517 100644
--- a/common/dct.h
+++ b/common/dct.h
@@ -37,6 +37,15 @@
namespace Common {
+/**
+ * @defgroup common_dct Discrete Cosine Transforms
+ * @ingroup common
+ *
+ * @brief Discrete Cosine Transforms.
+ *
+ * @{
+ */
+
/**
* (Inverse) Discrete Cosine Transforms.
*
@@ -74,6 +83,8 @@ private:
void calcDSTI (float *data);
};
+/** @} */
+
} // End of namespace Common
#endif // COMMON_DCT_H
diff --git a/common/debug-channels.h b/common/debug-channels.h
index a2df35102f..2cef6b40be 100644
--- a/common/debug-channels.h
+++ b/common/debug-channels.h
@@ -34,6 +34,15 @@
namespace Common {
+/**
+ * @defgroup common_debug_channels Debug channels
+ * @ingroup common_debug
+ *
+ * @brief Functions for managing debug channels.
+ *
+ * @{
+ */
+
// TODO: Find a better name for this
class DebugManager : public Singleton<DebugManager> {
public:
@@ -148,6 +157,8 @@ private:
/** Shortcut for accessing the debug manager. */
#define DebugMan Common::DebugManager::instance()
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/debug.h b/common/debug.h
index 5ec37f2f1e..7beef8acb0 100644
--- a/common/debug.h
+++ b/common/debug.h
@@ -38,6 +38,14 @@ inline void debugCN(uint32 debugChannels, const char *s, ...) {}
#else
+/**
+ * @defgroup common_debug Debug functions
+ * @ingroup common
+ *
+ * @brief Debug functions.
+ *
+ * @{
+ */
/**
* Print a debug message to the text console (stdout).
@@ -144,4 +152,6 @@ enum GlobalDebugLevels {
kDebugLevelEventRec = 1 << 30
};
+/** @} */
+
#endif
diff --git a/common/dialogs.h b/common/dialogs.h
index fd165e9ee2..083104d3b5 100644
--- a/common/dialogs.h
+++ b/common/dialogs.h
@@ -33,6 +33,15 @@
namespace Common {
+/**
+ * @defgroup common_dialogs Dialog Manager
+ * @ingroup common
+ *
+ * @brief The Dialog Manager allows GUI code to interact with native system dialogs.
+ *
+ * @{
+ */
+
/**
* The DialogManager allows GUI code to interact with native system dialogs.
*/
@@ -97,6 +106,8 @@ protected:
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/encoding.h b/common/encoding.h
index 503fbf5ab8..6d91bb3a46 100644
--- a/common/encoding.h
+++ b/common/encoding.h
@@ -30,6 +30,15 @@
namespace Common {
+/**
+ * @defgroup common_encoding Text encoding
+ * @ingroup common
+ *
+ * @brief Functions for managing text encoding.
+ *
+ * @{
+ */
+
/**
* A class, that allows conversion between different text encoding,
* the encodings available depend on the current backend and if the
@@ -221,6 +230,8 @@ class Encoding {
static uint32 *transliterateUTF32(const uint32 *string, size_t length);
};
+/** @} */
+
}
#endif // COMMON_ENCODING_H
diff --git a/common/endian.h b/common/endian.h
index fad9f3ccae..6ba2709b5e 100644
--- a/common/endian.h
+++ b/common/endian.h
@@ -25,10 +25,14 @@
#include "common/scummsys.h"
+
/**
- * \file endian.h
- * Endian conversion and byteswap conversion functions or macros
+ * @defgroup common_endian Endian conversions
+ * @ingroup common
+ *
+ * @brief Endian conversion and byteswap conversion functions and macros.
*
+ * @details
* SWAP_BYTES_??(a) - inverse byte order
* SWAP_CONSTANT_??(a) - inverse byte order, implemented as macro.
* Use with compiletime-constants only, the result will be a compiletime-constant aswell.
@@ -42,6 +46,8 @@
* CONSTANT_??_??(a) - convert LE/BE value v to native, implemented as macro.
* Use with compiletime-constants only, the result will be a compiletime-constant aswell.
* Unlike most other functions these can be used for eg. switch-case labels
+ *
+ * @{
*/
// Sanity check
@@ -632,4 +638,6 @@ inline void WRITE_BE_INT32(void *ptr, int32 value) {
WRITE_BE_UINT32(ptr, static_cast<uint32>(value));
}
+/** @} */
+
#endif
diff --git a/common/error.h b/common/error.h
index 90bc12ae67..4962c84ef7 100644
--- a/common/error.h
+++ b/common/error.h
@@ -28,11 +28,14 @@
namespace Common {
/**
- * This file contains an enum with commonly used error codes.
+ * @defgroup common_error Error codes
+ * @ingroup common
+ *
+ * @brief Commonly used error codes.
+ *
+ * @{
*/
-
-
/**
* Error codes which may be reported by plugins under various circumstances.
*
@@ -108,6 +111,8 @@ public:
ErrorCode getCode() const { return _code; }
};
+/** @} */
+
} // End of namespace Common
#endif //COMMON_ERROR_H
diff --git a/common/events.h b/common/events.h
index 35771a00c4..a7b1acaa40 100644
--- a/common/events.h
+++ b/common/events.h
@@ -34,14 +34,18 @@
namespace Common {
/**
- * The types of events backends may generate.
- * @see Event
+ * @defgroup common_events Events
+ * @ingroup common
+ *
+ * @brief The types of events backends may generate.
*
* @todo Merge EVENT_LBUTTONDOWN, EVENT_RBUTTONDOWN and EVENT_WHEELDOWN;
* likewise EVENT_LBUTTONUP, EVENT_RBUTTONUP, EVENT_WHEELUP.
* To do that, we just have to add a field to the Event which
* indicates which button was pressed.
+ * @{
*/
+
enum EventType {
EVENT_INVALID = 0,
/** A key was pressed, details in Event::kbd. */
@@ -548,6 +552,8 @@ protected:
*/
EventSource *makeKeyboardRepeatingEventSource(EventSource *eventSource);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/fft.h b/common/fft.h
index ed66d32b71..2a9f216650 100644
--- a/common/fft.h
+++ b/common/fft.h
@@ -34,10 +34,19 @@
namespace Common {
+/**
+ * @defgroup common_fft Fast Fourier Transform (FFT)
+ * @ingroup common
+ *
+ * @brief API for the FFT algorithm.
+ *
+ * @{
+ */
+
class CosineTable;
/**
- * (Inverse) Fast Fourier Transform.
+ * (Inverse) Fast Fourier Transform
*
* Used in engines:
* - scumm
@@ -80,6 +89,8 @@ private:
void fft(int n, int logn, Complex *z);
};
+/** @} */
+
} // End of namespace Common
#endif // COMMON_FFT_H
diff --git a/common/file.h b/common/file.h
index 2d5232abcc..e06f75d5ca 100644
--- a/common/file.h
+++ b/common/file.h
@@ -31,6 +31,15 @@
namespace Common {
+/**
+ * @defgroup common_files Files
+ * @ingroup common
+ *
+ * @brief API for operations on files.
+ *
+ * @{
+ */
+
class Archive;
/**
@@ -168,6 +177,8 @@ public:
virtual int32 size() const override;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/frac.h b/common/frac.h
index 4e3bcf267f..c6637b3bde 100644
--- a/common/frac.h
+++ b/common/frac.h
@@ -25,6 +25,15 @@
#include "common/scummsys.h"
+/**
+ * @defgroup common_frac Fixed-point fractions
+ * @ingroup common
+ *
+ * @brief API for fixed-point fractions.
+ *
+ * @{
+ */
+
/**
* The precision of the fractional (fixed point) type we define below.
* Normally you should never have to modify this value.
@@ -49,4 +58,6 @@ inline double fracToDouble(frac_t value) { return ((double)value) / FRAC_ONE; }
inline frac_t intToFrac(int16 value) { return value * (1 << FRAC_BITS); }
inline int16 fracToInt(frac_t value) { return value / (1 << FRAC_BITS); }
+/** @} */
+
#endif
diff --git a/common/fs.h b/common/fs.h
index 718f47ff56..e550bef34b 100644
--- a/common/fs.h
+++ b/common/fs.h
@@ -34,6 +34,15 @@ class AbstractFSNode;
namespace Common {
+/**
+ * @defgroup common_fs File system
+ * @ingroup common
+ *
+ * @brief API for operations on the file system.
+ *
+ * @{
+ */
+
class FSNode;
class SeekableReadStream;
class WriteStream;
@@ -371,6 +380,7 @@ public:
virtual SeekableReadStream *createReadStreamForMember(const String &name) const;
};
+/** @} */
} // End of namespace Common
diff --git a/common/func.h b/common/func.h
index b58474b2f3..3ffe78c934 100644
--- a/common/func.h
+++ b/common/func.h
@@ -27,6 +27,16 @@
namespace Common {
+/**
+ * @defgroup common_func Functions
+ * @ingroup common
+ *
+ * @brief API for managing functions.
+ *
+ * @{
+ */
+
+
/**
* Generic unary function.
*/
@@ -536,6 +546,8 @@ GENERATE_TRIVIAL_HASH_FUNCTOR(unsigned long);
#undef GENERATE_TRIVIAL_HASH_FUNCTOR
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/gui_options.h b/common/gui_options.h
index e07da2709c..4a10a8df89 100644
--- a/common/gui_options.h
+++ b/common/gui_options.h
@@ -95,6 +95,15 @@
namespace Common {
+/**
+ * @defgroup common_gui_options GUI options
+ * @ingroup common
+ *
+ * @brief API for managing the options of the graphical user interface (GUI).
+ *
+ * @{
+ */
+
class String;
bool checkGameGUIOption(const String &option, const String &str);
@@ -108,6 +117,7 @@ const String getGameGUIOptionsDescription(const String &options);
*/
void updateGameGUIOptions(const String &options, const String &langOption);
+/** @} */
} // End of namespace Common
diff --git a/common/hash-ptr.h b/common/hash-ptr.h
index 1099478c3b..d27cdf4118 100644
--- a/common/hash-ptr.h
+++ b/common/hash-ptr.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_hashmap_ptr Hash table pointer
+ * @ingroup common_hashmap
+ *
+ * @brief Template for a HashMap pointer.
+ *
+ * @{
+ */
+
/**
* Partial specialization of the Hash functor to be able to use pointers as HashMap keys
*/
@@ -38,6 +47,8 @@ struct Hash<T *> {
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/hashmap.h b/common/hashmap.h
index 861f055662..804f179da9 100644
--- a/common/hashmap.h
+++ b/common/hashmap.h
@@ -57,6 +57,15 @@
namespace Common {
+/**
+ * @defgroup common_hashmap Hash table (HashMap)
+ * @ingroup common
+ *
+ * @brief API for operations on a hash table.
+ *
+ * @{
+ */
+
// The sgi IRIX MIPSpro Compiler has difficulties with nested templates.
// This and the other __sgi conditionals below work around these problems.
// The Intel C++ Compiler suffers from the same problems.
@@ -624,6 +633,8 @@ void HashMap<Key, Val, HashFunc, EqualFunc>::erase(const Key &key) {
#undef HASHMAP_DUMMY_NODE
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/huffman.h b/common/huffman.h
index 052c7bf825..d98d90cc73 100644
--- a/common/huffman.h
+++ b/common/huffman.h
@@ -31,6 +31,18 @@
namespace Common {
+/**
+ * @defgroup common_huffmann Huffman bitstream decoding
+ * @ingroup common
+ *
+ * @brief API for operations related to Huffman bitstream decoding.
+ *
+ * @details Used in engines:
+ * - scumm
+ *
+ * @{
+ */
+
inline uint32 REVERSEBITS(uint32 x) {
x = (((x & ~0x55555555) >> 1) | ((x & 0x55555555) << 1));
x = (((x & ~0x33333333) >> 2) | ((x & 0x33333333) << 2));
@@ -43,8 +55,6 @@ inline uint32 REVERSEBITS(uint32 x) {
/**
* Huffman bitstream decoding
*
- * Used in engines:
- * - scumm
*/
template<class BITSTREAM>
class Huffman {
@@ -159,6 +169,8 @@ uint32 Huffman<BITSTREAM>::getSymbol(BITSTREAM &bits) const {
return 0;
}
+/** @} */
+
} // End of namespace Common
#endif // COMMON_HUFFMAN_H
diff --git a/common/iff_container.h b/common/iff_container.h
index a88b159733..83bb62ac74 100644
--- a/common/iff_container.h
+++ b/common/iff_container.h
@@ -31,6 +31,16 @@
namespace Common {
+/**
+ * @defgroup common_iff Interchange File Format (IFF)
+ * @ingroup common
+ *
+ * @brief API for operations on IFF container files.
+ *
+ *
+ * @{
+ */
+
typedef uint32 IFF_ID;
#define ID_FORM MKTAG('F','O','R','M')
@@ -265,6 +275,8 @@ public:
uint32 read(void *dataPtr, uint32 dataSize);
};
+/** @} */
+
} // namespace Common
#endif
diff --git a/common/ini-file.h b/common/ini-file.h
index f84ca6009c..4b66936ac0 100644
--- a/common/ini-file.h
+++ b/common/ini-file.h
@@ -29,6 +29,16 @@
namespace Common {
+/**
+ * @defgroup common_ini_file INI files
+ * @ingroup common
+ *
+ * @brief API for operations on INI configuration files.
+ *
+ *
+ * @{
+ */
+
class SeekableReadStream;
class WriteStream;
@@ -128,6 +138,8 @@ private:
const Section *getSection(const String §ion) const;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/installshield_cab.h b/common/installshield_cab.h
index d3c584815e..af2699a70b 100644
--- a/common/installshield_cab.h
+++ b/common/installshield_cab.h
@@ -27,6 +27,16 @@
namespace Common {
+/**
+ * @defgroup common_installshield InstallShield
+ * @ingroup common
+ *
+ * @brief API for managing the InstallShield.
+ *
+ *
+ * @{
+ */
+
class Archive;
class SeekableReadStream;
@@ -38,6 +48,8 @@ class SeekableReadStream;
*/
Archive *makeInstallShieldArchive(SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/keyboard.h b/common/keyboard.h
index fae2555286..b06a309bae 100644
--- a/common/keyboard.h
+++ b/common/keyboard.h
@@ -36,6 +36,16 @@
namespace Common {
+/**
+ * @defgroup common_keyboard Keyboard
+ * @ingroup common
+ *
+ * @brief API for keyboard operations.
+ *
+ *
+ * @{
+ */
+
enum KeyCode {
KEYCODE_INVALID = 0,
@@ -356,6 +366,8 @@ struct KeyState {
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/language.h b/common/language.h
index 8c7369a8a3..e787fe79f1 100644
--- a/common/language.h
+++ b/common/language.h
@@ -27,6 +27,16 @@
namespace Common {
+/**
+ * @defgroup common_language Language
+ * @ingroup common
+ *
+ * @brief API for managing game language.
+ *
+ *
+ * @{
+ */
+
class String;
/**
@@ -93,6 +103,8 @@ const String getGameGUIOptionsDescriptionLanguage(Common::Language lang);
// TODO: Document this GUIO related function
bool checkGameGUIOptionLanguage(Common::Language lang, const String &str);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/list.h b/common/list.h
index 31cf161d22..f889dbc9cb 100644
--- a/common/list.h
+++ b/common/list.h
@@ -27,6 +27,16 @@
namespace Common {
+/**
+ * @defgroup common_list Lists
+ * @ingroup common
+ *
+ * @brief API and templates for managing lists.
+ *
+ *
+ * @{
+ */
+
/**
* Simple double linked list, modeled after the list template of the standard
* C++ library.
@@ -255,6 +265,8 @@ protected:
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/localization.h b/common/localization.h
index 51803279e7..f5c63a2db7 100644
--- a/common/localization.h
+++ b/common/localization.h
@@ -28,6 +28,16 @@
namespace Common {
+/**
+ * @defgroup common_localization Localization
+ * @ingroup common
+ *
+ * @brief Functions for managing localized elements of the GUI.
+ *
+ *
+ * @{
+ */
+
/**
* Get localized equivalents for Y/N buttons of the specified language. In
* case there is no specialized keys for the given language it will fall back
@@ -48,6 +58,8 @@ void getLanguageYesNo(Language id, KeyCode &keyYes, KeyCode &keyNo);
*/
void getLanguageYesNo(KeyCode &keyYes, KeyCode &keyNo);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/lua/double_serialization.h b/common/lua/double_serialization.h
index 426a7f047d..e51195bc09 100644
--- a/common/lua/double_serialization.h
+++ b/common/lua/double_serialization.h
@@ -25,6 +25,14 @@
#include "common/types.h"
+/**
+ * @defgroup lua_ds Double serialization
+ * @ingroup lua
+ *
+ * @brief Functions for encoding and decoding double values.
+ *
+ * @{
+ */
namespace Util {
@@ -58,4 +66,6 @@ double decodeDouble(SerializedDouble value);
} // End of namespace Util
+/** @} */
+
#endif
diff --git a/common/macresman.h b/common/macresman.h
index 6ac831fe2e..5ab2b4d6b7 100644
--- a/common/macresman.h
+++ b/common/macresman.h
@@ -22,12 +22,7 @@
/**
* @file
- * Macintosh resource fork manager used in engines:
- * - groovie
- * - mohawk
- * - pegasus
- * - sci
- * - scumm
+
*/
#include "common/array.h"
@@ -40,6 +35,21 @@
namespace Common {
+/**
+ * @defgroup common_macresman Macintosh resource fork manager
+ * @ingroup common
+ *
+ * @brief API for Macintosh resource fork manager.
+ *
+ * @details Used in engines:
+ * - groovie
+ * - mohawk
+ * - pegasus
+ * - sci
+ * - scumm
+ * @{
+ */
+
typedef Array<uint16> MacResIDArray;
typedef Array<uint32> MacResTagArray;
@@ -282,6 +292,8 @@ private:
ResPtr *_resLists;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/md5.h b/common/md5.h
index 640326efe7..62562b6063 100644
--- a/common/md5.h
+++ b/common/md5.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_md5 MD5 checksum
+ * @ingroup common
+ *
+ * @brief API for computing the MD5 checksum.
+ *
+ * @{
+ */
+
class ReadStream;
class String;
@@ -54,6 +63,8 @@ bool computeStreamMD5(ReadStream &stream, uint8 digest[16], uint32 length = 0);
*/
String computeStreamMD5AsString(ReadStream &stream, uint32 length = 0);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/memory.h b/common/memory.h
index 91a320080b..bdd521a17a 100644
--- a/common/memory.h
+++ b/common/memory.h
@@ -27,6 +27,14 @@
namespace Common {
+/**
+ * @defgroup common_memory Memory
+ * @ingroup common
+ *
+ * @brief Functions for managing the memory.
+ * @{
+ */
+
/**
* Copies data from the range [first, last) to [dst, dst + (last - first)).
* It requires the range [dst, dst + (last - first)) to be valid and
@@ -61,6 +69,8 @@ void uninitialized_fill_n(Type *dst, size_t n, const Value &x) {
new ((void *)dst++) Type(x);
}
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/memorypool.h b/common/memorypool.h
index b84012232c..6567dbe59c 100644
--- a/common/memorypool.h
+++ b/common/memorypool.h
@@ -29,6 +29,14 @@
namespace Common {
+/**
+ * @defgroup common_memory_pool Memory pool
+ * @ingroup common_memory
+ *
+ * @brief API for managing the memory pool.
+ * @{
+ */
+
/**
* This class provides a pool of memory 'chunks' of identical size.
* The size of a chunk is determined when creating the memory pool.
@@ -141,6 +149,8 @@ public:
}
};
+/** @} */
+
} // End of namespace Common
/**
diff --git a/common/memstream.h b/common/memstream.h
index 9452e4f24b..5bfd7f0811 100644
--- a/common/memstream.h
+++ b/common/memstream.h
@@ -29,6 +29,14 @@
namespace Common {
+/**
+ * @defgroup common_memory_pool Memory stream
+ * @ingroup common_memory
+ *
+ * @brief API for managing the memory stream.
+ * @{
+ */
+
/**
* Simple memory based 'stream', which implements the ReadStream interface for
* a plain memory block.
@@ -334,6 +342,8 @@ public:
byte *getData() { return _data; }
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/mutex.h b/common/mutex.h
index 1b52bb40dd..3c64b0214c 100644
--- a/common/mutex.h
+++ b/common/mutex.h
@@ -28,6 +28,14 @@
namespace Common {
+/**
+ * @defgroup common_mutex Mutex
+ * @ingroup common
+ *
+ * @brief API for managing the mutex.
+ * @{
+ */
+
class Mutex;
/**
@@ -62,6 +70,7 @@ public:
void unlock();
};
+/** @} */
} // End of namespace Common
diff --git a/common/noncopyable.h b/common/noncopyable.h
index 24021f42a6..8ab24e6728 100644
--- a/common/noncopyable.h
+++ b/common/noncopyable.h
@@ -25,6 +25,14 @@
namespace Common {
+/**
+ * @defgroup common_noncopy NonCopyable class
+ * @ingroup common
+ *
+ * @brief API for NonCopyable class.
+ * @{
+ */
+
/**
* Subclass of NonCopyable can not be copied due to the fact that
* we made the copy constructor and assigment operator private.
@@ -38,6 +46,8 @@ private:
NonCopyable& operator=(const NonCopyable&);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/osd_message_queue.h b/common/osd_message_queue.h
index 4da2f1d2e6..88dd89b185 100644
--- a/common/osd_message_queue.h
+++ b/common/osd_message_queue.h
@@ -32,6 +32,14 @@
namespace Common {
+/**
+ * @defgroup common_osd_message_queue OSD message queue
+ * @ingroup common
+ *
+ * @brief API for managing the queue of On Screen Display (OSD) messages.
+ * @{
+ */
+
/**
* Queue OSD messages from any thread to be displayed by the graphic thread.
*/
@@ -68,6 +76,8 @@ private:
uint32 _lastUpdate;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/platform.h b/common/platform.h
index bdf1772807..f9a3b8dedb 100644
--- a/common/platform.h
+++ b/common/platform.h
@@ -27,6 +27,14 @@
namespace Common {
+/**
+ * @defgroup common_platform Game platforms
+ * @ingroup common
+ *
+ * @brief API for managing game platforms.
+ * @{
+ */
+
class String;
/**
@@ -84,6 +92,8 @@ extern const char *getPlatformCode(Platform id);
extern const char *getPlatformAbbrev(Platform id);
extern const char *getPlatformDescription(Platform id);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/ptr.h b/common/ptr.h
index 565c9d8cee..cc247f12a6 100644
--- a/common/ptr.h
+++ b/common/ptr.h
@@ -30,6 +30,14 @@
namespace Common {
+/**
+ * @defgroup common_ptr Pointers
+ * @ingroup common
+ *
+ * @brief API and templates for pointers.
+ * @{
+ */
+
class SharedPtrDeletionInternal {
public:
virtual ~SharedPtrDeletionInternal() {}
@@ -329,6 +337,8 @@ private:
DisposeAfterUse::Flag _dispose;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/queue.h b/common/queue.h
index ee14d5b364..ed5f964f1b 100644
--- a/common/queue.h
+++ b/common/queue.h
@@ -28,6 +28,14 @@
namespace Common {
+/**
+ * @defgroup common_queue Queue
+ * @ingroup common
+ *
+ * @brief API and templates for queues.
+ * @{
+ */
+
/**
* Variable size Queue class, implemented using our List class.
*/
@@ -82,6 +90,8 @@ private:
List<T> _impl;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/quicktime.h b/common/quicktime.h
index 26fc44ac71..4d8af4db6f 100644
--- a/common/quicktime.h
+++ b/common/quicktime.h
@@ -41,13 +41,18 @@ namespace Common {
class MacResManager;
/**
- * Parser for QuickTime/MPEG-4 files.
+ * @defgroup common_quicktime Quicktime file parser
+ * @ingroup common
*
- * File parser used in engines:
- * - groovie
- * - mohawk
- * - sci
+ * @brief Parser for QuickTime/MPEG-4 files.
+ *
+ * @details File parser used in engines:
+ * - groovie
+ * - mohawk
+ * - sci
+ * @{
*/
+
class QuickTimeParser {
public:
QuickTimeParser();
@@ -211,6 +216,8 @@ private:
int readSMI(Atom atom);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/random.h b/common/random.h
index 48cde26dc5..29f648ecd2 100644
--- a/common/random.h
+++ b/common/random.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_rng RNG
+ * @ingroup common
+ *
+ * @brief Random number generator (RNG) implementation.
+ *
+ * @{
+ */
+
class String;
/**
@@ -75,6 +84,8 @@ public:
uint getRandomNumberRng(uint min, uint max);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/rational.h b/common/rational.h
index bd240c99f3..afa7c56a71 100644
--- a/common/rational.h
+++ b/common/rational.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_rational Rational class
+ * @ingroup common
+ *
+ * @brief API for rational class.
+ *
+ * @{
+ */
+
/** A simple rational class that holds fractions. */
class Rational {
public:
@@ -108,6 +117,8 @@ bool operator<(int left, const Rational &right);
bool operator>=(int left, const Rational &right);
bool operator<=(int left, const Rational &right);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/rdft.h b/common/rdft.h
index ae06c72ef8..f831698162 100644
--- a/common/rdft.h
+++ b/common/rdft.h
@@ -37,9 +37,18 @@
namespace Common {
/**
- * (Inverse) Real Discrete Fourier Transform.
+ * @defgroup common_rdft RDFT algorithm
+ * @ingroup common
*
- * Used in audio:
+ * @brief API for the Real Discrete Fourier Transform (RDFT) algorithm.
+ *
+ * @{
+ */
+
+/**
+ * @brief (Inverse) Real Discrete Fourier Transform.
+ *
+ * @details Used in audio:
* - QDM2
*
* Used in engines:
@@ -107,6 +116,8 @@ private:
FFT *_fft;
};
+/** @} */
+
} // End of namespace Common
#endif // COMMON_RDFT_H
diff --git a/common/rect.h b/common/rect.h
index 96fbe0cbf6..c6a066603e 100644
--- a/common/rect.h
+++ b/common/rect.h
@@ -31,6 +31,15 @@
namespace Common {
+/**
+ * @defgroup common_rect Rectangular zones
+ * @ingroup common
+ *
+ * @brief API for operations on rectangular zones.
+ *
+ * @{
+ */
+
/**
* Simple class for handling both 2D position and size.
*/
@@ -297,6 +306,8 @@ struct Rect {
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/rendermode.h b/common/rendermode.h
index ae1a7bc790..7432dcb5aa 100644
--- a/common/rendermode.h
+++ b/common/rendermode.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_rendermode Render modes
+ * @ingroup common
+ *
+ * @brief API for render modes.
+ *
+ * @{
+ */
+
class String;
/**
@@ -70,6 +79,7 @@ extern String renderMode2GUIO(RenderMode id);
// TODO: Rename the following to something better; also, document it
extern String allRenderModesGUIOs();
+/** @} */
} // End of namespace Common
diff --git a/common/safe-bool.h b/common/safe-bool.h
index 92c8af51aa..978040ece4 100644
--- a/common/safe-bool.h
+++ b/common/safe-bool.h
@@ -40,6 +40,15 @@ namespace Common {
};
}
+ /**
+ * @defgroup common_safe_bool Safe Boolean
+ * @ingroup common
+ *
+ * @brief Template for a SafeBool function.
+ *
+ * @{
+ */
+
/**
* Prevents `operator bool` from implicitly converting to other types.
*/
@@ -60,6 +69,7 @@ namespace Common {
&impl_t::stub : 0;
}
};
+ /** @} */
} // End of namespace Common
#endif
diff --git a/common/savefile.h b/common/savefile.h
index bc76de5659..8a1bd28553 100644
--- a/common/savefile.h
+++ b/common/savefile.h
@@ -31,6 +31,14 @@
namespace Common {
+/**
+ * @defgroup common_savefile Save files
+ * @ingroup common
+ *
+ * @brief API for managing save files.
+ *
+ * @{
+ */
/**
* A class which allows game engines to load game state data.
@@ -209,6 +217,8 @@ public:
virtual void updateSavefilesList(StringArray &lockedFiles) = 0;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/serializer.h b/common/serializer.h
index 18fb38563b..8478030759 100644
--- a/common/serializer.h
+++ b/common/serializer.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_serializer Serializer
+ * @ingroup common
+ *
+ * @brief API for serializing data.
+ *
+ * @{
+ */
+
#define VER(x) Common::Serializer::Version(x)
#define SYNC_AS(SUFFIX,TYPE,SIZE) \
@@ -280,6 +289,7 @@ public:
virtual void saveLoadWithSerializer(Serializer &ser) = 0;
};
+/** @} */
} // End of namespace Common
diff --git a/common/sinetables.h b/common/sinetables.h
index bd030ca833..321983ec0f 100644
--- a/common/sinetables.h
+++ b/common/sinetables.h
@@ -25,6 +25,15 @@
namespace Common {
+/**
+ * @defgroup common_sinetables Sine tables
+ * @ingroup common
+ *
+ * @brief API for managing sine tables.
+ *
+ * @{
+ */
+
class SineTable {
public:
/**
@@ -69,6 +78,8 @@ private:
int _nPoints; // range of operator[]
};
+/** @} */
+
} // End of namespace Common
#endif // COMMON_SINETABLES_H
diff --git a/common/singleton.h b/common/singleton.h
index 7deb1dd7dc..cc0b09400d 100644
--- a/common/singleton.h
+++ b/common/singleton.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_singleton Singleton
+ * @ingroup common
+ *
+ * @brief API for managing singletons.
+ *
+ * @{
+ */
+
/**
* Generic template base class for implementing the singleton design pattern.
*/
@@ -101,6 +110,8 @@ protected:
#define DECLARE_SINGLETON(T) \
template<> T *Singleton<T>::_singleton = 0
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/stack.h b/common/stack.h
index cba3fb124d..5ee7fad517 100644
--- a/common/stack.h
+++ b/common/stack.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_stack Stack
+ * @ingroup common
+ *
+ * @brief Fixed-size stack implementation.
+ *
+ * @{
+ */
+
/**
* Extremly simple fixed size stack class.
*/
@@ -140,6 +149,8 @@ public:
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/str-array.h b/common/str-array.h
index ecd10b459a..b069367479 100644
--- a/common/str-array.h
+++ b/common/str-array.h
@@ -29,12 +29,22 @@
namespace Common {
+/**
+ * @defgroup common_str_array String array
+ * @ingroup common_str
+ *
+ * @brief String array implementation.
+ *
+ * @{
+ */
+
/**
* An array of of strings.
*/
typedef Array<String> StringArray;
typedef Array<U32String> U32StringArray;
+/** @} */
} // End of namespace Common
diff --git a/common/str.h b/common/str.h
index ce1d79fa95..33c8aa29b7 100644
--- a/common/str.h
+++ b/common/str.h
@@ -31,6 +31,15 @@
namespace Common {
+/**
+ * @defgroup common_str Strings
+ * @ingroup common
+ *
+ * @brief API for working with strings.
+ *
+ * @{
+ */
+
class U32String;
/**
@@ -566,6 +575,8 @@ size_t strnlen(const char *src, size_t maxSize);
*/
String toPrintable(const String &src, bool keepNewLines = true);
+/** @} */
+
} // End of namespace Common
extern int scumm_stricmp(const char *s1, const char *s2);
diff --git a/common/stream.h b/common/stream.h
index 1da3cba560..1dafd84180 100644
--- a/common/stream.h
+++ b/common/stream.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_stream Streams
+ * @ingroup common
+ *
+ * @brief API for managing readable and writable data streams.
+ *
+ * @{
+ */
+
class ReadStream;
class SeekableReadStream;
@@ -714,6 +723,7 @@ public:
SeekableReadStreamEndian(bool bigEndian) : ReadStreamEndian(bigEndian) {}
};
+/** @} */
} // End of namespace Common
diff --git a/common/substream.h b/common/substream.h
index 8bc68cc8a9..01cecf1bb5 100644
--- a/common/substream.h
+++ b/common/substream.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_substream Substreams
+ * @ingroup common_stream
+ *
+ * @brief API for managing readable data substreams.
+ *
+ * @{
+ */
+
/**
* SubReadStream provides access to a ReadStream restricted to the range
* [currentPosition, currentPosition+end).
@@ -124,6 +133,7 @@ public:
virtual uint32 read(void *dataPtr, uint32 dataSize);
};
+/** @} */
} // End of namespace Common
diff --git a/common/system.h b/common/system.h
index 6ac9c77cf1..4510b229bf 100644
--- a/common/system.h
+++ b/common/system.h
@@ -68,6 +68,15 @@ class Encoding;
typedef Array<Keymap *> KeymapArray;
}
+/**
+ * @defgroup common_system System
+ * @ingroup common
+ *
+ * @brief Operating system related API.
+ *
+ * @{
+ */
+
class AudioCDManager;
class FilesystemFactory;
class PaletteManager;
@@ -1562,4 +1571,6 @@ protected:
/** The global OSystem instance. Initialized in main(). */
extern OSystem *g_system;
+/** @} */
+
#endif
diff --git a/common/taskbar.h b/common/taskbar.h
index d5e62087ba..cdcee74913 100644
--- a/common/taskbar.h
+++ b/common/taskbar.h
@@ -33,6 +33,15 @@
namespace Common {
+/**
+ * @defgroup common_taskbar Taskbar Manager
+ * @ingroup common
+ *
+ * @brief The TaskbarManager module allows for interaction with the ScummVM application icon.
+ *
+ * @{
+ */
+
/**
* The TaskbarManager allows interaction with the ScummVM application icon:
* - in the taskbar on Windows 7 and later
@@ -187,6 +196,8 @@ return (path); \
}
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/text-to-speech.h b/common/text-to-speech.h
index 041842aa85..e91ed87239 100644
--- a/common/text-to-speech.h
+++ b/common/text-to-speech.h
@@ -32,6 +32,15 @@
namespace Common {
+/**
+ * @defgroup common_text_speech Text-to-speech Manager
+ * @ingroup common
+ *
+ * @brief The TTS module allows for speech synthesis.
+ *
+ * @{
+ */
+
/**
* Text to speech voice class.
*/
@@ -340,6 +349,8 @@ protected:
virtual void updateVoices() {};
};
+/** @} */
+
} // End of namespace Common
#endif // USE_TTS
diff --git a/common/textconsole.h b/common/textconsole.h
index e7654dd7e5..6a6baa45ed 100644
--- a/common/textconsole.h
+++ b/common/textconsole.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_text_console Text console
+ * @ingroup common
+ *
+ * @brief Output formatter, typically used for debugging.
+ *
+ * @{
+ */
+
/**
* An output formatter takes a source string and 'decorates' it with
* extra information, storing the result in a destination buffer.
@@ -57,6 +66,8 @@ typedef void (*ErrorHandler)(const char *msg);
*/
void setErrorHandler(ErrorHandler handler);
+/** @} */
+
} // End of namespace Common
diff --git a/common/timer.h b/common/timer.h
index 2db163327d..d166289620 100644
--- a/common/timer.h
+++ b/common/timer.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_timer Timer
+ * @ingroup common
+ *
+ * @brief API for managing the timer.
+ *
+ * @{
+ */
+
class TimerManager : NonCopyable {
public:
typedef void (*TimerProc)(void *refCon);
@@ -57,6 +66,8 @@ public:
virtual void removeTimerProc(TimerProc proc) = 0;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/tokenizer.h b/common/tokenizer.h
index 82befbd4af..3dd0797aeb 100644
--- a/common/tokenizer.h
+++ b/common/tokenizer.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_tokenizer String tokenizer
+ * @ingroup common
+ *
+ * @brief String tokenizer for creating tokens out of parts of a string.
+ *
+ * @{
+ */
+
/**
* A simple non-optimized string tokenizer.
*
@@ -81,6 +90,9 @@ private:
U32String::const_iterator _tokenBegin; ///< Latest found token's begin iterator (Valid after a call to nextToken())
U32String::const_iterator _tokenEnd; ///< Latest found token's end iterator (Valid after a call to nextToken())
};
+
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/translation.h b/common/translation.h
index e910b36ac0..02ad825ad2 100644
--- a/common/translation.h
+++ b/common/translation.h
@@ -34,6 +34,15 @@
namespace Common {
+/**
+ * @defgroup common_translation Message translation manager
+ * @ingroup common
+ *
+ * @brief API related to translation.
+ *
+ * @{
+ */
+
class File;
enum TranslationIDs {
@@ -217,6 +226,8 @@ private:
int _currentLang;
};
+/** @} */
+
} // End of namespace Common
#define TransMan Common::TranslationManager::instance()
diff --git a/common/unarj.h b/common/unarj.h
index 2be514c936..743984127d 100644
--- a/common/unarj.h
+++ b/common/unarj.h
@@ -33,6 +33,15 @@
namespace Common {
+/**
+ * @defgroup common_unarj ARJ decompressor
+ * @ingroup common
+ *
+ * @brief API related to ARJ archive files.
+ *
+ * @{
+ */
+
class Archive;
/**
@@ -43,6 +52,8 @@ class Archive;
*/
Archive *makeArjArchive(const String &name);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/unzip.h b/common/unzip.h
index f249c5db19..51b3b18187 100644
--- a/common/unzip.h
+++ b/common/unzip.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_unzip ZIP decompressor
+ * @ingroup common
+ *
+ * @brief API related to ZIP archive files.
+ *
+ * @{
+ */
+
class Archive;
class FSNode;
class SeekableReadStream;
@@ -57,6 +66,8 @@ Archive *makeZipArchive(const FSNode &node);
*/
Archive *makeZipArchive(SeekableReadStream *stream);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/updates.h b/common/updates.h
index 1f1c190304..f671b7cb72 100644
--- a/common/updates.h
+++ b/common/updates.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_update Update Manager
+ * @ingroup common
+ *
+ * @brief The UpdateManager module allows for automatic update checking.
+ *
+ * @{
+ */
+
/**
* The UpdateManager allows configuring of the automatic update checking
* for systems that support it:
@@ -127,6 +136,8 @@ public:
static int normalizeInterval(int interval);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/ustr.h b/common/ustr.h
index 261894bdfd..db4d078717 100644
--- a/common/ustr.h
+++ b/common/ustr.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_ustr UTF-32 strings
+ * @ingroup common_str
+ *
+ * @brief API for working with UTF-32 strings.
+ *
+ * @{
+ */
+
class String;
class UnicodeBiDiText;
@@ -280,6 +289,9 @@ private:
};
U32String operator+(const U32String &x, const U32String &y);
+
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/util.h b/common/util.h
index 58d2b981d6..273d027318 100644
--- a/common/util.h
+++ b/common/util.h
@@ -26,6 +26,15 @@
#include "common/scummsys.h"
#include "common/str.h"
+/**
+ * @defgroup common_util Util
+ * @ingroup common
+ *
+ * @brief Various utility functions.
+ *
+ * @{
+ */
+
/**
* Check whether a given pointer is aligned correctly.
* Note that 'alignment' must be a power of two!
@@ -105,8 +114,15 @@ template<typename T, size_t N> inline void ARRAYCLEAR(T (&array) [N], const T &v
# define SCUMMVM_CURRENT_FUNCTION "<unknown>"
#endif
+/** @} */
+
namespace Common {
+/**
+ * @addtogroup common_util
+ * @{
+ */
+
/**
* Print a hexdump of the data passed in. The number of bytes per line is
* customizable.
@@ -252,6 +268,8 @@ bool isGraph(int c);
*/
Common::String getHumanReadableBytes(uint64 bytes, Common::String &unitsOut);
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/winexe.h b/common/winexe.h
index cab0867587..1bf203338a 100644
--- a/common/winexe.h
+++ b/common/winexe.h
@@ -28,6 +28,15 @@
namespace Common {
+/**
+ * @defgroup common_winexe Windows resources
+ * @ingroup common
+ *
+ * @brief API for managing Windows resources.
+ *
+ * @{
+ */
+
class SeekableReadStream;
/** The default Windows resources. */
@@ -136,6 +145,8 @@ public:
static VersionHash *parseVersionInfo(SeekableReadStream *stream);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/winexe_ne.h b/common/winexe_ne.h
index 118629abe1..85b42489c2 100644
--- a/common/winexe_ne.h
+++ b/common/winexe_ne.h
@@ -29,6 +29,15 @@
namespace Common {
+/**
+ * @defgroup common_winexe_ne Windows New Executable resources
+ * @ingroup common_winexe
+ *
+ * @brief API for managing Windows New Executable resources.
+ *
+ * @{
+ */
+
template<class T> class Array;
class SeekableReadStream;
@@ -90,6 +99,8 @@ private:
static String getResourceString(SeekableReadStream &exe, uint32 offset);
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/winexe_pe.h b/common/winexe_pe.h
index 79b913043a..67a34a3c7d 100644
--- a/common/winexe_pe.h
+++ b/common/winexe_pe.h
@@ -30,6 +30,15 @@
namespace Common {
+/**
+ * @defgroup common_winexe_ne Windows Portable Executable resources
+ * @ingroup common_winexe
+ *
+ * @brief API for managing Windows Portable Executable resources.
+ *
+ * @{
+ */
+
template<class T> class Array;
class SeekableReadStream;
@@ -92,6 +101,8 @@ private:
TypeMap _resources;
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/xmlparser.h b/common/xmlparser.h
index dbd9d0e0cb..f555e64cea 100644
--- a/common/xmlparser.h
+++ b/common/xmlparser.h
@@ -36,6 +36,15 @@
namespace Common {
+/**
+ * @defgroup common_xmlparser XML parser
+ * @ingroup common
+ *
+ * @brief The XML parser allows for parsing XML-like files.
+ *
+ * @{
+ */
+
class SeekableReadStream;
#define MAX_XML_DEPTH 8
@@ -349,6 +358,8 @@ private:
Stack<ParserNode *> _activeKey; /** Node stack of the parsed keys */
};
+/** @} */
+
} // End of namespace Common
#endif
diff --git a/common/zlib.h b/common/zlib.h
index a172399511..839c23ba17 100644
--- a/common/zlib.h
+++ b/common/zlib.h
@@ -27,6 +27,15 @@
namespace Common {
+/**
+ * @defgroup common_zlib zlib
+ * @ingroup common
+ *
+ * @brief API for zlib operations.
+ *
+ * @{
+ */
+
class SeekableReadStream;
class WriteStream;
@@ -145,6 +154,8 @@ SeekableReadStream *wrapCompressedReadStream(SeekableReadStream *toBeWrapped, ui
*/
WriteStream *wrapCompressedWriteStream(WriteStream *toBeWrapped);
+/** @} */
+
} // End of namespace Common
#endif
More information about the Scummvm-git-logs
mailing list