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 some developer documentation for widely used structs/methods #5

Open
BrunoMartinGym opened this issue Feb 5, 2015 · 0 comments

Comments

@BrunoMartinGym
Copy link

First, let me start by saying that this application is amazing. A thing that could make it even more useful to new developers would be to add some documentation directly in the code. For example:

  1. KinFuParams: This struct contains lots of parameter for which the impact of modifying the values is not documented. Adding some guidelines/rule of thumb for the use of these parameters would be welcome to new users. For example: What parameters should I pay more attention if I want to scan small objects, objects with sharp features, etc?

  2. What is the meaning of the different flag values for the KinFu::renderImage method?

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

No branches or pull requests

1 participant