diff options
| author | Dan Gudmundsson <[email protected]> | 2012-02-24 11:53:41 +0100 |
|---|---|---|
| committer | Dan Gudmundsson <[email protected]> | 2012-02-24 11:53:41 +0100 |
| commit | ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6 (patch) | |
| tree | 59ce7017df17649505b17d3a1521a20ba3c2aa52 /lib/wx/src/gen/wxRegion.erl | |
| parent | 217343d158afe60a5a6a15e8b894b6fd62611ad3 (diff) | |
| download | otp-ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6.tar.gz otp-ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6.tar.bz2 otp-ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6.zip | |
[wx] Doc overloaded functions
edoc do not handle overloaded type-specs, so doc them manually
Diffstat (limited to 'lib/wx/src/gen/wxRegion.erl')
| -rw-r--r-- | lib/wx/src/gen/wxRegion.erl | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/wx/src/gen/wxRegion.erl b/lib/wx/src/gen/wxRegion.erl index 3397cc7e81..3e23623741 100644 --- a/lib/wx/src/gen/wxRegion.erl +++ b/lib/wx/src/gen/wxRegion.erl @@ -44,6 +44,10 @@ new() -> <<>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregionwxregion">external documentation</a>. +%% <br /> Also:<br /> +%% new(Rect) -> wxRegion() when<br /> +%% Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% -spec new(Bmp) -> wxRegion() when Bmp::wxBitmap:wxBitmap(); (Rect) -> wxRegion() when @@ -82,6 +86,10 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}) -> <<ThisRef:32/?UI>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregioncontains">external documentation</a>. +%% <br /> Also:<br /> +%% contains(This, Rect) -> wx:wx_enum() when<br /> +%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% %%<br /> Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion -spec contains(This, Pt) -> wx:wx_enum() when This::wxRegion(), Pt::{X::integer(), Y::integer()}; @@ -135,6 +143,10 @@ getBox(#wx_ref{type=ThisT,ref=ThisRef}) -> <<ThisRef:32/?UI>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregionintersect">external documentation</a>. +%% <br /> Also:<br /> +%% intersect(This, Rect) -> boolean() when<br /> +%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% -spec intersect(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when @@ -168,6 +180,10 @@ isEmpty(#wx_ref{type=ThisT,ref=ThisRef}) -> <<ThisRef:32/?UI>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregionsubtract">external documentation</a>. +%% <br /> Also:<br /> +%% subtract(This, Rect) -> boolean() when<br /> +%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% -spec subtract(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when @@ -211,6 +227,10 @@ offset(#wx_ref{type=ThisT,ref=ThisRef},X,Y) <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregionunion">external documentation</a>. +%% <br /> Also:<br /> +%% union(This, Rect) -> boolean() when<br /> +%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% -spec union(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion() | wxBitmap:wxBitmap(); (This, Rect) -> boolean() when @@ -263,6 +283,10 @@ union(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI,W:32/?UI,H:32/?UI>>). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxregion.html#wxregionxor">external documentation</a>. +%% <br /> Also:<br /> +%% 'Xor'(This, Rect) -> boolean() when<br /> +%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.<br /> +%% -spec 'Xor'(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when |