Changeset 10624

Timestamp:

02/08/10 12:51:11 (4 weeks ago)

Author:

azawawi

Message:

More POD fixes

Files:

• trunk/Padre/lib/Padre/Wx/Directory/OpenInFileBrowserAction.pm (modified) (5 diffs)

trunk/Padre/lib/Padre/Wx/Directory/OpenInFileBrowserAction.pm

@@ -1 +1 @@
 package Padre::Wx::Directory::OpenInFileBrowserAction;
+
+=head1 NAME
+
+Padre::Wx::Directory::OpenInFileBrowserAction - Open in file browser action
+
+=head1 DESCRIPTION
+
+For the current saved Padre document, open the platform's file manager/browser and
+tries to select it if possible. On win32, opens the containing folder and
+selects the file in its explorer. On Linux KDE/GNOME, opens the containing folder
+for it.
+
+=head1 FUNCTIONS
+
+=cut
 
 use 5.008;
@@ -51 +66 @@
 }
 
-#
-# Opens the provided filename in the File browser:
-# On win32, selects it in Windows Explorer
-# On linux, opens the containing folder for it
-#
+=head2 C<open_in_file_browser>
+
+  $action->open_in_file_browser($filename);
+
+Opens the provided C<$filename> in the file browser
+On win32, selects it in Windows Explorer
+On UNIX, opens the containing folder for it using either KDE or GNOME
+
+=cut
+
 sub open_in_file_browser {
         my ( $self, $filename ) = @_;
@@ -87 +107 @@
 }
 
-#
-# Open with default system editor
-#
+=head2 C<open_with_default_system_editor>
+
+  $action->open_in_file_browser($filename);
+
+Opens the provided C<$filename> using the default system editor
+
+=cut
+
 sub open_with_default_system_editor {
         my ( $self, $filename ) = @_;
@@ -128 +153 @@
 
 #
-# Try to execute a file in KDE or GNOME
+# Private method to execute a file in KDE or GNOME
 #
 sub _execute_unix {
@@ -155 +180 @@
 __END__
 
-=head1 NAME
-
-Padre::Wx::Directory::OpenInFileBrowserAction - Open in file browser action
-
-=head1 DESCRIPTION
-
-=head2 Open in File Browser
-
-For the current saved Padre document, open the platform's file manager/browser and
-tries to select it if possible. On win32, opens the containing folder and
-selects the file in its explorer. On Linux KDE/GNOME, opens the containing folder
-for it.
-
-=head1 AUTHOR
-
-Ahmad M. Zawawi C<< <ahmad.zawawi at gmail.com> >>
+=pod
 
 =head1 COPYRIGHT & LICENSE