Document a lot of classes and functions

[builder.git] / source / pattern.h

diff --git a/source/pattern.h b/source/pattern.h
index de8e7b2de962b8a1b1bb33ea887000e42b72202c..4c79b4b83b732656d96d8866bb4f3cf9f45318f9 100644 (file)
--- a/source/pattern.h
+++ b/source/pattern.h
@@ -3,6 +3,11 @@
 
 #include <string>
 
+/**
+Stores a filename pattern.  A pattern consists of a prefix and a suffix, and
+can be applied to a body to form a complete filename.  Either or both of the
+prefix and suffix may be empty.
+*/
 class Pattern
 {
 private:
@@ -10,8 +15,11 @@ private:
        std::string suffix;
 
 public:
+       /** Constructs a pattern from a single string.  The string must have exactly
+       one percent sign (%) to separate the prefix and suffix. */
        Pattern(const std::string &);
 
+       /** Applies the pattern to a body string. */
        std::string apply(const std::string &) const;
 };