More doc updates.

This commit is contained in:
Jason Felds
2011-02-18 22:59:13 -05:00
parent 7539c2f97e
commit 9de60aa555
10 changed files with 156 additions and 139 deletions
+18 -5
View File
@@ -1,5 +1,3 @@
/* NotesLoader - Base class for step file loaders. */
#ifndef NOTES_LOADER_H
#define NOTES_LOADER_H
@@ -7,16 +5,31 @@
class Song;
/** @brief Base class for step file loaders. */
namespace NotesLoader
{
void GetMainAndSubTitlesFromFullTitle( const RString &sFullTitle, RString &sMainTitleOut, RString &sSubTitleOut );
/**
* @brief Identify the main and sub titles from a full title.
* @param sFullTitle the full title.
* @param sMainTitleOut the eventual main title.
* @param sSubTitleOut the ventual sub title. */
void GetMainAndSubTitlesFromFullTitle( const RString &sFullTitle,
RString &sMainTitleOut, RString &sSubTitleOut );
/**
* @brief Attempt to load a Song from the given directory.
* @param sPath the path to the file.
* @param out the Song in question.
* @param BlacklistedImages images to exclude (DWI files only for some reason).
* @return its success or failure. */
bool LoadFromDir( const RString &sPath, Song &out, set<RString> &BlacklistedImages );
}
#endif
/*
* (c) 2001-2003,2007 Chris Danford, Glenn Maynard, Steve Checkoway
/**
* @file
* @author Chris Danford, Glenn Maynard, Steve Checkoway (c) 2001-2003,2007
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a