diff --git a/Prima/sys/AnyEvent.pm b/Prima/sys/AnyEvent.pm index a4aa2495e..1c286cace 100644 --- a/Prima/sys/AnyEvent.pm +++ b/Prima/sys/AnyEvent.pm @@ -61,6 +61,10 @@ sub poll { $::application->yield } push @AnyEvent::REGISTRY, ["Prima", __PACKAGE__ ]; +1; + +=pod + =head1 NAME Prima::sys::AnyEvent - AnyEvent bridge @@ -91,5 +95,3 @@ Dmitry Karasik F =cut - -1; diff --git a/Prima/sys/FS.pm b/Prima/sys/FS.pm index 705a588c2..dcf76cd34 100644 --- a/Prima/sys/FS.pm +++ b/Prima/sys/FS.pm @@ -272,9 +272,9 @@ Since perl win32 unicode support for files is unexistent, Prima has its own parallel set of functions mimicking native functions, ie open, chdir etc. This means that files with names that cannot be converted to ANSI (ie user-preferred) codepage are not visible in perl, but the functions below -mitigate that problem. +mitigate this problem. -This module exports the unicode-aware functions from C to override +The module exports the unicode-aware functions from C to override the core functions. Read more in L. =head2 SYNOPSIS diff --git a/Prima/sys/Test.pm b/Prima/sys/Test.pm index cf51b2033..4e0f9de7e 100644 --- a/Prima/sys/Test.pm +++ b/Prima/sys/Test.pm @@ -61,8 +61,8 @@ Prima::sys::Test - GUI test tools =head1 DESCRIPTION -The module contains a small set or tool used for testing of -Prima-related code together with standard perl C suite. +The module contains a small set of tools used for testing of +Prima-related code together with the standard perl C suite. =head1 SYNOPSIS @@ -79,11 +79,11 @@ Prima-related code together with standard perl C suite. =item create_window %args -Creates a standard simple Prima window, returns its handle +Creates and returns a standard simple Prima window =item set_flag,get_flag,reset_flag -These manipulate the state of an internal C<$flag> that stops event loop when set. +These manipulate the state of the internal C<$flag> that stops the event loop when set. =item wait_flag @@ -93,7 +93,7 @@ Waits for the flag to be raised in 500 msec, or returns false. =head2 no-X11 environment -By default fires skip_all condition if running without X11 connection. If the test +By default fires skip_all condition if running without an X11 connection. If the test can be ran without X11, use as: use Prima::Test qw(noX11); diff --git a/Prima/sys/XQuartz.pm b/Prima/sys/XQuartz.pm index 0253f17c4..42f55ba7f 100644 --- a/Prima/sys/XQuartz.pm +++ b/Prima/sys/XQuartz.pm @@ -32,25 +32,28 @@ FALLBACK: 1; +=pod + =head1 NAME Prima::sys::XQuartz - MacOSX/XQuartz facilities =head1 DESCRIPTION -XQuartz emulates X environment with certain limits, namely it cannot grab bits -from the screen, and it hides top-level menu from screen coordinates accessible -for X clients. For example, a Mac with 1024x768 resolution will only report -f.ex. 1024x746 size to Prima. If Prima is compiled with Cocoa library, -C method circumvents these limitations and returns shot -of the whole screen. - -Note that the screen grabbing has to be allowed. To do that, Choose Apple menu, -System Preferences, click Security & Privacy, then click Privacy. Click on an -icon on the left lower corner to allow changes. Then, in the screen recording -tab, add XQuartz to the list of allowed applications. Note that it might not -work if you run your application from a (remote) ssh session - I couldn't find -how to a how to enable screen grabbing for sshd. +XQuartz emulates the X11 environment with certain limits, namely, it cannot grab bits +from the screen, and it also hides the top-level menu from screen coordinates accessible +for X11 clients. For example, a Mac with 1024x768 resolution will only report +f.ex. 1024x746 size to Prima. If Prima is compiled with the Cocoa library, +the C method circumvents these limitations and returns a shot +of the whole screen, including the application menu. + +Note that screen grabbing has to be allowed by the user or the +administrator. To do that, Choose the Apple menu, System Preferences, click +Security & Privacy, then click Privacy. Click on an icon on the left lower +corner to allow changes. Then, in the screen recording tab, add XQuartz to the +list of allowed applications. Note that it might not work if you run your +application from a (remote) ssh session - I couldn't find how to +enable screen grabbing for sshd. =head1 AUTHOR diff --git a/Prima/sys/gtk/FileDialog.pm b/Prima/sys/gtk/FileDialog.pm index b75ca11dc..69896a6dd 100644 --- a/Prima/sys/gtk/FileDialog.pm +++ b/Prima/sys/gtk/FileDialog.pm @@ -306,15 +306,17 @@ sub profile_default 1; +=pod + =head1 NAME -Prima::sys::gtk::FileDialog - GTK file system dialogs. +Prima::sys::gtk::FileDialog - GTK file system dialogs =head1 DESCRIPTION -The module mimics Prima file dialog classes C and +The module mimics the Prima file dialog classes C and C, defined in L. The class names -registered in the module are the same, but in C namespace. +registered in the module are the same, but in the C namespace. =head1 AUTHOR diff --git a/Prima/sys/win32.pm b/Prima/sys/win32.pm index 352dd91eb..3d7dfdfe3 100644 --- a/Prima/sys/win32.pm +++ b/Prima/sys/win32.pm @@ -20,6 +20,8 @@ sub ReadConsoleInput 1; +=pod + =head1 NAME Prima::sys::win32 - Windows facilities @@ -36,7 +38,8 @@ Miscellaneous semi-hackish calls to win32 API See https://learn.microsoft.com/en-us/windows/console/readconsoleinputex . -Returns hash of a single input event if there are 1 or more, empty list otherwise. +Returns a hash with information about a single input event if there are 1 or +more, or an empty list otherwise. =back diff --git a/Prima/sys/win32/FileDialog.pm b/Prima/sys/win32/FileDialog.pm index ae80ecf16..fda825c8a 100644 --- a/Prima/sys/win32/FileDialog.pm +++ b/Prima/sys/win32/FileDialog.pm @@ -268,15 +268,17 @@ sub profile_default 1; +=pod + =head1 NAME Prima::sys::win32::FileDialog - Windows file system dialogs. =head1 DESCRIPTION -The module mimics Prima file dialog classes C +The module mimics the Prima file dialog classes C and C, defined in L. The -class names registered in the module are the same, but in C +class names registered in the module are the same, but in the C namespace. =head1 AUTHOR