I was tempted to make the OPTIMIZE_OUTPUT_FOR_C change with my other commit. I chose not to since I was not sure if there was a reason not to change it.
I will change in another push. Do you have a suggestion for the wording to us in place of the "Getting StartedGuides and Tutorials"? If not I am sure I can come up with something. -----Original Message----- From: Mats Wichmann [mailto:[email protected]] Sent: Wednesday, March 22, 2017 9:07 AM To: Nash, George <george.nash at intel.com>; uzchoi at samsung.com; 'C.J. Collier' <cjcollier at linuxfoundation.org> Cc: 'IoTivity Developer List' <iotivity-dev at lists.iotivity.org> Subject: Re: [dev] IoTivity documentation standards On 03/22/2017 09:55 AM, Nash, George wrote: > Thanks Uze for taking the time to help figure out which header files are > intended for the public API: > > It looks like a few of the headers from your list differ from the list > that was in my recent commit > https://gerrit.iotivity.org/gerrit/#/c/17991/ > > The current commit contains all header files in > ../../csdk/connectivity/api/ > > i.e. > ../../csdk/connectivity/api/cacommon.h (not in list) > ../../csdk/connectivity/api/cainterface.h (not in list) > ../../csdk/connectivity/api/casecurityinterface.h (not in list) > ../../csdk/connectivity/api/cautilinterface.h (in list) > > It does not contain the header files in > ../../csdk/security/include/internal > > > Let me know if I should update the list of INPUT files for the Doxyfile. If you do make changes, will you please flip OPTIMIZE_OUTPUT_FOR_C to yes in the c-doc doxyfile? That will make it stop talking about classes, etc. which don't really apply in the C SDK - I've built with this and it comes out more sane looking. If you're not going to fiddle, I'll push such a change. Also this file: resource/docs/c-doc/guides/Home.txt has a reference that doesn't seem to be true: \li <a href="https://www.iotivity.org/documentation";><strong>Getting Started Guides and Tutorials</strong></a><br />Detailed getting started guides and tutorials can be found on the iotivity.org website. but I don't see any Getting Started Guides and Tutorials there... I guess what there is is on the wiki, maybe we should say that.
