Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to Footprints #229

Merged
merged 1 commit into from May 16, 2017
Merged

Add documentation to Footprints #229

merged 1 commit into from May 16, 2017

Conversation

rearmstr
Copy link
Contributor

Add doxygen documentation to the constructors for the Footprint
object.

*
* @param inputSpans Shared pointer to a SpanSet defining the pixels included in
the Footprint.
* @param region Bounding box of the MaskedImage in which the Footprint was created,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this refer to a MaskedImage? This could be any type of image correct? Same question for the other constructor.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh good point, I just pulled over from old footprints. I maybe should just change that to lowercase image to just give idea of generic image.

@natelust natelust force-pushed the tickets/DM-10386 branch 2 times, most recently from 4f25e2e to 0a65ecb Compare May 15, 2017 20:16
Add doxygen documentation to the constructors for the Footprint
object.
@natelust natelust merged commit 020b63f into master May 16, 2017
@ktlim ktlim deleted the tickets/DM-10386 branch August 25, 2018 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants