Some more doxygen.

This commit is contained in:
Jason Felds
2011-02-18 21:47:52 -05:00
parent 26b9f7502f
commit 8cc38194b2
6 changed files with 65 additions and 22 deletions
+27 -4
View File
@@ -1,22 +1,45 @@
/* NotesWriterSM - Writes a Song to an .SM file. */
#ifndef NOTES_WRITER_SM_H
#define NOTES_WRITER_SM_H
class Song;
class Steps;
/** @brief Writes a Song to an .SM file. */
namespace NotesWriterSM
{
/**
* @brief Write the song out to a file.
* @param sPath the path to write the file.
* @param out the Song to be written out.
* @return its success or failure. */
bool Write( RString sPath, const Song &out );
/**
* @brief Get some contents about the edit file first.
* @param pSong the Song in question.
* @param pSteps the Steps in question.
* @param sOut unused?
*/
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) 2001-2004 Chris Danford, Glenn Maynard
/**
* @file
* @author Chris Danford, Glenn Maynard (c) 2001-2004
* @seciton LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a