🤖Have you ever tried Chat.M5Stack.com before asking??😎
    M5Stack Community
    • Categories
    • Recent
    • Tags
    • Popular
    • Users
    • Groups
    • Search
    • Register
    • Login

    Arduino examples on GitHub -- no overview of used *h files -- no comments

    Arduino
    2
    2
    3.2k
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • R
      ramaker
      last edited by

      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.

      1 Reply Last reply Reply Quote 0
      • ajb2k3A
        ajb2k3
        last edited by

        Sorry, full documentation is way behind schedule.

        UIFlow, so easy an adult can learn it!
        If I don't know it, be patient!
        I've ether not learned it or am too drunk to remember it!
        Author of the WIP UIFlow Handbook!
        M5Black, Go, Stick, Core2, and so much more it cant be fit in here!

        1 Reply Last reply Reply Quote 0
        • First post
          Last post