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

need documentation please #42

Open
atesin opened this issue Mar 28, 2024 · 0 comments
Open

need documentation please #42

atesin opened this issue Mar 28, 2024 · 0 comments

Comments

@atesin
Copy link

atesin commented Mar 28, 2024

hi, thanks for your work

i am not an expert, but i am trying to do an automotive application for my car with a velocimeter+odometer... i found very hard to do it, read many concepts, difficult maths, etc

would be very useful if we have documentation like that generated by doxygen describing functions, classes, parameters, return types, for what they are for, etc...

i mean documentation for things found directly in main library, because reading the examples sometimes is not enough, sometimes the examples have some like "intermediate includes" so the functions are not the ones included directly in library but in other file before, what is confused and forces us to read code from 2-3 files in hierarchy, seraching for definitions and trying to interpreting them

additionally this library is complicated as could be mpu6050 itself, with all its quirks, custom registers, dmp that is another platform by itself, i2c workings, etc... so for amateurs like me, without precise documentation is difficult to learn and comprehend to maximize efficiency and benefit

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