fluid-dev
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [fluid-dev] Change the char* in the API to const char*


From: josh
Subject: Re: [fluid-dev] Change the char* in the API to const char*
Date: Wed, 28 Oct 2009 16:25:43 -0700
User-agent: Internet Messaging Program (IMP) H3 (4.1.6)

Thanks for clarifying that. So it sounds like it wont really do what I'm trying to do. I think it should be fine though, as long as we take care with future API additions to make sure they are showing up in the docs, since I've already manually combed all the headers making sure they are in the API reference.

Josh

Quoting Pedro Lopez-Cabanillas <address@hidden>:
On Wednesday, October 28, 2009, address@hidden wrote:
During the process of going over a lot of the API, I realized that  
there were still some undocumented functions.  I had assumed that  
Doxygen would report missing docs, but it appears this is just for  
"missing members" and not functions.  

No warnings are reported by Doxygen for undocumented functions. There is a
processing option EXTRACT_ALL; when it is YES all entities are extracted and
appear in the documentation, even if there is no documentation for them. This
option also disables the warnings about missing documentation.

When EXTRACT_ALL is NO, only documented entities are extracted. The
class/struct members with missing documentation are reported because the
option WARN_IF_UNDOCUMENTED=YES.

Doxygen reference:
  http://www.stack.nl/~dimitri/doxygen/config.html#cfg_extract_all
  http://www.stack.nl/~dimitri/doxygen/config.html#cfg_warnings

Regards,
Pedro


_______________________________________________
fluid-dev mailing list
address@hidden
http://lists.nongnu.org/mailman/listinfo/fluid-dev








reply via email to

[Prev in Thread] Current Thread [Next in Thread]