Joey and Thiago,

A script in the root directory of the project will generate all of the 
documentations. If it is missing something, add to the master script or the 
current Doxyfile.

Pat

> -----Original Message-----
> From: iotivity-dev-bounces at lists.iotivity.org [mailto:iotivity-dev-
> bounces at lists.iotivity.org] On Behalf Of Morrow, Joseph L
> Sent: Monday, July 20, 2015 6:53 PM
> To: Macieira, Thiago; iotivity-dev at lists.iotivity.org
> Subject: Re: [dev] Iotivity C stack APIs missing from website/documentation
> 
> Hi Thiago,
> 
> I am pretty certain he is referring to the fact that ultimately that only 
> Doxyfile
> located at IOTIVITY/resource/docs/Doxyfile is generated (hence the title "
> IoTivity C++ SDK") is being generated. This Doxyfile is not all-encompassing 
> for
> the C SDK as well (note: "ocstack.h" is not documented there and this file
> represents almost all of the C SDK).
> 
> The Doxyfile located at IOTIVITY/resource/csdk/doc/Doxyfile should also be
> generated to properly capture the C SDK. This can be done by going to
> IOTIVITY/resource/csdk/doc/ and issuing the following command:
> 
>       doxygen
> 
> (It is surprisingly that easy!) Once you've done this, simply link the 
> index.html file
> at IOTIVITY/resource/csdk/doc/docs/index.html to be a sister link to the other
> "IOTIVITY C++ SDK" link.
> 
> Thanks,
> 
> Joey
> 
> -----Original Message-----
> From: iotivity-dev-bounces at lists.iotivity.org [mailto:iotivity-dev-
> bounces at lists.iotivity.org] On Behalf Of Thiago Macieira
> Sent: Monday, July 20, 2015 3:32 PM
> To: iotivity-dev at lists.iotivity.org
> Subject: Re: [dev] Iotivity C stack APIs missing from website/documentation
> 
> On Monday 20 July 2015 18:57:52 Kesavan, Vijay S wrote:
> > Note: Iotivity C stack APIs have not been documented on the website.
> > I hope this will be addressed prior to release 0.9.2.
> 
> Hi Vijay
> 
> Do you mean that the docs exist but haven't been uploaded? Isn't this it?
>       https://api-docs.iotivity.org/latest/index.html
> 
> It should be both the C and C++ parts, even though it's called "IoTivity C++ 
> SDK".
> I can see some C structs there, but I can't find the documentation for 
> interesting
> functions like OCDoResource.
> 
> Do you mean that the docs exist but aren't being generated? If so, please 
> share
> the commands to get them generated, as it seems the release team isn't aware
> of the details.
> 
> Or do you mean that the documentation should still be written? If so, then 
> it's
> too late for 0.9.2.
> 
> --
> Thiago Macieira - thiago.macieira (AT) intel.com
>   Software Architect - Intel Open Source Technology Center
> 
> _______________________________________________
> iotivity-dev mailing list
> iotivity-dev at lists.iotivity.org
> https://lists.iotivity.org/mailman/listinfo/iotivity-dev
> _______________________________________________
> iotivity-dev mailing list
> iotivity-dev at lists.iotivity.org
> https://lists.iotivity.org/mailman/listinfo/iotivity-dev

Reply via email to