aboutsummaryrefslogtreecommitdiff
path: root/sound/mods/tfmx.h
diff options
context:
space:
mode:
authorMax Horn2009-10-08 21:28:57 +0000
committerMax Horn2009-10-08 21:28:57 +0000
commit3399c3aeb638ae874557c72b4ab4db016ff152c8 (patch)
treef476b2a87837568da3bcdaf031f4eb61293f5086 /sound/mods/tfmx.h
parent2ab906bafd7e154bb9e333d7e76fe2a714478efd (diff)
downloadscummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.gz
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.bz2
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.zip
Change doxygen inline comments from "//!" to "///" as proposed on -devel
svn-id: r44802
Diffstat (limited to 'sound/mods/tfmx.h')
-rw-r--r--sound/mods/tfmx.h28
1 files changed, 14 insertions, 14 deletions
diff --git a/sound/mods/tfmx.h b/sound/mods/tfmx.h
index 26018d9466..8b66ea83fe 100644
--- a/sound/mods/tfmx.h
+++ b/sound/mods/tfmx.h
@@ -89,8 +89,8 @@ private:
enum { kNumVoices = 4, kNumChannels = 8, kNumSubsongs = 32, kMaxPatternOffsets = 128, kMaxMacroOffsets = 128 };
struct MdatResource {
- const byte *mdatAlloc; //!< allocated Block of Memory
- const byte *mdatData; //!< Start of mdat-File, might point before mdatAlloc to correct Offset
+ const byte *mdatAlloc; ///< allocated Block of Memory
+ const byte *mdatData; ///< Start of mdat-File, might point before mdatAlloc to correct Offset
uint32 mdatLen;
uint16 headerFlags;
@@ -98,16 +98,16 @@ private:
// char textField[6 * 40];
struct Subsong {
- uint16 songstart; //!< Index in Trackstep-Table
- uint16 songend; //!< Last index in Trackstep-Table
+ uint16 songstart; ///< Index in Trackstep-Table
+ uint16 songend; ///< Last index in Trackstep-Table
uint16 tempo;
} subsong[kNumSubsongs];
- uint32 trackstepOffset; //!< Offset in mdat
+ uint32 trackstepOffset; ///< Offset in mdat
uint32 sfxTableOffset;
- uint32 patternOffset[kMaxPatternOffsets]; //!< Offset in mdat
- uint32 macroOffset[kMaxMacroOffsets]; //!< Offset in mdat
+ uint32 patternOffset[kMaxPatternOffsets]; ///< Offset in mdat
+ uint32 macroOffset[kMaxMacroOffsets]; ///< Offset in mdat
void boundaryCheck(const void *address, size_t accessLen = 1) const {
assert(mdatAlloc <= address && (const byte *)address + accessLen <= (const byte *)mdatData + mdatLen);
@@ -115,7 +115,7 @@ private:
} const *_resource;
struct SampleResource {
- const int8 *sampleData; //!< The whole sample-File
+ const int8 *sampleData; ///< The whole sample-File
uint32 sampleLen;
void boundaryCheck(const void *address, size_t accessLen = 2) const {
@@ -140,7 +140,7 @@ private:
uint16 macroReturnStep;
uint8 macroLoopCount;
bool macroRun;
- int8 macroSfxRun; //!< values are the folowing: -1 macro disabled, 0 macro init, 1 macro running
+ int8 macroSfxRun; ///< values are the folowing: -1 macro disabled, 0 macro init, 1 macro running
uint32 customMacro;
uint8 customMacroIndex;
@@ -193,7 +193,7 @@ private:
uint8 command;
int8 expose;
uint8 loopCount;
- uint8 wait; //!< how many ticks to wait before next Command
+ uint8 wait; ///< how many ticks to wait before next Command
} _patternCtx[kNumChannels];
struct TrackStepContext {
@@ -204,12 +204,12 @@ private:
} _trackCtx;
struct PlayerContext {
- int8 song; //!< >= 0 if Song is running (means process Patterns)
+ int8 song; ///< >= 0 if Song is running (means process Patterns)
uint16 patternCount;
- uint16 patternSkip; //!< skip that amount of CIA-Interrupts
+ uint16 patternSkip; ///< skip that amount of CIA-Interrupts
- int8 volume; //!< Master Volume
+ int8 volume; ///< Master Volume
uint8 fadeSkip;
uint8 fadeCount;
@@ -221,7 +221,7 @@ private:
uint16 *signal;
uint16 numSignals;
- bool stopWithLastPattern; //!< hack to automatically stop the whole player if no Pattern is running
+ bool stopWithLastPattern; ///< hack to automatically stop the whole player if no Pattern is running
} _playerCtx;
const byte *getSfxPtr(uint16 index = 0) const {