Commits

Anonymous committed 67fca85

Added t/pod-coverage.t and made sure the files have full POD coverage.

  • Participants
  • Parent commits 82dc0a5

Comments (0)

Files changed (5)

File perl/modules/XML-SemanaticDiff/Changes

     - Added t/pod.t. (Kwalitee).
         - fixed the POD in the process.
     - Created a Build.PL script based on the Makefile.PL in order to
-    make sure the META.yml is according to the SPEC. (Kwalitee).
+      make sure the META.yml is according to the SPEC. (Kwalitee).
+    - Added the t/pod-coverage.t file and made sure the files have
+      full POD coverage. (Kwalitee)
 
 0.96  July 03 2007
     - Fixed the warning emitted with the namespaces being undefined.

File perl/modules/XML-SemanaticDiff/MANIFEST

 t/10wide-chars.t
 t/11tag-in-different-locations.t
 t/12missing-element-has-o-as-cdata.t
+t/pod-coverage.t
 t/pod.t

File perl/modules/XML-SemanaticDiff/lib/XML/SemanticDiff.pm

 
 =back
 
+=head2 @results = $differ->compare($xml1, $xml2)
+
+Compares the XMLs $xml1 and $xml2 . $xml1 and $xml2 can be:
+
+=over 4
+
+=item * filenames
+
+This will be considered if it is a string that does not contain newlines and 
+exists in the filesystem.
+
+=item * the XML text itself.
+
+This will be considered if it's any kind of string.
+
+=item * the results of read_xml(). (see below)
+
+This will be considered if it's a hash reference.
+
+B<TODO>: change according to the spec.
+
+=back
+
+=head2 my $doc = read_xml($xml_location)
+
+This will read the XML, process it for comparison and return it. See compare()
+for how it is determined.
+
+B<TODO>: change according to the spec.
+
 =head1 CUSTOM HANDLERS
 
 Internally, XML::SemanticDiff uses an event-based model somewhat reminiscent of SAX where the various 'semantic diff events'

File perl/modules/XML-SemanaticDiff/lib/XML/SemanticDiff/BasicHandler.pm

 }
 
 1;
+
 __END__
-# Below is the stub of documentation for your module. You better edit it!
 
 =head1 NAME
 
 
 Please run perldoc XML::SemanticDiff for more information.
 
+=head1 IMPLEMENTED METHODS (FOR INTERNAL USE)
+
+=head2 new
+=head2 rogue_element
+=head2 missing_element
+=head2 element_value
+=head2 rogue_attribute
+=head2 missing_attribute
+=head2 attribute_value
+=head2 namespace_uri
+=head2 parent_and_name
+
 =head1 AUTHOR
 
 Kip Hampton khampton@totalcinema.com

File perl/modules/XML-SemanaticDiff/t/pod-coverage.t

+#!perl -T
+
+use Test::More;
+eval "use Test::Pod::Coverage 1.04";
+plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" if $@;
+all_pod_coverage_ok();