Hello David. a +1 to the Idea on comments. It helps everyone working on the code to easily understand what you were doing or is doing.
But for the time being, here is a link to the documentation of all (or most ) already existing modules in our project. http://mynewt.apache.org/latest/os/introduction/ in case you do not understand anything from there, ask the community. It is a very friendly one. Ask over the mailing list or IRC Channel . Thanks On 7/7/16, David G. Simmons <[email protected]> wrote: > > As I’m working through all the mynewt code, something I’d love to see more > of are comments in the code describing what’s going on, etc. I admit to not > being the best at commenting my code — I’m working on it — but it would be > really helpful, especially as more contributors join the party, to have well > documented code so newbies like me can get up to speed on what the code is > actually doing more quickly. > > This would have the adde dbenefit of allowing us to use something like > Doxygen to auto-generate documentation on the code in a more human-readable > form. > > What do others think of implementing some code-documentation standards? > > dg > -- > David G. Simmons > (919) 534-5099 > Web <https://davidgs.com/> • Blog <https://davidgs.com/davidgs_blog> • > Linkedin <http://linkedin.com/in/davidgsimmons> • Twitter > <http://twitter.com/TechEvangelist1> • GitHub <http://github.com/davidgs> > /** Message digitally signed for security and authenticity. > * If you cannot read the PGP.sig attachment, please go to > * http://www.gnupg.com/ <http://www.gnupg.com/> Secure your email!!! > * Public key available at keyserver.pgp.com <http://keyserver.pgp.com/> > **/ > ♺ This email uses 100% recycled electrons. Don't blow it by printing! > > There are only 2 hard things in computer science: Cache invalidation, naming > things, and off-by-one errors. > > > -- "A Goal is a Dream with a Plan and a Dateline" Do On to Others what you will like them to do on to you.'The Golden Rule' Firefox Student Ambassadors Regional Lead Cameroon. Software Developer, Web Designer and Developer. Music DJ . Artiste at Casky Black's Record
