Document most of CString and MCString

There are only some "minor" functions that are still undocumented now.

This also sneaks in an API change: A useless file mode argument to
MCString::ReadFromDisk() is gone. Opening a file doesn't ask for a file mode.


git-svn-id: https://znc.svn.sourceforge.net/svnroot/znc/trunk@2157 726aef4b-f618-498e-8847-2d620e286838
This commit is contained in:
psychon
2010-10-11 14:24:36 +00:00
parent 9c2692f1f1
commit 4ffcdc4b55
3 changed files with 213 additions and 8 deletions
+3 -3
View File
@@ -1031,7 +1031,7 @@ bool CString::RightChomp(unsigned int uLen) {
}
//////////////// MCString ////////////////
int MCString::WriteToDisk(const CString& sPath, mode_t iMode) const {
MCString::status_t MCString::WriteToDisk(const CString& sPath, mode_t iMode) const {
CFile cFile(sPath);
if (this->empty()) {
@@ -1066,10 +1066,10 @@ int MCString::WriteToDisk(const CString& sPath, mode_t iMode) const {
return MCS_SUCCESS;
}
int MCString::ReadFromDisk(const CString& sPath, mode_t iMode) {
MCString::status_t MCString::ReadFromDisk(const CString& sPath) {
clear();
CFile cFile(sPath);
if (!cFile.Open(O_RDONLY, iMode)) {
if (!cFile.Open(O_RDONLY)) {
return MCS_EOPEN;
}