From ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Fri, 24 Feb 2012 11:53:41 +0100 Subject: [wx] Doc overloaded functions edoc do not handle overloaded type-specs, so doc them manually --- lib/wx/src/gen/wxWindow.erl | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) (limited to 'lib/wx/src/gen/wxWindow.erl') diff --git a/lib/wx/src/gen/wxWindow.erl b/lib/wx/src/gen/wxWindow.erl index ecae29ea5f..d31f489726 100644 --- a/lib/wx/src/gen/wxWindow.erl +++ b/lib/wx/src/gen/wxWindow.erl @@ -324,6 +324,10 @@ findFocus() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% findWindow(This, Name) -> wxWindow() when
+%% This::wxWindow(), Name::unicode:chardata().
+%% -spec findWindow(This, Winid) -> wxWindow() when This::wxWindow(), Winid::integer(); (This, Name) -> wxWindow() when @@ -839,6 +843,10 @@ isEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% isExposed(This, Rect) -> boolean() when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec isExposed(This, Pt) -> boolean() when This::wxWindow(), Pt::{X::integer(), Y::integer()}; (This, Rect) -> boolean() when @@ -958,6 +966,11 @@ move(This,Pt={PtX,PtY}) move(This,Pt, []). %% @doc See external documentation. +%%
Also:
+%% move(This, Pt, [Option]) -> ok when
+%% This::wxWindow(), Pt::{X::integer(), Y::integer()},
+%% Option :: {flags, integer()}.
+%% -spec move(This, X, Y) -> ok when This::wxWindow(), X::integer(), Y::integer(); (This, Pt, [Option]) -> ok when @@ -1278,6 +1291,10 @@ setCaret(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CaretT,ref=CaretRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% setClientSize(This, Rect) -> ok when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec setClientSize(This, Size) -> ok when This::wxWindow(), Size::{W::integer(), H::integer()}; (This, Rect) -> ok when @@ -1508,6 +1525,10 @@ setScrollPos(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos, Options) <>). %% @doc See external documentation. +%%
Also:
+%% setSize(This, Size) -> ok when
+%% This::wxWindow(), Size::{W::integer(), H::integer()}.
+%% -spec setSize(This, Rect) -> ok when This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}; (This, Size) -> ok when @@ -1523,6 +1544,11 @@ setSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) <>). %% @doc See external documentation. +%%
Also:
+%% setSize(This, Rect, [Option]) -> ok when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()},
+%% Option :: {sizeFlags, integer()}.
+%% -spec setSize(This, Width, Height) -> ok when This::wxWindow(), Width::integer(), Height::integer(); (This, Rect, [Option]) -> ok when @@ -1572,6 +1598,12 @@ setSizeHints(This,MinSize={MinSizeW,MinSizeH}) setSizeHints(This,MinSize, []). %% @doc See external documentation. +%%
Also:
+%% setSizeHints(This, MinSize, [Option]) -> ok when
+%% This::wxWindow(), MinSize::{W::integer(), H::integer()},
+%% Option :: {maxSize, {W::integer(), H::integer()}}
+%% | {incSize, {W::integer(), H::integer()}}.
+%% -spec setSizeHints(This, MinW, MinH) -> ok when This::wxWindow(), MinW::integer(), MinH::integer(); (This, MinSize, [Option]) -> ok when @@ -1665,6 +1697,10 @@ setThemeEnabled(#wx_ref{type=ThisT,ref=ThisRef},EnableTheme) <>). %% @doc See external documentation. +%%
Also:
+%% setToolTip(This, Tip) -> ok when
+%% This::wxWindow(), Tip::wxToolTip:wxToolTip().
+%% -spec setToolTip(This, Tip) -> ok when This::wxWindow(), Tip::unicode:chardata(); (This, Tip) -> ok when @@ -1708,6 +1744,11 @@ setVirtualSizeHints(This,MinSize={MinSizeW,MinSizeH}) setVirtualSizeHints(This,MinSize, []). %% @doc See external documentation. +%%
Also:
+%% setVirtualSizeHints(This, MinSize, [Option]) -> ok when
+%% This::wxWindow(), MinSize::{W::integer(), H::integer()},
+%% Option :: {maxSize, {W::integer(), H::integer()}}.
+%% -spec setVirtualSizeHints(This, MinW, MinH) -> ok when This::wxWindow(), MinW::integer(), MinH::integer(); (This, MinSize, [Option]) -> ok when -- cgit v1.2.3