NimBLE host API update

2016-07-11 Thread Christopher Collins
Hello all, For the past few weeks I have been hinting at a proposal for an updated NimBLE host API. It has taken a bit longer than I expected, but I think the proposal is finally ready to unleash on the dev list. I have not pushed any changes to master or develop; I wanted to give the community

Fwd: incubator-mynewt-core git commit: MYNEWT-314; First take on the socket interface.

2016-07-11 Thread marko kiiskila
Hi all, I checked in the first take of the socket interface. I did change it a bit from my original email. Notably; the user of the socket will not allocate the memory for socket. This would be done by the system. The API uses callbacks instead of struct os_event automatically. As discussed

Re: Things I'd like to see

2016-07-11 Thread David G. Simmons
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

2016-07-11 Thread Sterling Hughes
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

2016-07-11 Thread Christopher Collins
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

2016-07-11 Thread Sterling Hughes
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

2016-07-11 Thread Christopher Collins
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

2016-07-11 Thread will sanfilippo
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

2016-07-11 Thread David G. Simmons
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!