Add documentation, coverage hooks, and several formatting failure cases

ARMmbed / sockets

mbed sockets library abstraction layer

Other

6 stars 18 forks source link

Add documentation, coverage hooks, and several formatting failure cases #39

Closed bremoran closed 8 years ago

bremoran commented 8 years ago

This PR corrects several problems identified during test coverage updates

Documented all APIs
Added cmake coverage hooks
Added new tests for error cases in formatting

cc @bogdanm @adbridge @niklas-arm @autopulated

0xc0170 commented 8 years ago

Cosmetic notes: Isn't @return redundant if there's @retval already? What about vertical break before those doxy blocks? There are in some files in this module.

Line 37 and one more: poitner typo.

niklarm commented 8 years ago

#define IPv64_PREFIX_STRLEN (sizeof(IPv64_PREFIX)) contain the terminator, which is not how strlen() does it. This leads to strncpy(buf, IPv64_PREFIX, IPv64_PREFIX_STRLEN); also copying the terminator, which leads to problems when printing the buffer, since only ::ffff: is printed without the actual IP ever being printed.

bremoran commented 8 years ago

I think this PR is now dead, in favour of https://github.com/ARMmbed/sockets/pull/43

0xc0170 commented 8 years ago

Please close

bremoran commented 8 years ago

This should be completely resolved by other PRs now.