On 03/13/2017 03:08 PM, Nash, George wrote:
> 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

Yikes... seems like we need to figure out what the "public API" (among
the various C, C++, Java, etc. API sets) actually is.  How can I help
with this?

Reply via email to