[GitHub] sterlinghughes commented on issue #725: match os_sched() doxygen with mynewt-site

[GitBox <gi...@apache.org>]

sterlinghughes commented on issue #725: match os_sched() doxygen with mynewt-site
URL: https://github.com/apache/mynewt-core/pull/725#issuecomment-357137991
 
 
   Hi Gavin, 
   I think we should go down this route, although I don't think you should be updating the Mynewt doxygen.  We had a meeting before the new year to discuss, and agreed:
   
   (a) the Mynewt developers will update the doxygen in the tree to make it more complete and usable
   (b) We will move to doxygen comments in the header files instead of in the source files, and have that track function API declaration as opposed to implementation.  
   
   I don't think we're going for exact parity here, but we do want to have this be the source of truth going forward.  By maintaining the prototypes externally, we risk them being out of date, especially as we maintain versions of the documentation for each firmware release with the correct API signature.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services