Add documentation to Footprints

Add doxygen documentation to the constructors for the Footprint object.
lsst · May 15, 2017 · 4f25e2e · 4f25e2e
1 parent 739cd87
commit 4f25e2e
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/include/lsst/afw/detection/Footprint.h b/include/lsst/afw/detection/Footprint.h
@@ -70,13 +70,30 @@ class Footprint : public lsst::daf::base::Citizen,
      * that to construct the Footprint.
      */
 
+    /** @brief Constructor for Footprint object
+     *
+     * @param inputSpans Shared pointer to a SpanSet defining the pixels included in
+                         the Footprint.
+     * @param region Bounding box of the image in which the Footprint was created,
+                     defaults to empty box.
+     */
     explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans,
                        geom::Box2I const & region=geom::Box2I());
 
+    /** @brief Constructor for the Footprint object
+     *
+     * @param inputSpans Shared pointer to a SpanSet defining the pixels included in
+                         the Footprint.
+     * @param peakSchema schema to be used in the PeakCatalog
+     * @param region Bounding box of the image in which the Footprint was created,
+                     defaults to empty box.
+     */
     explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans,
                        afw::table::Schema const & peakSchema,
                        geom::Box2I const & region=geom::Box2I());
 
+    /** @brief Constructor of a empty Footprint object
+     */
     explicit Footprint(): lsst::daf::base::Citizen(typeid(this)),
                           _spans(std::make_shared<geom::SpanSet>()),
                           _peaks(PeakTable::makeMinimalSchema()),