Add a few comments to the hello world example.

google · Jun 21, 2014 · eadb5f7 · eadb5f7
1 parent 501728b
commit eadb5f7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -64,6 +64,8 @@ public:
 
 class StdoutWriter : public Writer {
 public:
+  // Like "StdoutWriter() = default;" but also marks this constructor as the
+  // one to use for injection.
   INJECT(StdoutWriter()) = default;
 
   virtual ~StdoutWriter() = default;
@@ -83,6 +85,8 @@ private:
   Writer* writer;
 
 public:
+  // Like "GreeterImpl(Writer* writer) {...}" but also marks this constructor
+  // as the one to use for injection.
   INJECT(GreeterImpl(Writer* writer))
     : writer(writer) {
   }
@@ -110,6 +114,8 @@ int main() {
 }
 ```
 
+More documentation is coming soon, stay tuned.
+
 ### Example code
 
 For examples on how code looks like when using Fruit, look at the examples/ directory in the source tree.

diff --git a/examples/hello_world/main.cpp b/examples/hello_world/main.cpp
@@ -12,6 +12,8 @@ class Writer {
 
 class StdoutWriter : public Writer {
 public:
+  // Like "StdoutWriter() = default;" but also marks this constructor as the
+  // one to use for injection.
   INJECT(StdoutWriter()) = default;
 
   virtual ~StdoutWriter() = default;
@@ -31,6 +33,8 @@ class GreeterImpl : public Greeter {
   Writer* writer;
 
 public:
+  // Like "GreeterImpl(Writer* writer) {...}" but also marks this constructor
+  // as the one to use for injection.
   INJECT(GreeterImpl(Writer* writer))
     : writer(writer) {
   }