File 0278-Fix-comments-for-wx.erl-and-wxEvtHandler.erl.patch of Package erlang
From 519e74bc8f7f369a8e06f3b90a12d0d72a980e9d Mon Sep 17 00:00:00 2001
From: Leo Liu <sdl.web@gmail.com>
Date: Fri, 21 Jan 2022 17:16:39 +0800
Subject: [PATCH] Fix comments for wx.erl and wxEvtHandler.erl
---
lib/wx/api_gen/wx_extra/wxEvtHandler.erl | 3 ++-
lib/wx/src/wx.erl | 10 +++++-----
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/lib/wx/api_gen/wx_extra/wxEvtHandler.erl b/lib/wx/api_gen/wx_extra/wxEvtHandler.erl
index 8c1e4279a3..628e22aa9e 100644
--- a/lib/wx/api_gen/wx_extra/wxEvtHandler.erl
+++ b/lib/wx/api_gen/wx_extra/wxEvtHandler.erl
@@ -13,7 +13,7 @@
%% (in another process) to handle the event. The callback should be of
%% arity 2. fun(EventRecord::wx(), EventObject::wxObject()).
%%
-%% Beware that the callback will be in executed in new process each time.
+%% Beware that the callback will be executed in a new process each time.
%%
%% <a href="http://www.wxwidgets.org/manuals/stable/wx_wxevthandler.html">
%% The original documentation</a>.
@@ -51,6 +51,7 @@ connect(This, EventType) ->
%% {skip, boolean()}, If skip is true further event_handlers will be called.
%% This is not used if the 'callback' option is used.
%% Default false.
+%% callback Use `wx_object' callback `handle_sync_event/3'.
%% {callback, function()} Use a callback fun(EventRecord::wx(), EventObject::wxObject())
%% to process the event. Default not specified i.e. a message will
%% be delivered to the process calling this function.
diff --git a/lib/wx/src/wx.erl b/lib/wx/src/wx.erl
index b04d39de8a..efdee74145 100644
--- a/lib/wx/src/wx.erl
+++ b/lib/wx/src/wx.erl
@@ -149,14 +149,14 @@ set_env(#wx_env{sv=Pid} = Env) ->
%% all MacOSX specific events corresponding to MacNewFile() and friends
%% from wxWidgets wxApp https://docs.wxwidgets.org/trunk/classwx_app.html
%%
-%% * `{file_new, ""}`
-%% * `{file_open, Filename}`
-%% * `{file_print, Filename}`
-%% * `{url_open, Url}`
+%% * `{new_file, ""}`
+%% * `{open_file, Filename}`
+%% * `{print_file, Filename}`
+%% * `{open_url, Url}`
%% * `{reopen_app, ""}`
%%
%% The call always returns ok but will have sent any already received
-%% events to the calling process.
+%% events to the calling process.
-spec subscribe_events() -> 'ok'.
subscribe_events() ->
gen_server:call(wxe_master, subscribe_msgs, infinity).
--
2.31.1
