RFC: Avoiding #warning (C/C++ preprocessor extension)

[Jaroslaw Staniek]

Olivier Goffart said the following, On 2005-10-31 00:16:

> Le Dimanche 30 Octobre 2005 21:25, Jarosław Staniek a écrit :
> 
>>Since KDE is becoming more portable, my proposal is to avoid using #warning
>>C/C++ preprocessor's extension. Unlike #error, #warning is not a standard -
>>several compilers in addition to gcc implement this. Msvc compiler does
>>not.
> 
> 
> All of this is correct.
> Anyway, #warning are just temporary code,  and they should be removed before 
> the release.
> A good code compiles without warnings at all.
> 
> We should not simply remove the #warning line,  but also fix the code.

Yes, so I asked about a way to replace #warning with something similar but 
allowing the code to compile.

> 
>>To find a solution I would propose to:
>>
>>1. Preferred way: Using doxygen @todo tag instead of #warning. Then
>>warnings can be accessible:
>>1.1. Within Doxygen docs (Related Pages->Todo list), eg.
>>http://www.englishbreakfastnetwork.org/apidocs/apidox-kde-4.0/kdelibs-apido
>>cs/kdecore/html/todo.html 1.2. By just grepping for @todo. This is no
>>different to using #warnings because every #warning can quickly disappear
>>from your screen during compilation, so you still need to find it in the
>>code.
> 
> 
> This is a bit different: @todo are placed in header, and not directly in the 
> code they show.

Could there be a problem with placing them directly in the code? We're already 
using doxygen in the code, in particular, @internal

> also #warning are generally used for more important things, while @todo may be 
> long terms.
> There is also a flag to make all warnings act like fatal error, to force to 
> fix them.

So what about @warning ?

Eventually, if Doxygen substitutes are not enough, we could stay with:

#ifdef __GNU__
#warning foo
#endif

Not a problem for me, as in kdelibs3. And #warnings will disappear when code 
stablilizes.

-- 
regards / pozdrawiam,
  Jaroslaw Staniek / OpenOffice Polska
  Kexi Developer:
      http://www.kexi-project.org | http://koffice.org/kexi
  KDE3, KDE4 libraries for developing MS Windows applications:
      http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32