Skip to content

Commit

Permalink
Update the documentation for FileChangeChecker.
Browse files Browse the repository at this point in the history
  • Loading branch information
FooBarWidget committed Jun 4, 2009
1 parent 0bc257a commit 09e52c3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions ext/common/FileChangeChecker.h
Expand Up @@ -39,19 +39,19 @@ using namespace std;
using namespace oxt;

/**
* Utility class for checking for file changes. Example:
* A utility class for checking for file changes. Example:
*
* @code
* FileChecker checker("foo.txt");
* checker.changed(); // false
* FileChangeChecker checker;
* checker.changed("foo.txt"); // false
* writeToFile("foo.txt");
* checker.changed(); // true
* checker.changed(); // false
* checker.changed("foo.txt"); // true
* checker.changed("foo.txt"); // false
* @endcode
*
* FileChecker uses stat() to retrieve file information. FileChecker also
* supports throttling in order to limit the number of stat() calls. This
* can improve performance on systems where disk I/O is a problem.
* supports throttling in order to limit the number of actual stat() calls.
* This can improve performance on systems where disk I/O is a problem.
*/
class FileChangeChecker {
private:
Expand Down

0 comments on commit 09e52c3

Please sign in to comment.