Arduino examples on GitHub -- no overview of used *h files -- no comments
-
There are samples an GitHub - how to use components.
Most of them use libraries for special function or devices for example#include <M5StickC.h>
#include <WiFi.h>
#include <WiFiUdp.h>in the file : M5-ProductExampleCodes/Hat/RoverC/RoverC.ino
It is ok, that there are examples, but where is the documentation for the used libraries files ?
How do I know what they are doing ?I wonder why there is no comment inside that examples ?
It should be standard, that compex functions have a comment, what they doing and how.
These are sample programms, that shall help people to use the hard- and software.
It should be no secret in it to hide.So - why no comments and a list of the used functions from the libs ?
I made software in a company and there I need the comments by myself to have the overview. It seems to me like the example files were "cleaned" from comments. WHY ?
(I start with M5Stack and learn every day more about that hard- and software. Maybe I do not understand the system they have for documentation and learning. If it is so, so please can anybody provide me with an info where and how I can find that information.)
K.D.
-
Sorry, full documentation is way behind schedule.
Hello! It looks like you're interested in this conversation, but you don't have an account yet.
Getting fed up of having to scroll through the same posts each visit? When you register for an account, you'll always come back to exactly where you were before, and choose to be notified of new replies (either via email, or push notification). You'll also be able to save bookmarks and upvote posts to show your appreciation to other community members.
With your input, this post could be even better 💗
Register Login