You are correct. The current doxygen file is resource/docs/c-doc/Doxyfile

https://wiki.iotivity.org/generate_api_doc

Right now the wiki only includes the instructions on generating the API doc 
nothing more.

I do not know why the files don't set the "OPTIMIZE_OUTPUT_FOR_C" flag. It 
seems like it should be set.

There is also a second Doxygen config file devdocs.doxyfile.

The best I can gather the default Doxyfile is supposed to be for the public 
headers. While the devdocs.doxyfile is supposed to run across the all of the 
project files. It looks like both files need to be maintained a little more. 
The default Doxyfile is definitally including header files that are internal 
header files. I did do a little cleanup work recently but that was just the 
minimum work to fix the warnings reported when doxygen was run. The OSWG really 
wants to improve the documentation but its hard to know where to start when I 
am a little unclear about which files are public and which are not. There is 
also desire to improve the param markup to mark in,out values of the params.

George

-----Original Message-----
From: iotivity-dev-bounces at lists.iotivity.org 
[mailto:[email protected]] On Behalf Of Mats Wichmann
Sent: Sunday, March 12, 2017 8:07 AM
To: IoTivity Developer List <iotivity-dev at lists.iotivity.org>
Subject: [dev] C API docs: which Doxyfile?


There seem to be two Doxyfiles for the C API:

resource/csdk/doc/Doxyfile
resource/docs/c-doc/Doxyfile

Before I spend time sorting out which one is "current", does anyone know?  It 
_looks_ to me like the csdk/doc one may be older as it refers to some resources 
that look like they've moved.

Anything else I should know about the API docs before I poke around a bit more? 
Like why the C API doxyfiles don't set "OPTIMIZE_OUTPUT_FOR_C"
- is that an intentional choice?



_______________________________________________
iotivity-dev mailing list
iotivity-dev at lists.iotivity.org
https://lists.iotivity.org/mailman/listinfo/iotivity-dev

Reply via email to