Update comments. Consistent naming.

TODO: Look into using NotesWriterSM in NotesWriterSSC
for common functionality.
This commit is contained in:
Jason Felds
2011-02-18 22:27:59 -05:00
parent 5e3165c855
commit 7539c2f97e
3 changed files with 50 additions and 8 deletions
+29 -4
View File
@@ -1,22 +1,47 @@
/* NotesWriterSSC - Writes a Song to an .SSC file. */
#ifndef NOTES_WRITER_SSC_H
#define NOTES_WRITER_SSC_H
class Song;
class Steps;
/** @brief Writes a Song to an .SSC file. */
namespace NotesWriterSSC
{
/**
* @brief Write the song out to a file.
* @param sPath the path to write the file.
* @param out the Song to be written out.
* @param vpStepsToSave the Steps to save.
* @param bSavingCache a flag to see if we're saving certain cache data.
* @return its success or failure. */
bool Write( RString sPath, const Song &out, const vector<Steps*>& vpStepsToSave, bool bSavingCache );
/**
* @brief Get some contents about the edit file first.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @param sOut the start of the file contents.
*/
void GetEditFileContents( const Song *pSong, const Steps *pSteps, RString &sOut );
/**
* @brief Get the name of the edit file to use.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @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.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @param sErrorOut any error messages that may have occurred.
* @return its success or failure. */
bool WriteEditFileToMachine( const Song *pSong, Steps *pSteps, RString &sErrorOut );
}
#endif
/*
* (c) 2011 Jason Felds
/**
* @file
* @author Jason Felds (c) 2011
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a