diff options
author | William S Fulton <wsf@fultondesigns.co.uk> | 2011-11-04 19:51:17 +0000 |
---|---|---|
committer | William S Fulton <wsf@fultondesigns.co.uk> | 2011-11-04 19:51:17 +0000 |
commit | e00bbdc59177a8a14745eaeb9a2c376c0dc97518 (patch) | |
tree | 83334a76b69c89b455a059d3948f647c86de4bfe /Doc | |
parent | bb3528c480463e58a07d381638c08b1a5ffce24d (diff) | |
download | swig-e00bbdc59177a8a14745eaeb9a2c376c0dc97518.tar.gz |
Add docs on special variable expansion in typemap warnings
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12834 626c5289-ae23-0410-ae9c-e8d60b6d4f22
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/Manual/Typemaps.html | 8 | ||||
-rw-r--r-- | Doc/Manual/Warnings.html | 11 |
2 files changed, 17 insertions, 2 deletions
diff --git a/Doc/Manual/Typemaps.html b/Doc/Manual/Typemaps.html index 6331aa1ac..184062c42 100644 --- a/Doc/Manual/Typemaps.html +++ b/Doc/Manual/Typemaps.html @@ -3597,6 +3597,14 @@ with non-consecutive C/C++ arguments; a workaround such as a helper function re- the arguments to make them consecutive will need to be written. </p> +<H2><a name="Typemaps_warnings"></a>10.10 Typemap warnings</H2> + +<p> +Warnings can be added to typemaps so that SWIG generates a warning message whenever the typemap is used. +See the information in the <a href="Warnings.html#Warnings_nn5">issuing warnings</a> section. +</p> + + <H2><a name="Typemaps_fragments"></a>10.10 Typemap fragments</H2> diff --git a/Doc/Manual/Warnings.html b/Doc/Manual/Warnings.html index 8d155ec99..2a3ce560d 100644 --- a/Doc/Manual/Warnings.html +++ b/Doc/Manual/Warnings.html @@ -257,16 +257,23 @@ Warning messages can be associated with typemaps using the <div class="code"> <pre> -%typemap(in, warning="901:You are really going to regret this") blah * { +%typemap(in, warning="901:You are really going to regret this usage of $1_type $1_name") blah * { ... } </pre> </div> <p> -In this case, the warning message will be printed whenever the typemap is actually used. +In this case, the warning message will be printed whenever the typemap is actually used and the <a href="Typemaps.html#Typemaps_special_variables">special variables</a> will be expanded as appropriate, for example: </p> +<div class="shell"> +<pre> +example.i:23: Warning 901: You are really going to regret this usage of blah * self +example.i:24: Warning 901: You are really going to regret this usage of blah * stuff +</pre> +</div> + <H2><a name="Warnings_symbolic_symbols"></a>14.5 Symbolic symbols</H2> |