v0.2.50..v0.2.51 changeset OsmChangeWriterFactory.h

diff --git a/hoot-core/src/main/cpp/hoot/core/io/OsmChangeWriterFactory.h b/hoot-core/src/main/cpp/hoot/core/io/OsmChangeWriterFactory.h
index cf20f69..9099b12 100644
--- a/hoot-core/src/main/cpp/hoot/core/io/OsmChangeWriterFactory.h
+++ b/hoot-core/src/main/cpp/hoot/core/io/OsmChangeWriterFactory.h
@@ -41,10 +41,30 @@ class OsmChangeWriterFactory
 {
 public:
 
-  std::shared_ptr<OsmChangeWriter> createWriter(const QString& url, const QString& elementPayloadFormat = "json");
+  /**
+   * Creates a writer capable of streaming OSM changes
+   *
+   * @param url the path the writer writes to
+   * @param elementPayloadFormat determines the format the elements are stored in; options are
+   * 'json' or 'xml'
+   * @return an OSM change writer
+   */
+  std::shared_ptr<OsmChangeWriter> createWriter(const QString& url,
+                                                const QString& elementPayloadFormat = "json");
 
+  /**
+   * Determines if the output location is supported by any OsmChangeWriter
+   *
+   * @param output the output path to validate
+   * @return true if the output path is supported by any writer; false otherwise
+   */
   bool isSupported(const QString& output);
 
+  /**
+   * Returns a Singleton instance of OsmChangeWriterFactory
+   *
+   * @return
+   */
   static OsmChangeWriterFactory& getInstance();
 
 private: