IOSystem: add missing documentation.
parent
e4510c26ba
commit
e9937ab0f7
|
@ -544,12 +544,10 @@ void ObjFileParser::getMaterialLib()
|
||||||
} else {
|
} else {
|
||||||
absName = strMatName;
|
absName = strMatName;
|
||||||
}
|
}
|
||||||
//IOStream *pFile = m_pIO->Open( strMatName );
|
|
||||||
IOStream *pFile = m_pIO->Open( absName );
|
IOStream *pFile = m_pIO->Open( absName );
|
||||||
|
|
||||||
if (!pFile )
|
if (!pFile ) {
|
||||||
{
|
DefaultLogger::get()->error( "OBJ: Unable to locate material file " + strMatName );
|
||||||
DefaultLogger::get()->error("OBJ: Unable to locate material file " + strMatName );
|
|
||||||
m_DataIt = skipLine<DataArrayIt>( m_DataIt, m_DataItEnd, m_uiLine );
|
m_DataIt = skipLine<DataArrayIt>( m_DataIt, m_DataItEnd, m_uiLine );
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
|
@ -105,18 +105,14 @@ public:
|
||||||
* @param pFile Path to the file
|
* @param pFile Path to the file
|
||||||
* @return true if there is a file with this path, else false.
|
* @return true if there is a file with this path, else false.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
virtual bool Exists( const char* pFile) const = 0;
|
virtual bool Exists( const char* pFile) const = 0;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// -------------------------------------------------------------------
|
// -------------------------------------------------------------------
|
||||||
/** @brief Returns the system specific directory separator
|
/** @brief Returns the system specific directory separator
|
||||||
* @return System specific directory separator
|
* @return System specific directory separator
|
||||||
*/
|
*/
|
||||||
virtual char getOsSeparator() const = 0;
|
virtual char getOsSeparator() const = 0;
|
||||||
|
|
||||||
|
|
||||||
// -------------------------------------------------------------------
|
// -------------------------------------------------------------------
|
||||||
/** @brief Open a new file with a given path.
|
/** @brief Open a new file with a given path.
|
||||||
*
|
*
|
||||||
|
@ -142,8 +138,6 @@ public:
|
||||||
inline IOStream* Open(const std::string& pFile,
|
inline IOStream* Open(const std::string& pFile,
|
||||||
const std::string& pMode = std::string("rb"));
|
const std::string& pMode = std::string("rb"));
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// -------------------------------------------------------------------
|
// -------------------------------------------------------------------
|
||||||
/** @brief Closes the given file and releases all resources
|
/** @brief Closes the given file and releases all resources
|
||||||
* associated with it.
|
* associated with it.
|
||||||
|
@ -174,9 +168,31 @@ public:
|
||||||
inline bool ComparePaths (const std::string& one,
|
inline bool ComparePaths (const std::string& one,
|
||||||
const std::string& second) const;
|
const std::string& second) const;
|
||||||
|
|
||||||
|
// -------------------------------------------------------------------
|
||||||
|
/** @brief Pushes a new directory onto the directory stack.
|
||||||
|
* @param path Path to push onto the stack.
|
||||||
|
* @return True, when push was successful, false if path is empty.
|
||||||
|
*/
|
||||||
virtual bool PushDirectory( const std::string &path );
|
virtual bool PushDirectory( const std::string &path );
|
||||||
|
|
||||||
|
// -------------------------------------------------------------------
|
||||||
|
/** @brief Returns the top directory from the stack.
|
||||||
|
* @return The directory on the top of the stack.
|
||||||
|
* Returns empty when no directory was pushed to the stack.
|
||||||
|
*/
|
||||||
virtual const std::string &CurrentDirectory() const;
|
virtual const std::string &CurrentDirectory() const;
|
||||||
|
|
||||||
|
// -------------------------------------------------------------------
|
||||||
|
/** @brief Returns the number of directories stored on the stack.
|
||||||
|
* @return The number of directories of the stack.
|
||||||
|
*/
|
||||||
virtual size_t StackSize() const;
|
virtual size_t StackSize() const;
|
||||||
|
|
||||||
|
// -------------------------------------------------------------------
|
||||||
|
/** @brief Pops the top directory from the stack.
|
||||||
|
* @return True, when a directory was on the stack. False if no
|
||||||
|
* directory was on the stack.
|
||||||
|
*/
|
||||||
virtual bool PopDirectory();
|
virtual bool PopDirectory();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|
Loading…
Reference in New Issue