actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix doxygen warnings.

Browse Source 
The code seems to run fine, but please TEST THIS.
Revert this if required.
This commit is contained in:
Jason Felds
2011-02-19 00:48:42 -05:00
parent 1bed6d3630
commit 2c70b65711
10 changed files with 48 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/MsdFile.h
+1 -1
View File
@@ -10,7 +10,7 @@ public:
/**
* @brief The list of params found in the files.
*
* Note that #param:param:param:param; is one whole value. */
* Note that #param:param:param:param; is one whole value. */
struct value_t
{
/** @brief The list of parameters. */
src/NoteData.cpp
+9 -14
View File
@@ -52,7 +52,7 @@ void NoteData::ClearRangeForTrack( int rowBegin, int rowEnd, int iTrack )
if( rowBegin == rowEnd )
return;
iterator begin, end;
NoteData::TrackMap::iterator begin, end;
GetTapNoteRangeInclusive( iTrack, rowBegin, rowEnd, begin, end );
if( begin != end && begin->first < rowBegin && begin->first + begin->second.iDuration > rowEnd )
@@ -86,7 +86,7 @@ void NoteData::ClearRangeForTrack( int rowBegin, int rowEnd, int iTrack )
if( begin != end )
{
iterator prev = end;
NoteData::TrackMap::iterator prev = end;
--prev;
TapNote tn = begin->second;
int iRow = prev->first;
@@ -138,7 +138,7 @@ void NoteData::CopyRange( const NoteData& from, int rowFromBegin, int rowFromEnd
for( int t=0; t<GetNumTracks(); t++ )
{
const_iterator begin, end;
NoteData::TrackMap::const_iterator begin, end;
from.GetTapNoteRangeInclusive( t, rowFromBegin, rowFromEnd, begin, end );
for( ; begin != end; ++begin )
{
@@ -307,7 +307,7 @@ void NoteData::AddHoldNote( int iTrack, int iStartRow, int iEndRow, TapNote tn )
ASSERT_M( iEndRow >= iStartRow, ssprintf("EndRow %d < StartRow %d",iEndRow,iStartRow) );
/* Include adjacent (non-overlapping) hold notes, since we need to merge with them. */
iterator begin, end;
NoteData::TrackMap::iterator begin, end;
GetTapNoteRangeInclusive( iTrack, iStartRow, iEndRow, begin, end, true );
// Look for other hold notes that overlap and merge them into add.
@@ -590,7 +590,7 @@ int NoteData::GetNumHoldNotes( int iStartIndex, int iEndIndex ) const
int iNumHolds = 0;
for( int t=0; t<GetNumTracks(); ++t )
{
const_iterator begin, end;
NoteData::TrackMap::const_iterator begin, end;
GetTapNoteRangeExclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
@@ -608,7 +608,7 @@ int NoteData::GetNumRolls( int iStartIndex, int iEndIndex ) const
int iNumRolls = 0;
for( int t=0; t<GetNumTracks(); ++t )
{
const_iterator begin, end;
NoteData::TrackMap::const_iterator begin, end;
GetTapNoteRangeExclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
@@ -641,7 +641,7 @@ int NoteData::GetNumMinefields( int iStartIndex, int iEndIndex ) const
int iNumMinefields = 0;
for( int t=0; t<GetNumTracks(); ++t )
{
const_iterator begin, end;
NoteData::TrackMap::const_iterator begin, end;
GetTapNoteRangeExclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
@@ -759,11 +759,6 @@ bool NoteData::GetPrevTapNoteRowForTrack( int track, int &rowInOut ) const
return true;
}
/* Return an iterator range for [rowBegin,rowEnd). This can be used to efficiently
* iterate trackwise over a range of notes. It's like FOREACH_NONEMPTY_ROW_IN_TRACK_RANGE,
* except it only requires two map searches (iterating is constant time), but the iterators will
* become invalid if the notes they represent disappear, so you need to pay attention to
* how you modify the data. */
void NoteData::GetTapNoteRange( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end )
{
ASSERT_M( iTrack < GetNumTracks(), ssprintf("%i,%i", iTrack, GetNumTracks()) );
@@ -794,7 +789,7 @@ void NoteData::GetTapNoteRange( int iTrack, int iStartRow, int iEndRow, TrackMap
/* Include hold notes that overlap the edges. If a hold note completely surrounds the given
* range, included it, too. If bIncludeAdjacent is true, also include hold notes adjacent to,
* but not overlapping, the edge. */
void NoteData::GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, iterator &begin, iterator &end, bool bIncludeAdjacent )
void NoteData::GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end, bool bIncludeAdjacent )
{
GetTapNoteRange( iTrack, iStartRow, iEndRow, begin, end );
@@ -827,7 +822,7 @@ void NoteData::GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow,
}
}
void NoteData::GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, iterator &begin, iterator &end )
void NoteData::GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end )
{
GetTapNoteRange( iTrack, iStartRow, iEndRow, begin, end );
src/NoteData.h
+25 -6
View File
@@ -115,8 +115,27 @@ public:
inline const_iterator FindTapNote( unsigned iTrack, int iRow ) const { return m_TapNotes[iTrack].find( iRow ); }
void RemoveTapNote( unsigned iTrack, iterator it ) { m_TapNotes[iTrack].erase( it ); }
/* Return an iterator range including exactly iStartRow to iEndRow. */
void GetTapNoteRange( int iTrack, int iStartRow, int iEndRow, const_iterator &begin, const_iterator &end ) const;
/**
* @brief Return an iterator range for [rowBegin,rowEnd).
*
* This can be used to efficiently iterate trackwise over a range of notes.
* It's like FOREACH_NONEMPTY_ROW_IN_TRACK_RANGE, except it only requires
* two map searches (iterating is constant time), but the iterators will
* become invalid if the notes they represent disappear, so you need to
* pay attention to how you modify the data.
* @param iTrack the column to use.
* @param iStartRow the starting point.
* @param iEndRow the ending point.
* @param begin the eventual beginning point of the range.
* @param end the eventual end point of the range. */
void GetTapNoteRange( int iTrack, int iStartRow, int iEndRow, TrackMap::const_iterator &begin, TrackMap::const_iterator &end ) const;
/**
* @brief Return a constant iterator range for [rowBegin,rowEnd).
* @param iTrack the column to use.
* @param iStartRow the starting point.
* @param iEndRow the ending point.
* @param begin the eventual beginning point of the range.
* @param end the eventual end point of the range. */
void GetTapNoteRange( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end );
all_tracks_iterator GetTapNoteRangeAllTracks( int iStartRow, int iEndRow, bool bInclusive = false )
{
@@ -137,13 +156,13 @@ public:
/* Return an iterator range include iStartRow to iEndRow. Extend the range to include
* hold notes overlapping the boundary. */
void GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, const_iterator &begin, const_iterator &end, bool bIncludeAdjacent=false ) const;
void GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, iterator &begin, iterator &end, bool bIncludeAdjacent=false );
void GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::const_iterator &begin, TrackMap::const_iterator &end, bool bIncludeAdjacent=false ) const;
void GetTapNoteRangeInclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end, bool bIncludeAdjacent=false );
/* Return an iterator range include iStartRow to iEndRow. Shrink the range to exclude
* hold notes overlapping the boundary. */
void GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, const_iterator &begin, const_iterator &end ) const;
void GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, iterator &begin, iterator &end );
void GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::const_iterator &begin, TrackMap::const_iterator &end ) const;
void GetTapNoteRangeExclusive( int iTrack, int iStartRow, int iEndRow, TrackMap::iterator &begin, TrackMap::iterator &end );
/* Returns the row of the first TapNote on the track that has a row greater than rowInOut. */
src/NoteDataUtil.cpp
+3 -3
View File
@@ -831,7 +831,7 @@ void NoteDataUtil::RemoveHoldNotes( NoteData &in, int iStartIndex, int iEndIndex
// turn all the HoldNotes into TapNotes
for( int t=0; t<in.GetNumTracks(); ++t )
{
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
in.GetTapNoteRangeInclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
@@ -847,7 +847,7 @@ void NoteDataUtil::ChangeRollsToHolds( NoteData &in, int iStartIndex, int iEndIn
{
for( int t=0; t<in.GetNumTracks(); ++t )
{
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
in.GetTapNoteRangeInclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
@@ -863,7 +863,7 @@ void NoteDataUtil::ChangeHoldsToRolls( NoteData &in, int iStartIndex, int iEndIn
{
for( int t=0; t<in.GetNumTracks(); ++t )
{
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
in.GetTapNoteRangeInclusive( t, iStartIndex, iEndIndex, begin, end );
for( ; begin != end; ++begin )
{
src/NotesLoaderMidi.cpp
+2 -2
View File
@@ -845,9 +845,9 @@ skip_track:
// on this row, then make the sustain note shorter so that it doesn't end on
// the same row as the tap note we're about to add. NoteData cannot handle a
// hold note ending on the same row as a tap note.
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
noteData.GetTapNoteRangeInclusive( nnt, MidiCountToNoteRow(count), MidiCountToNoteRow(count), begin, end, true );
for( NoteData::iterator iter = begin; iter != end; iter++ )
for( NoteData::TrackMap::iterator iter = begin; iter != end; iter++ )
{
// if( gd == expert && fBeat >= 27*4-2 && nnt == green )
// LOG->Trace( "shortening hold at %f, length %d", fBeat, length );
src/NotesWriterSM.h
+2 -2
View File
@@ -26,7 +26,7 @@ namespace NotesWriterSM
* @return the name of the edit file. */
RString GetEditFileName( const Song *pSong, const Steps *pSteps );
/**
* @param Write the edit file to the machine for future use.
* @brief Write the edit file to the machine for future use.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @param sErrorOut any error messages that may have occurred.
@@ -39,7 +39,7 @@ namespace NotesWriterSM
/**
* @file
* @author Chris Danford, Glenn Maynard (c) 2001-2004
* @seciton LICENSE
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
src/NotesWriterSSC.cpp
+1
View File
@@ -267,6 +267,7 @@ static RString JoinLineList( vector<RString> &lines )
* @brief Retrieve the individual batches of NoteData.
* @param song the Song in question.
* @param in the Steps in question.
* @param bSavingCache a flag to see if we're saving certain cache data.
* @return the NoteData in RString form. */
static RString GetSSCNoteData( const Song &song, const Steps &in, bool bSavingCache )
{
src/NotesWriterSSC.h
+1 -1
View File
@@ -28,7 +28,7 @@ namespace NotesWriterSSC
* @return the name of the edit file. */
RString GetEditFileName( const Song *pSong, const Steps *pSteps );
/**
* @param Write the edit file to the machine for future use.
* @brief Write the edit file to the machine for future use.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @param sErrorOut any error messages that may have occurred.
src/Player.cpp
+3 -3
View File
@@ -1668,7 +1668,7 @@ void Player::Fret( int col, int row, const RageTimer &tm, bool bHeld, bool bRele
// Since this is being called every frame, let's not check the whole array every time.
// Instead, only check 1 beat back. Even 1 is overkill.
const int iStartCheckingAt = max( 0, iSongRow-BeatToNoteRow(1) );
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
m_NoteData.GetTapNoteRangeInclusive( iTrack, iStartCheckingAt, iSongRow+1, begin, end );
for( ; begin != end; ++begin )
{
@@ -1756,7 +1756,7 @@ void Player::ScoreAllActiveHoldsLetGo()
// Since this is being called every frame, let's not check the whole array every time.
// Instead, only check 1 beat back. Even 1 is overkill.
const int iStartCheckingAt = max( 0, iSongRow-BeatToNoteRow(1) );
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
m_NoteData.GetTapNoteRangeInclusive( iTrack, iStartCheckingAt, iSongRow+1, begin, end );
for( ; begin != end; ++begin )
{
@@ -1807,7 +1807,7 @@ void Player::StepStrumHopo( int col, int row, const RageTimer &tm, bool bHeld, b
// Instead, only check 1 beat back. Even 1 is overkill.
// Just update the life here and let Update judge the roll.
const int iStartCheckingAt = max( 0, iSongRow-BeatToNoteRow(1) );
NoteData::iterator begin, end;
NoteData::TrackMap::iterator begin, end;
m_NoteData.GetTapNoteRangeInclusive( col, iStartCheckingAt, iSongRow+1, begin, end );
for( ; begin != end; ++begin )
{
src/ScoreDisplayLifeTime.h
+1 -1
View File
@@ -6,7 +6,7 @@
#include "AutoActor.h"
/**
* @breif Display a updating count of life time remaining.
* @brief Display a updating count of life time remaining.
*
* This is mainly used for Survival mode. */
class ScoreDisplayLifeTime : public ScoreDisplay