From c0f3e6ac4d3b810dc2b6c92a80a74d8a6b04ce9b Mon Sep 17 00:00:00 2001
From: Jesse Luehrs <doy@tozt.net>
Date: Fri, 19 Feb 2010 17:13:54 -0600
Subject: add docs

---
 lib/Locale/POFileManager/File.pm | 42 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'lib/Locale/POFileManager/File.pm')

diff --git a/lib/Locale/POFileManager/File.pm b/lib/Locale/POFileManager/File.pm
index e5e8267..7e7fc3d 100644
--- a/lib/Locale/POFileManager/File.pm
+++ b/lib/Locale/POFileManager/File.pm
@@ -40,10 +40,27 @@ manipulating the translation entries in it.
 
 =head2 new
 
+Accepts a hash of arguments:
+
+=over 4
+
+=item file
+
+The name of the file this represents. Required.
+
+=item stub_msgstr
+
+The msgstr to insert when adding stubs to language files. This can be either a
+literal string, or a coderef which accepts a hash containing the keys C<msgid>
+and C<lang>. Optional.
+
 =cut
 
 =head2 file
 
+Returns a L<Path::Class::File> object corresponding to the C<file> passed to
+the constructor.
+
 =cut
 
 has file => (
@@ -55,6 +72,8 @@ has file => (
 
 =head2 stub_msgstr
 
+Returns the C<stub_msgstr> passed to the constructor.
+
 =cut
 
 has stub_msgstr => (
@@ -64,14 +83,23 @@ has stub_msgstr => (
 
 =head2 entries
 
+Returns a list of L<Locale::PO> objects corresponding to translation entries in
+the file.
+
 =cut
 
 =head2 add_entry
 
+Adds a new translation entry to the file. This can be provided either as a
+L<Locale::PO> object directly, or as a hash of options to pass to the
+L<Locale::PO> constructor (except without the leading dashes).
+
 =cut
 
 =head2 msgids
 
+Returns a list of msgids found in the file.
+
 =cut
 
 has entries => (
@@ -109,6 +137,8 @@ sub add_entry {
 
 =head2 entry_for
 
+Returns the L<Locale::PO> object corresponding to the given msgid.
+
 =cut
 
 sub entry_for {
@@ -119,6 +149,8 @@ sub entry_for {
 
 =head2 save
 
+Writes the current contents of the file back out to disk.
+
 =cut
 
 sub save {
@@ -129,6 +161,8 @@ sub save {
 
 =head2 language
 
+Returns the language that this file corresponds to.
+
 =cut
 
 sub language {
@@ -140,6 +174,10 @@ sub language {
 
 =head2 find_missing_from
 
+Takes another translation file (either as a filename or as a
+L<Locale::POFileManager::File> object), and returns a list of msgids that the
+given file contains that this file doesn't.
+
 =cut
 
 sub find_missing_from {
@@ -158,6 +196,10 @@ sub find_missing_from {
 
 =head2 add_stubs_from
 
+Takes another translation file (either as a filename or as a
+L<Locale::POFileManager::File> object), and adds stubs for each msgid that the
+given file contains that this file doesn't.
+
 =cut
 
 sub add_stubs_from {
-- 
cgit v1.2.3-54-g00ecf