jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Macros wrapped as constants documentation improvements.

Browse source 
Closes #1618
This commit is contained in:
William S Fulton 2019-10-01 08:05:35 +01:00
commit 4c86ed4980
1 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/Manual/SWIG.html
View file

@ -826,6 +826,32 @@ However, for the same conservative reasons even a constant with a simple cast wi
</pre>
</div>
<p>
This logic can lead to false attempts at converting <tt>#define</tt> into <tt>%constant</tt> though.
For example the following case does not have any undefined symbols within the macro:
</p>
<div class="code">
<pre>
// For indicating pure virtual functions such as: virtual void f() PURE;
#define PURE = 0
</pre>
</div>
<p>
A warning is issued:
</p>
<div class="shell">
<pre>
pure.h:1: Warning 305: Bad constant value (ignored).
</pre>
</div>
<p>
In such cases simply ignore the warning or suppress it using the normal warning suppression techniques.
</p>
<p>
The use of constant expressions is allowed, but SWIG does not evaluate
them. Rather, it passes them through to the output file and lets the C