Changeset 851

Timestamp:

11/09/08 05:42:08 (3 years ago)

Author:

szabgab

Message:

add some documentation to Padre::Document

File:

• trunk/lib/Padre/Document.pm (modified) (2 diffs)

trunk/lib/Padre/Document.pm

@@ -1 +1 @@
 package Padre::Document;
 
-# Provides a logical document abstraction, allowing Padre
-# to associate several Wx elements with the one document.
+=head1 NAME
+
+Padre::Document - document abstraction layer
+
+=head1 DESCRIPTION
+
+This is an internal module of L<Padre> that provides a 
+logical document abstraction, allowing Padre to associate 
+several Wx elements with the one document.
+
+The objective would be to allow the use of this module without
+loading Wx.
+
+Currently there are still interdependencies that need to be cleaned.
+
+=head1 METHODS
+
+=cut
 
 use 5.008;
@@ -164 +180 @@
 # Constructor and Accessors
 
+=head2 new
+
+ my $doc = Padre::Document->new(
+        editor   => $editor,
+        filename => $file,
+ );
+ 
+$editor is required and is a Padre::Wx::Editor object
+
+$file is optional and if given it will be loaded in the document
+
+mime-type is defined by the guess_mimetype function
+
+=cut
+
 sub new {
     my $class = shift;