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/wxMenu.erl | 48 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) (limited to 'lib/wx/src/gen/wxMenu.erl') diff --git a/lib/wx/src/gen/wxMenu.erl b/lib/wx/src/gen/wxMenu.erl index 994855f805..d91863de82 100644 --- a/lib/wx/src/gen/wxMenu.erl +++ b/lib/wx/src/gen/wxMenu.erl @@ -94,6 +94,13 @@ append(This,Itemid,Text) append(This,Itemid,Text, []). %% @doc See external documentation. +%%
Also:
+%% append(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(),
+%% Option :: {help, unicode:chardata()}
+%% | {kind, wx:wx_enum()}.
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec append(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(); (This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when @@ -116,6 +123,11 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) <>). %% @doc See external documentation. +%%
Also:
+%% append(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -spec append(This, Itemid, Text, Help, IsCheckable) -> ok when This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when @@ -209,6 +221,10 @@ check(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Check) <>). %% @doc See external documentation. +%%
Also:
+%% delete(This, Item) -> boolean() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec delete(This, Itemid) -> boolean() when This::wxMenu(), Itemid::integer(); (This, Item) -> boolean() when @@ -225,6 +241,10 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% 'Destroy'(This, Item) -> boolean() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec 'Destroy'(This, Itemid) -> boolean() when This::wxMenu(), Itemid::integer(); (This, Item) -> boolean() when @@ -250,6 +270,10 @@ enable(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Enable) <>). %% @doc See external documentation. +%%
Also:
+%% findItem(This, Item) -> integer() when
+%% This::wxMenu(), Item::unicode:chardata().
+%% -spec findItem(This, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(); (This, Item) -> integer() when @@ -318,6 +342,11 @@ getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% insert(This, Pos, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem().
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec insert(This, Pos, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Pos::integer(), Itemid::integer(); (This, Pos, Item) -> wxMenuItem:wxMenuItem() when @@ -360,6 +389,11 @@ insert(This,Pos,Itemid,Text,Submenu) insert(This,Pos,Itemid,Text,Submenu, []). %% @doc See external documentation. +%%
Also:
+%% insert(This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -spec insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok when This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); (This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when @@ -455,6 +489,11 @@ isEnabled(#wx_ref{type=ThisT,ref=ThisRef},Itemid) <>). %% @doc See external documentation. +%%
Also:
+%% prepend(This, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec prepend(This, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(); (This, Item) -> wxMenuItem:wxMenuItem() when @@ -496,6 +535,11 @@ prepend(This,Itemid,Text,Submenu) prepend(This,Itemid,Text,Submenu, []). %% @doc See external documentation. +%%
Also:
+%% prepend(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -spec prepend(This, Itemid, Text, Help, IsCheckable) -> ok when This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when @@ -572,6 +616,10 @@ prependSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% remove(This, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec remove(This, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(); (This, Item) -> wxMenuItem:wxMenuItem() when -- cgit v1.2.3