Move platform::rmdir docstring to right location
This commit is contained in:
@ -277,19 +277,19 @@ namespace platform {
|
||||
int mkdir(const std::string &path);
|
||||
|
||||
/*! Delete a directory
|
||||
*
|
||||
* \param path directory path
|
||||
* \return -1 if unsuccessful, otherwise >= 0 */
|
||||
|
||||
int rmdir(const std::string &path);
|
||||
|
||||
/*! Delete a directory and its contents
|
||||
*
|
||||
* Unlike the the ``rmdir()`` or ``_rmdir()`` function of the
|
||||
* C library, this function will check for the contents of the
|
||||
* folder and recurse into any sub-folders, if necessary and
|
||||
* delete all contained folders and their contents before
|
||||
* deleting the folder *path*.
|
||||
*
|
||||
* \param path directory path
|
||||
* \return -1 if unsuccessful, otherwise >= 0 */
|
||||
|
||||
int rmdir(const std::string &path);
|
||||
|
||||
/*! Delete a file
|
||||
*
|
||||
* \param path path to file to be deleted
|
||||
* \return 0 on success, -1 on error */
|
||||
|
||||
Reference in New Issue
Block a user