From 6b495675c81a7517c0d84e21bc573ba3a1df1a7d Mon Sep 17 00:00:00 2001
From: Dan Gudmundsson <dgud@erlang.org>
Date: Mon, 4 Jul 2016 16:18:59 +0200
Subject: wx: Add missing specs

Some taylormade functions still used edoc spec's, and some
where wrong which caused broken links.
Change them to be real spec's and correct the types.
---
 lib/wx/api_gen/wx_extra/wxListCtrl.erl | 62 ++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 29 deletions(-)

(limited to 'lib/wx/api_gen/wx_extra/wxListCtrl.erl')

diff --git a/lib/wx/api_gen/wx_extra/wxListCtrl.erl b/lib/wx/api_gen/wx_extra/wxListCtrl.erl
index acdb69fdeb..355a4cdfd1 100644
--- a/lib/wx/api_gen/wx_extra/wxListCtrl.erl
+++ b/lib/wx/api_gen/wx_extra/wxListCtrl.erl
@@ -43,33 +43,36 @@ SortItems>>
 <<EXPORT:wxListCtrl new/0, new/1, new/2 wxListCtrl:EXPORT>>
 
 <<wxListCtrl_new_0
-%% @spec () -> wxListCtrl()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlwxlistctrl">external documentation</a>.
+-spec new() -> wxListCtrl().
 new() ->
     wxe_util:construct(~s, <<>>).
 wxListCtrl_new_0>>
 
 <<wxListCtrl_new_2
-%% @spec (Parent::wxWindow:wxWindow()) -> wxListCtrl()
-%% @equiv new(Parent, [])
+-spec new(Parent) -> wxListCtrl() when
+      Parent::wxWindow:wxWindow().
 new(Parent)
  when is_record(Parent, wx_ref) ->
   new(Parent, []).
 
-%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxListCtrl()
-%% Option = {winid, integer()} |
-%%          {pos, {X::integer(),Y::integer()}} |
-%%          {size, {W::integer(),H::integer()}} |
-%%          {style, integer()} |
-%%          {validator, wx:wx()} |
-%%          {onGetItemText, OnGetItemText} |
-%%          {onGetItemAttr, OnGetItemAttr} |
-%%          {onGetItemColumnImage, OnGetItemColumnImage}
+%% @doc Creates a listctrl with optional callback functions:
 %%
-%% OnGetItemText = (This, Item, Column) -> wxString()
-%% OnGetItemAttr = (This, Item) -> wxListItemAttr()
+%% OnGetItemText = (This, Item, Column) -> unicode:charlist()
+%% OnGetItemAttr = (This, Item) -> wxListItemAttr:wxListItemAttr()
 %% OnGetItemColumnImage = (This, Item, Column) -> integer()
-%% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlwxlistctrl">external documentation</a>.
+%%
+%% See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlwxlistctrl">external documentation</a>.
+-spec new(Parent, [Option]) -> wxListCtrl() when
+      Parent::wxWindow:wxWindow(),
+      Option::{winid, integer()} |
+	      {pos, {X::integer(),Y::integer()}} |
+	      {size, {W::integer(),H::integer()}} |
+	      {style, integer()} |
+	      {validator, wx:wx_object()} |
+	      {onGetItemText, function()} |
+	      {onGetItemAttr, function()} |
+	      {onGetItemColumnImage, function()}.
 
 new(#wx_ref{type=ParentT,ref=ParentRef}, Options)
   when is_list(Options)->
@@ -101,26 +104,27 @@ wxListCtrl_new_2>>
 <<EXPORT:Create create/2, create/3 Create:EXPORT>>
 
 <<Create
-%% @spec (This::wxListCtrl(), Parent::wxWindow:wxWindow()) -> bool()
 %% @equiv create(This,Parent, [])
+-spec create(This, Parent) -> wxListCtrl() when
+      This::wxWindow:wxWindow(),
+      Parent::wxWindow:wxWindow().
 create(This,Parent)
  when is_record(This, wx_ref),is_record(Parent, wx_ref) ->
   create(This,Parent, []).
 
-%% @spec (This::wxListCtrl(), Parent::wxWindow:wxWindow(), [Option]) -> bool()
-%% Option = {winid, integer()} |
-%%          {pos, {X::integer(),Y::integer()}} |
-%%          {size, {W::integer(),H::integer()}} |
-%%          {style, integer()} |
-%%          {validator, wx:wx()} |
-%%          {onGetItemText, OnGetItemText} |
-%%          {onGetItemAttr, OnGetItemAttr} |
-%%          {onGetItemColumnImage, OnGetItemColumnImage}
-%%
-%% OnGetItemText = (This, Item, Column) -> wxString()
-%% OnGetItemAttr = (This, Item) -> wxListItemAttr()
-%% OnGetItemColumnImage = (This, Item, Column) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlcreate">external documentation</a>.
+-spec create(This, Parent, [Option]) -> wxListCtrl() when
+      This::wxWindow:wxWindow(),
+      Parent::wxWindow:wxWindow(),
+      Option::{winid, integer()} |
+	      {pos, {X::integer(),Y::integer()}} |
+	      {size, {W::integer(),H::integer()}} |
+	      {style, integer()} |
+	      {validator, wx:wx_object()} |
+	      {onGetItemText, function()} |
+	      {onGetItemAttr, function()} |
+	      {onGetItemColumnImage, function()}.
+
 create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options)
  when is_list(Options) ->
   ?CLASS(ThisT,wxListCtrl),
-- 
cgit v1.2.3