From c15bc1512162d323b893aeab85f78e3407dff7de Mon Sep 17 00:00:00 2001 From: madmaxoft Date: Sat, 26 Oct 2013 10:33:28 +0200 Subject: cIniFile: Improved doxy-comments. --- iniFile/iniFile.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/iniFile/iniFile.h b/iniFile/iniFile.h index 223e0237f..83d961fc6 100644 --- a/iniFile/iniFile.h +++ b/iniFile/iniFile.h @@ -153,19 +153,19 @@ public: // Header comment functions. // Header comments are those comments before the first key. - /// Get number of header comments + /// Returns the number of header comments int GetNumHeaderComments(void) {return (int)comments.size();} - /// Add a header comment + /// Adds a header comment void AddHeaderComment(const AString & comment); - /// Return a header comment + /// Returns a header comment, or empty string if out of range AString GetHeaderComment(const int commentID) const; - /// Delete a header comment. + /// Deletes a header comment. Returns true if successful bool DeleteHeaderComment(int commentID); - /// Delete all header comments. + /// Deletes all header comments void DeleteHeaderComments(void) {comments.clear();} -- cgit v1.2.3