[libnet-dbus-perl] 324/335: Add missing docs for constructors
Intrigeri
intrigeri at moszumanska.debian.org
Sat Mar 21 01:08:16 UTC 2015
This is an automated email from the git hooks/post-receive script.
intrigeri pushed a commit to branch experimental
in repository libnet-dbus-perl.
commit 452a48bedcb535fc5ea67f9011d8757c575f34ef
Author: Daniel Collins <daniel.collins at smoothwall.net>
Date: Mon Mar 16 19:48:24 2015 +0000
Add missing docs for constructors
The Net::DBus->system & Net::DBus->session methods did not
document their arguments
---
lib/Net/DBus.pm | 42 ++++++++++++++++++++++++++++++++++--------
1 file changed, 34 insertions(+), 8 deletions(-)
diff --git a/lib/Net/DBus.pm b/lib/Net/DBus.pm
index 691261b..6941b9e 100644
--- a/lib/Net/DBus.pm
+++ b/lib/Net/DBus.pm
@@ -160,10 +160,23 @@ Return a handle for the system message bus. Note that the
system message bus is locked down by default, so unless appropriate
access control rules are added in /etc/dbus/system.d/, an application
may access services, but won't be able to export services.
-The optional C<params> hash can contain be used to specify
-connection options. The only support option at this time
-is C<nomainloop> which prevents the bus from being automatically
-attached to the main L<Net::DBus::Reactor> event loop.
+
+The optional C<params> hash can be used to specify the following options:
+
+=over
+
+=item nomainloop
+
+If true, prevents the bus from being automatically attached to the main
+L<Net::DBus::Reactor> event loop.
+
+=item private
+
+If true, the socket opened is private; any existing socket will be ignored and
+any future attempts to open the same bus will return a different existing socket
+or open a fresh one.
+
+=back
=cut
@@ -183,10 +196,23 @@ sub system {
=item my $bus = Net::DBus->session(%params);
Return a handle for the session message bus.
-The optional C<params> hash can contain be used to specify
-connection options. The only support option at this time
-is C<nomainloop> which prevents the bus from being automatically
-attached to the main L<Net::DBus::Reactor> event loop.
+
+The optional C<params> hash can be used to specify the following options:
+
+=over
+
+=item nomainloop
+
+If true, prevents the bus from being automatically attached to the main
+L<Net::DBus::Reactor> event loop.
+
+=item private
+
+If true, the socket opened is private; any existing socket will be ignored and
+any future attempts to open the same bus will return a different existing socket
+or open a fresh one.
+
+=back
=cut
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libnet-dbus-perl.git
More information about the Pkg-perl-cvs-commits
mailing list