NotesLoaderDWI mostly doxygen-ated.

This commit is contained in:
Jason Felds
2011-02-12 21:59:36 -05:00
parent e4f990d49a
commit dbe5df006d
2 changed files with 66 additions and 8 deletions
+18 -3
View File
@@ -1,4 +1,4 @@
/* DWILoader - reads a Song from a .DWI file. */
/** @brief DWILoader - reads a Song from a .DWI file. */
#ifndef NOTES_LOADER_DWI_H
#define NOTES_LOADER_DWI_H
@@ -7,16 +7,31 @@
class Song;
/** @brief The DWILoader handles parsing the .dwi file. */
namespace DWILoader
{
/**
* @brief Retrieve the list of .dwi files.
* @param sPath a const reference to the path on the hard drive to check.
* @param out a vector of files found in the path.
*/
void GetApplicableFiles( const RString &sPath, vector<RString> &out );
/**
* @brief Attempt to load a song from a specified path.
* @param sPath a const reference to the path on the hard drive to check.
* @param out a reference to the Song that will retrieve the song information.
* @param BlacklistedImages a set of images that aren't used.
* @return its success or failure.
*/
bool LoadFromDir( const RString &sPath, Song &out, set<RString> &BlacklistedImages );
}
#endif
/*
* (c) 2001-2004 Chris Danford, Glenn Maynard
/**
* @file
* @author Chris Danford, Glenn Maynard (c) 2001-2004
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a