1
0

cIniFile: Improved doxy-comments.

This commit is contained in:
madmaxoft 2013-10-26 10:33:28 +02:00
parent de6f628d2e
commit c15bc15121

View File

@ -153,19 +153,19 @@ public:
// Header comment functions. // Header comment functions.
// Header comments are those comments before the first key. // 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();} int GetNumHeaderComments(void) {return (int)comments.size();}
/// Add a header comment /// Adds a header comment
void AddHeaderComment(const AString & 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; AString GetHeaderComment(const int commentID) const;
/// Delete a header comment. /// Deletes a header comment. Returns true if successful
bool DeleteHeaderComment(int commentID); bool DeleteHeaderComment(int commentID);
/// Delete all header comments. /// Deletes all header comments
void DeleteHeaderComments(void) {comments.clear();} void DeleteHeaderComments(void) {comments.clear();}