Re: [Log4cpp-devel] Docs for win32 classes

[Bastiaan B. <Bas...@li...>]

On Tue, 2002-08-13 at 10:13, David Resnick wrote:
> Docs for classes NTEventLogAppender and Win32DebugAppender are not
> generated by doxygen because they are wrapped in "#ifdef WIN32". The
> documentation for them will be generated if 
> 
> PREDEFINED           = "WIN32"
> 
> is added to 'doc/Doxyfile'. 
> 
> I think this should be added for the general release (people not working
> on windows will ignore it).
> 

Yes, the documentation should be covering all components of log4cpp
regardless of whether the particular build platform supports them. 
However, if a component is not available on all platforms the
documentation of that component should contain a clear warning.

I've added the predefine and the warning in the two classes. 
While I was at it, I also added #error messages in case someone tries to
use these classes on the wrong platform. 
Should be a good idea for IdsaAppender and SyslogAppender too.

Regards,

Bastiaan