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/wxGrid.erl | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'lib/wx/src/gen/wxGrid.erl') diff --git a/lib/wx/src/gen/wxGrid.erl b/lib/wx/src/gen/wxGrid.erl index dd85c7b46d..2f4b45b1bc 100644 --- a/lib/wx/src/gen/wxGrid.erl +++ b/lib/wx/src/gen/wxGrid.erl @@ -149,6 +149,13 @@ new(Parent,Id) new(Parent,Id, []). %% @doc See external documentation. +%%
Also:
+%% new(Parent, Id, [Option]) -> wxGrid() when
+%% Parent::wxWindow:wxWindow(), Id::integer(),
+%% Option :: {pos, {X::integer(), Y::integer()}}
+%% | {size, {W::integer(), H::integer()}}
+%% | {style, integer()}.
+%% -spec new(Parent, X, Y) -> wxGrid() when Parent::wxWindow:wxWindow(), X::integer(), Y::integer(); (Parent, Id, [Option]) -> wxGrid() when @@ -1252,6 +1259,11 @@ isVisible(This,Coords={CoordsR,CoordsC}) isVisible(This,Coords, []). %% @doc See external documentation. +%%
Also:
+%% isVisible(This, Coords, [Option]) -> boolean() when
+%% This::wxGrid(), Coords::{R::integer(), C::integer()},
+%% Option :: {wholeCellVisible, boolean()}.
+%% -spec isVisible(This, Row, Col) -> boolean() when This::wxGrid(), Row::integer(), Col::integer(); (This, Coords, [Option]) -> boolean() when @@ -1538,6 +1550,10 @@ setCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Col) <>). %% @doc See external documentation. +%%
Also:
+%% setCellBackgroundColour(This, Colour, Row, Col) -> ok when
+%% This::wxGrid(), Colour::wx:wx_colour(), Row::integer(), Col::integer().
+%% -spec setCellBackgroundColour(This, Row, Col, Val) -> ok when This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); (This, Colour, Row, Col) -> ok when @@ -1593,6 +1609,10 @@ setCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Col) <>). %% @doc See external documentation. +%%
Also:
+%% setCellTextColour(This, Val, Row, Col) -> ok when
+%% This::wxGrid(), Val::wx:wx_colour(), Row::integer(), Col::integer().
+%% -spec setCellTextColour(This, Row, Col, Val) -> ok when This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); (This, Val, Row, Col) -> ok when @@ -1619,6 +1639,10 @@ setCellValue(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC},S) <>). %% @doc See external documentation. +%%
Also:
+%% setCellValue(This, Val, Row, Col) -> ok when
+%% This::wxGrid(), Val::unicode:chardata(), Row::integer(), Col::integer().
+%% -spec setCellValue(This, Row, Col, S) -> ok when This::wxGrid(), Row::integer(), Col::integer(), S::unicode:chardata(); (This, Val, Row, Col) -> ok when -- cgit v1.2.3