Re: Things I'd like to see

On Mon, Jul 11, 2016 at 01:00:24PM -0700, Sterling Hughes wrote: > Hey, > > On 11 Jul 2016, at 12:45, Christopher Collins wrote: > > > On Mon, Jul 11, 2016 at 11:01:45AM -0700, Sterling Hughes wrote: > >> As Will points out, I’m OK if APIs are documented outside of the > >> code > >> itself.

Re: Things I'd like to see

All great comments, and good to have a discussion of this. Here’s why I brought it up. In going through the bletiny sample app, there are almost no comments that describe what is going on, and why. In slinky there are a few more, but they are still fairly sparse. For someone coming into this

Re: Things I'd like to see

Hey, On 11 Jul 2016, at 12:45, Christopher Collins wrote: On Mon, Jul 11, 2016 at 11:01:45AM -0700, Sterling Hughes wrote: As Will points out, I’m OK if APIs are documented outside of the code itself. For the OS, I went through and added a bunch of Doxygen comments, but the function calls

Re: Things I'd like to see

On Mon, Jul 11, 2016 at 11:01:45AM -0700, Sterling Hughes wrote: > As Will points out, I’m OK if APIs are documented outside of the code > itself. For the OS, I went through and added a bunch of Doxygen > comments, but the function calls and their variants were fairly > simple. Function calls

Re: Things I'd like to see

As Will points out, I’m OK if APIs are documented outside of the code itself. For the OS, I went through and added a bunch of Doxygen comments, but the function calls and their variants were fairly simple. Function calls that take big enums as a parameter can be very lengthy to document with

Re: Things I'd like to see

On Mon, Jul 11, 2016 at 08:51:10AM -0700, will sanfilippo wrote: > I have mixed feelings about comments. In my view, it is OK to not > comment the code heavily if there is a document that explains the > code. Either is sufficient in my opinion. Of course, keeping to > Doxygen style comments for

Re: Things I'd like to see

I have mixed feelings about comments. In my view, it is OK to not comment the code heavily if there is a document that explains the code. Either is sufficient in my opinion. Of course, keeping to Doxygen style comments for public API is a good idea. Do we run doxygen automatically and can we

Re: Things I'd like to see

And just in case you think commenting your code is boring and pointless, here’s a fun reason to do it … you just never know. The code that took the USA to the moon was just posted on GitHub, and some of the code comments are pure gold!

Re: Things I'd like to see

Hi David, #mynewt on irc.freenode.net . See you there! thanks, aditi > On Jul 8, 2016, at 6:46 AM, David G. Simmons wrote: > > What is the IRC channel? Can’t find a reference to it. > > I’ve read all the docs, to be sure. it’s down in the weeds

Re: Things I'd like to see

What is the IRC channel? Can’t find a reference to it. I’ve read all the docs, to be sure. it’s down in the weeds of the code that some documentation would help most though. The docs referenced are way too high-level for where I’m digging. Best regards, dg > On Jul 8, 2016, at 5:09 AM, Nges B

Re: Things I'd like to see

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.