%ignore clarification for #1592169

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@9540 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2006-11-10 23:05:20 +00:00
commit 72e32b3ccb

View file

@ -1701,7 +1701,8 @@ to ignore declarations that match a given identifier. For example:
</div>
<p>
One use of <tt>%ignore</tt> is to selectively remove certain declarations from a header file without having
Any function, variable etc which matches <tt>%ignore</tt> will not be wrapped and therefore will not be available from the target language.
A common usage of <tt>%ignore</tt> is to selectively remove certain declarations from a header file without having
to add conditional compilation to the header. However, it should be stressed that this only works for simple
declarations. If you need to remove a whole section of problematic code, the SWIG preprocessor should be used instead.
</p>