Skip to content
This repository
Browse code

Major documentation overhaul (Pau Amma).

With a few changes from me where the original documentation was confusing,
outdated or just wrong.
  • Loading branch information...
commit 04ad3fe03b3dc7b443c80d3738ff05a802d9e3b1 1 parent a1bb2d4
Paul Johnson authored April 13, 2012
2  docs/TODO
@@ -58,3 +58,5 @@
58 58
   - Examples.
59 59
   - Document cpancover options.
60 60
   - Pod in private modules.
  61
+  - Developer documentation.
  62
+  - Better DB API docs (including writing?).
203  lib/Devel/Cover.pm
@@ -681,7 +681,7 @@ Devel::Cover: Oops, it looks like something went wrong writing the coverage.
681 681
               It's possible that more bad things may happen but we'll try to
682 682
               carry on anyway as if nothing happened.  At a minimum you'll
683 683
               probably find that you are missing coverage.  If you're
684  
-              interrested, the problem was:
  684
+              interested, the problem was:
685 685
 
686 686
 $@
687 687
 
@@ -1315,66 +1315,73 @@ If you want to get coverage for a program:
1315 1315
 
1316 1316
 =head1 DESCRIPTION
1317 1317
 
1318  
-This module provides code coverage metrics for Perl. Code coverage
1319  
-metrics describe how thoroughly tests exercise code. By using
1320  
-Devel::Cover you can discover areas of code not exercised by your tests
1321  
-and determine which tests to create to increase coverage. Code coverage
1322  
-can be considered as an indirect measure of quality.
1323  
-
1324  
-I consider this software to have an alpha status.  By that I mean that I
1325  
-reserve the right to alter the interface in a backwards incompatible manner
1326  
-without incrementing the major version number.  I specifically do not mean
1327  
-that this software is full of bugs or missing key features.  Although I'm
1328  
-making no guarantees on that front either.  In short, if you are looking for
1329  
-code coverage software for Perl, you have probably come to the end of your
1330  
-search.  For more of my opinions on this subject, see
1331  
-http://pjcj.sytes.net/notes/2007/03/14#alpha
1332  
-
1333  
-Code coverage data are collected using a pluggable runops function which
1334  
-counts how many times each op is executed.  These data are then mapped
1335  
-back to reality using the B compiler modules.  There is also a statement
1336  
-profiling facility which needs a better backend to be really useful.
1337  
-This release also includes an experimental mode which replaces ops
1338  
-instead of using a pluggable runops function.  This provides a nice
1339  
-speed increase, but needs better testing before it becomes the default.
1340  
-You probably don't care about any of this.
1341  
-
1342  
-The F<cover> program can be used to generate coverage reports.
1343  
-
1344  
-Statement, branch, condition, subroutine, pod and time coverage information is
1345  
-reported.  Statement coverage data should be reasonable, although there may be
1346  
-some statements which are not reported.  Branch and condition coverage data
1347  
-should be mostly accurate too, although not always what one might initially
1348  
-expect.  Subroutine coverage should be as accurate as statement coverage.  Pod
1349  
-coverage comes from L<Pod::Coverage>.  If L<Pod::Coverage::CountParents> is
1350  
-available it will be used instead.  Coverage data for path coverage are not yet
1351  
-collected.
1352  
-
1353  
-The F<gcov2perl> program can be used to convert gcov files to
1354  
-C<Devel::Cover> databases.
1355  
-
1356  
-You may find that the results don't match your expectations.  I would
1357  
-imagine that at least one of them is wrong.
1358  
-
1359  
-The most appropriate mailing list on which to discuss this module would
1360  
-be perl-qa.  Discussion has migrated there from perl-qa-metrics which is
1361  
-now defunct.  See L<http://lists.perl.org/list/perl-qa.html>.
  1318
+This module provides code coverage metrics for Perl.  Code coverage metrics
  1319
+describe how thoroughly tests exercise code.  By using Devel::Cover you can
  1320
+discover areas of code not exercised by your tests and determine which tests
  1321
+to create to increase coverage.  Code coverage can be considered as an
  1322
+indirect measure of quality.
  1323
+
  1324
+Although it is still being developed, Devel::Cover is now quite stable and
  1325
+provides many of the features to be expected in a useful coverage tool.
  1326
+
  1327
+Statement, branch, condition, subroutine, and pod coverage information is
  1328
+reported.  Statement coverage data should be reasonable.  Branch and condition
  1329
+coverage data should be mostly accurate too, although not always what one
  1330
+might initially expect.  Subroutine coverage should be as accurate as
  1331
+statement coverage.  Pod coverage comes from L<Pod::Coverage>.  If
  1332
+L<Pod::Coverage::CountParents> is available it will be used instead.  Coverage
  1333
+data for other criteria are not yet collected.
  1334
+
  1335
+The F<cover> program can be used to generate coverage reports.  Devel::Cover
  1336
+ships with a number of different reports including various types of HTML
  1337
+output, textual reports, a report to display missing coverage in the same
  1338
+format as compilation errors and a report to display coverage information
  1339
+within the Vim editor.
  1340
+
  1341
+It is possible to add annotations to reports, for example you could add a
  1342
+column to an HTML report showing who last changed a line, as determined by git
  1343
+blame.  Some annotation modules are shipped with Devel::Cover and you can
  1344
+easily create your own.
  1345
+
  1346
+The F<gcov2perl> program can be used to convert gcov files to C<Devel::Cover>
  1347
+databases.  This allows you to display your C or XS code coverage together
  1348
+with your Perl coverage, or to use any of the Devel::Cvoer reports to display
  1349
+your C coverage data.
  1350
+
  1351
+You may find that the coverage results don't match your expectations.  This
  1352
+could be due to a bug in Devel::Cover, but code coverage can be unintuitive to
  1353
+newcomers, and especially so with Perl, so you may want to reconsider your
  1354
+expectations as well.
  1355
+
  1356
+Code coverage data are collected by replacing perl ops with functions which
  1357
+count how many times the ops are executed.  These data are then mapped back to
  1358
+reality using the B compiler modules.  There is also a statement profiling
  1359
+facility which should not be relied on.  For proper profiling use
  1360
+Devel::NYTProf.  Previous versions of Devel::Cover collected coverage data by
  1361
+replacing perl's runops function.  It is still possible to switch to that mode
  1362
+of operation, but this now gets little testing and will probably be removed
  1363
+soon.  You probably don't care about any of this.
  1364
+
  1365
+The most appropriate mailing list on which to discuss this module would be
  1366
+perl-qa.  Discussion has migrated there from perl-qa-metrics which is now
  1367
+defunct.  See L<http://lists.perl.org/list/perl-qa.html>.
1362 1368
 
1363 1369
 The Devel::Cover repository can be found at
1364 1370
 L<http://github.com/pjcj/Devel--Cover>.
1365 1371
 
1366  
-=head1 REQUIREMENTS
  1372
+=head1 REQUIREMENTS AND RECOMMENDED MODULES
  1373
+
  1374
+=head2 REQUIREMENTS
1367 1375
 
1368 1376
 =over
1369 1377
 
1370 1378
 =item * Perl 5.6.1 or greater.  Perl 5.8.8 or greater is recommended.
1371 1379
 
1372  
-Perl 5.7.0 is unsupported.  Perl 5.8.8 or greater is recommended.  Perl
1373  
-5.8.7 has problems and may crash.  Whilst Perl 5.6 should mostly work
1374  
-you will probably miss out on coverage information which would be
1375  
-available using a more modern version and will likely run into bugs in
1376  
-perl.  Different versions of perl may give slightly different results
1377  
-due to changes in the op tree.
  1380
+Perl 5.7 is unsupported.  Perl 5.8.8 or greater is recommended.  Perl 5.8.7
  1381
+has problems and may crash.  Whilst Perl 5.6 should mostly work you will
  1382
+probably miss out on coverage information which would be available using a
  1383
+more modern version and will likely run into bugs in perl.  Different versions
  1384
+of perl may give slightly different results due to changes in the op tree.
1378 1385
 
1379 1386
 =item * The ability to compile XS extensions.
1380 1387
 
@@ -1388,21 +1395,24 @@ that the appropriate tools are installed.
1388 1395
 
1389 1396
 Both are in the core in Perl 5.8.0 and above.
1390 1397
 
1391  
-=item * L<Template> and L<PPI::HTML> or L<Perl::Tidy>
  1398
+=head2 OPTIONAL MODULES
  1399
+
  1400
+=item * L<Template>, and either L<PPI::HTML> or L<Perl::Tidy>
1392 1401
 
1393  
-if you want syntax highlighted HTML reports.
  1402
+Needed if you want syntax highlighted HTML reports.
1394 1403
 
1395  
-=item * L<Pod::Coverage>
  1404
+=item * L<Pod::Coverage> (0.06 or above) or L<Pod::Coverage::CountParents>
1396 1405
 
1397  
-if you want Pod coverage.
  1406
+One is needed if you want Pod coverage.  If L<Pod::Coverage::CountParents> is
  1407
+installed, it is preferred.
1398 1408
 
1399 1409
 =item * L<Test::More>
1400 1410
 
1401  
-in order to run the tests
  1411
+Required if you want to run Devel::Cover's own tests.
1402 1412
 
1403 1413
 =item * L<Test::Warn>
1404 1414
 
1405  
-in order to run some of the tests
  1415
+Some of Devel::Cover's own tests require it.
1406 1416
 
1407 1417
 =item * L<Test::Differences>
1408 1418
 
@@ -1410,6 +1420,14 @@ if the tests fail and you would like nice output telling you why.
1410 1420
 
1411 1421
 =back
1412 1422
 
  1423
+=head2 Use with mod_perl
  1424
+
  1425
+By adding C<use Devel::Cover;> to your mod_perl startup script, you should be
  1426
+able to collect coverage information when running under mod_perl.  You can
  1427
+also add any options you need at this point.  I would suggest adding this as
  1428
+early as possible in your startup script in order to collect as much coverage
  1429
+information as possible.
  1430
+
1413 1431
 =head1 OPTIONS
1414 1432
 
1415 1433
  -blib               - "use blib" and ignore files matching \bt/ (default true
@@ -1435,32 +1453,39 @@ if the tests fail and you would like nice output telling you why.
1435 1453
 =head2 More on Coverage Options
1436 1454
 
1437 1455
 You can specify options to some coverage criteria.  At the moment only pod
1438  
-coverage takes any options.  These are the parameters which are passed into the
1439  
-Pod::Coverage constructor.  The extra options are separated by dashes, and you
1440  
-may specify as many as you wish.  For example, to specify that all subroutines
1441  
-containing xx are private, call Devel::Cover with the option
  1456
+coverage takes any options.  These are the parameters which are passed into
  1457
+the Pod::Coverage constructor.  The extra options are separated by dashes, and
  1458
+you may specify as many as you wish.  For example, to specify that all
  1459
+subroutines containing xx are private, call Devel::Cover with the option
1442 1460
 -coverage,pod-also_private-xx.
1443 1461
 
1444 1462
 =head1 SELECTING FILES TO COVER
1445 1463
 
1446  
-You may select which files you want covered using the select, ignore and inc
1447  
-options.  The system works as follows:
  1464
+You may select the files for which you want to collect coverage data using the
  1465
+select, ignore and inc options.  The system uses the following procedure to
  1466
+decide whether a file will be included in coverage reports:
  1467
+
  1468
+=over
  1469
+
  1470
+=item * If the file matches a RE given as a select option, it will be
  1471
+included.
1448 1472
 
1449  
-Any file matching a RE given as a select option is selected.
  1473
+=item * Otherwise, if it matches a RE given as an ignore option, it won't be
  1474
+included.
1450 1475
 
1451  
-Otherwise, any file matching a RE given as an ignore option is ignored.
  1476
+=item * Otherwise, if it is in one of the inc directories, it won't be
  1477
+included.
1452 1478
 
1453  
-Otherwise, any file in one of the inc directories is ignored.
  1479
+=item * Otherwise, it will be included.
1454 1480
 
1455  
-Otherwise the file is selected.
  1481
+=back
1456 1482
 
1457 1483
 You may add to the REs to select by using +select, or you may reset the
1458  
-selections using -select.  The same principle applies to the REs to
1459  
-ignore.
  1484
+selections using -select.  The same principle applies to the REs to ignore.
1460 1485
 
1461  
-The inc directories are initially populated with the contents of the
1462  
-@INC array at the time Devel::Cover was built.  You may reset these
1463  
-directories using -inc, or add to them using +inc.
  1486
+The inc directories are initially populated with the contents of the @INC
  1487
+array at the time Devel::Cover was built.  You may reset these directories
  1488
+using -inc, or add to them using +inc.
1464 1489
 
1465 1490
 Although these options take regular expressions, you should not enclose the RE
1466 1491
 within // or any other quoting characters.
@@ -1468,14 +1493,16 @@ within // or any other quoting characters.
1468 1493
 =head1 ENVIRONMENT
1469 1494
 
1470 1495
 The -silent option is turned on when Devel::Cover is invoked via
1471  
-$HARNESS_PERL_SWITCHES or $PERL5OPT.  Devel::Cover tries to do the right
1472  
-thing when $MOD_PERL is set.  $DEVEL_COVER_OPTIONS is appended to any
1473  
-options passed into Devel::Cover.
  1496
+$HARNESS_PERL_SWITCHES or $PERL5OPT.  Devel::Cover tries to do the right thing
  1497
+when $MOD_PERL is set.  $DEVEL_COVER_OPTIONS is appended to any options passed
  1498
+into Devel::Cover.
1474 1499
 
1475 1500
 When running Devel::Cover's own test suite, $DEVEL_COVER_DEBUG turns on
1476  
-debugging information, $DEVEL_COVER_GOLDEN_VERSION overrides
1477  
-Devel::Cover's own idea of which golden results it should test against,
1478  
-and $DEVEL_COVER_NO_COVERAGE runs the tests without collecting coverage.
  1501
+debugging information, $DEVEL_COVER_GOLDEN_VERSION overrides Devel::Cover's
  1502
+own idea of which golden results it should test against, and
  1503
+$DEVEL_COVER_NO_COVERAGE runs the tests without collecting coverage.  The
  1504
+environment variables described in this paragraph are of interest to
  1505
+Devel::Cover maintainers only.
1479 1506
 
1480 1507
 =head1 ACKNOWLEDGEMENTS
1481 1508
 
@@ -1545,14 +1572,6 @@ Modules used by Devel::Cover while gathering coverage:
1545 1572
 
1546 1573
 =back
1547 1574
 
1548  
-=head2 mod_perl
1549  
-
1550  
-By adding C<use Devel::Cover;> to your mod_perl startup script, you
1551  
-should be able to collect coverage information when running under
1552  
-mod_perl.  You can also add any options you need at this point.  I would
1553  
-suggest adding this as early as possible in your startup script in order
1554  
-to collect as much coverage information as possible.
1555  
-
1556 1575
 =head2 Redefined subroutines
1557 1576
 
1558 1577
 If you redefine a subroutine you may find that the original subroutine is not
@@ -1563,15 +1582,17 @@ CV.  Hints, tips or patches to resolve this will be gladly accepted.
1563 1582
 
1564 1583
 Almost certainly.
1565 1584
 
1566  
-See the BUGS file.  And the TODO file.
  1585
+See the BUGS file, the TODO file and the bug trackers at
  1586
+https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-Cover and
  1587
+https://github.com/pjcj/Devel--Cover/issues?sort=created&direction=desc&state=open
1567 1588
 
1568 1589
 =head1 LICENCE
1569 1590
 
1570  
-Copyright 2001-2011, Paul Johnson (pjcj@cpan.org)
  1591
+Copyright 2001-2012, Paul Johnson (pjcj@cpan.org)
1571 1592
 
1572 1593
 This software is free.  It is licensed under the same terms as Perl itself.
1573 1594
 
1574  
-The latest version of this software should be available from my homepage:
1575  
-http://www.pjcj.net
  1595
+The latest version of this software should be available on CPAN and from my
  1596
+homepage: http://www.pjcj.net/.
1576 1597
 
1577 1598
 =cut
2  lib/Devel/Cover/Annotation/Git.pm
@@ -136,7 +136,7 @@ Devel::Cover::Annotation::Git - Annotate with git information
136 136
 
137 137
 =head1 SYNOPSIS
138 138
 
139  
- cover -report xxx -annotation git
  139
+ cover -report text -annotation git  # Or any other report type
140 140
 
141 141
 =head1 DESCRIPTION
142 142
 
2  lib/Devel/Cover/Annotation/Random.pm
@@ -86,7 +86,7 @@ Devel::Cover::Annotation::Random - Example annotation for formatters
86 86
 
87 87
 =head1 SYNOPSIS
88 88
 
89  
- cover -report xxx -annotation random -count 3
  89
+ cover -report text -annotation random -count 3  # Or any other report type
90 90
 
91 91
 =head1 DESCRIPTION
92 92
 
4  lib/Devel/Cover/Annotation/Svk.pm
@@ -51,7 +51,7 @@ sub new
51 51
     while (<$c>)
52 52
     {
53 53
         chomp;
54  
-        s{^\Q$self->{depotbase}\E/}{};
  54
+        s|^\Q$self->{depotbase}\E/||;
55 55
         next unless -f $_;
56 56
 
57 57
         open my $f, $_ or warn "cover: Can't open $_: $!\n", next;
@@ -158,7 +158,7 @@ Devel::Cover::Annotation::Svk - Annotate with svk information
158 158
 
159 159
 =head1 SYNOPSIS
160 160
 
161  
- cover -report xxx -annotation svk
  161
+ cover -report text -annotation svk  # Or any other report type
162 162
 
163 163
 =head1 DESCRIPTION
164 164
 
41  lib/Devel/Cover/DB.pm
@@ -973,10 +973,6 @@ Devel::Cover::DB - Code coverage metrics for Perl
973 973
 
974 974
 This module provides access to a database of code coverage information.
975 975
 
976  
-=head1 SEE ALSO
977  
-
978  
- Devel::Cover
979  
-
980 976
 =head1 METHODS
981 977
 
982 978
 =head2 new
@@ -1009,13 +1005,26 @@ data may be accessed.
1009 1005
      }
1010 1006
  }
1011 1007
 
1012  
-Data for different criteria will be in different formats, so that will
1013  
-need special handling, but I'll deal with that when we have the data for
1014  
-different criteria.
  1008
+Data for different criteria will be in different formats, so that will need
  1009
+special handling.  This is not yet documented so your best bet for now is to
  1010
+look at some of the simpler reports and/or the source.
  1011
+
  1012
+The methods in the above example are actually aliases for methods in
  1013
+Devel::Cover::DB::Base (the base class for all Devel::Cover::DB::* classes):
  1014
+
  1015
+=over
  1016
+
  1017
+=item * Devel::Cover::DB::Base->values
1015 1018
 
1016  
-If you don't want to remember all the method names, use values() instead
1017  
-of files(), criteria() and locations() and get() instead of file(),
1018  
-criterion() and location().
  1019
+Aliased to Devel::Cover::DB::Cover->files, Devel::Cover::DB::File->criteria,
  1020
+Devel::Cover::DB::Criterion->locations, and Devel::Cover::DB::Location->data
  1021
+
  1022
+=item * Devel::Cover::DB::Base->get
  1023
+
  1024
+Aliased to Devel::Cover::DB::Cover->file, Devel::Cover::DB::File->criteriom,
  1025
+Devel::Cover::DB::Criterion->location, and Devel::Cover::DB::Location->datum
  1026
+
  1027
+=back
1019 1028
 
1020 1029
 Instead of calling $file->criterion("x") you can also call $file->x.
1021 1030
 
@@ -1023,8 +1032,16 @@ Instead of calling $file->criterion("x") you can also call $file->x.
1023 1032
 
1024 1033
  my $valid = $db->is_valid;
1025 1034
 
1026  
-Returns true iff the db is valid.  (Actually there is one too many fs there, but
1027  
-that's what it should do.)
  1035
+Returns true if $db is valid (or looks valid, the function is too lax).
  1036
+
  1037
+=head1 SEE ALSO
  1038
+
  1039
+ Devel::Cover
  1040
+ Devel::Cover::DB::Base
  1041
+ Devel::Cover::DB::Cover
  1042
+ Devel::Cover::DB::File
  1043
+ Devel::Cover::DB::Criterion
  1044
+ Devel::Cover::DB::Location
1028 1045
 
1029 1046
 =head1 BUGS
1030 1047
 
1  lib/Devel/Cover/DB/Digests.pm
@@ -113,6 +113,7 @@ This module stores digests for Devel::Cover::DB.
113 113
 =head1 SEE ALSO
114 114
 
115 115
  Devel::Cover
  116
+ Devel::Cover::DB
116 117
 
117 118
 =head1 METHODS
118 119
 
2  lib/Devel/Cover/DB/IO/Storable.pm
@@ -74,7 +74,7 @@ Contructs the IO object.
74 74
 
75 75
  my $data = $io->read($file);
76 76
 
77  
-Returns a perl data structure representingthe data read from $file.
  77
+Returns a perl data structure representing the data read from $file.
78 78
 
79 79
 =head2 write
80 80
 
3  lib/Devel/Cover/DB/Structure.pm
@@ -389,7 +389,7 @@ __END__
389 389
 
390 390
 =head1 NAME
391 391
 
392  
-Devel::Cover::DB::Structure - Code coverage metrics for Perl
  392
+Devel::Cover::DB::Structure - Internal: abstract structure of a source file
393 393
 
394 394
 =head1 SYNOPSIS
395 395
 
@@ -400,6 +400,7 @@ Devel::Cover::DB::Structure - Code coverage metrics for Perl
400 400
 =head1 SEE ALSO
401 401
 
402 402
  Devel::Cover
  403
+ Devel::Cover::DB
403 404
 
404 405
 =head1 METHODS
405 406
 
2  lib/Devel/Cover/Op.pm
@@ -98,7 +98,7 @@ Devel::Cover::Op - B::Concise with coverage data
98 98
 =head1 DESCRIPTION
99 99
 
100 100
 This module works as if calling B::Concise but also outputs coverage
101  
-information.  It's primary purpose is to aid in the development of Devel::Cover.
  101
+information.  Its primary purpose is to aid in the development of Devel::Cover.
102 102
 
103 103
 See comments in Cover.xs (especially set_conditional()) to aid in interpreting
104 104
 the output.
4  lib/Devel/Cover/Report/Html.pm
@@ -25,9 +25,7 @@ statistics
25 25
 
26 26
 =head1 SYNOPSIS
27 27
 
28  
- use Devel::Cover::Report::Html;
29  
-
30  
- Devel::Cover::Report::Html->report($db, $options);
  28
+ cover -report html
31 29
 
32 30
 =head1 DESCRIPTION
33 31
 
4  lib/Devel/Cover/Report/Html_basic.pm
@@ -772,9 +772,7 @@ statistics
772 772
 
773 773
 =head1 SYNOPSIS
774 774
 
775  
- use Devel::Cover::Report::Html_basic;
776  
-
777  
- Devel::Cover::Report::Html_basic->report($db, $options);
  775
+ cover -report html_basic
778 776
 
779 777
 =head1 DESCRIPTION
780 778
 
18  lib/Devel/Cover/Report/Html_minimal.pm
@@ -742,9 +742,7 @@ statistics
742 742
 
743 743
 =head1 SYNOPSIS
744 744
 
745  
- use Devel::Cover::Report::Html_minimal;
746  
-
747  
- Devel::Cover::Report::Html_minimal->report($db, $options);
  745
+ cover -report html_minimal
748 746
 
749 747
 =head1 DESCRIPTION
750 748
 
@@ -769,26 +767,26 @@ directory.
769 767
 
770 768
 =item pod
771 769
 
772  
-Includes POD (and blank lines) in the file report. This is on by default.  It
  770
+Includes POD (and blank lines) in the file report.  This is on by default.  It
773 771
 may be turned off with -nopod.
774 772
 
775 773
 =item data
776 774
 
777  
-Includes text after the C<__DATA__> or C<__END__> tokens in the file report. By
  775
+Includes text after the C<__DATA__> or C<__END__> tokens in the file report.  By
778 776
 default, this text is trimmed.
779 777
 
780 778
 Note: If your POD is after an C<__END__>, you have to specify 'data' to include
781  
-it, not 'pod'. The 'pod' option only applies to POD before the C<__END__>.
  779
+it, not 'pod'.  The 'pod' option only applies to POD before the C<__END__>.
782 780
 
783 781
 =item unified
784 782
 
785  
-Generates a "unified" report for each file. The detailed data that normally
786  
-appears in the auxilliary reports (branch, condition, etc.) is placed in the
787  
-file report, and the auxilliarry reports are not generated.
  783
+Generates a "unified" report for each file.  The detailed data that normally
  784
+appears in the auxiliary reports (branch, condition, etc.) are placed in the
  785
+file report, and the auxiliary reports are not generated.
788 786
 
789 787
 =item summarytitle
790 788
 
791  
-Specify the tile of the summary.  The default is "Coverage Summary".
  789
+Specify the title of the summary.  The default is "Coverage Summary".
792 790
 
793 791
 =back
794 792
 
4  lib/Devel/Cover/Report/Html_subtle.pm
@@ -706,9 +706,7 @@ statistics
706 706
 
707 707
 =head1 SYNOPSIS
708 708
 
709  
- use Devel::Cover::Report::Html_subtle;
710  
-
711  
- Devel::Cover::Report::Html_subtle->report($db, $options);
  709
+ cover -report html_subtle
712 710
 
713 711
 =head1 DESCRIPTION
714 712
 
6  lib/Devel/Cover/Report/Text2.pm
@@ -167,14 +167,12 @@ __END__
167 167
 
168 168
 =head1 NAME
169 169
 
170  
-Devel::Cover::Report::Text - Backend for textual reporting of coverage
  170
+Devel::Cover::Report::Test2 - Backend for textual reporting of coverage
171 171
 statistics
172 172
 
173 173
 =head1 SYNOPSIS
174 174
 
175  
- use Devel::Cover::Report::Text;
176  
-
177  
- Devel::Cover::Report::Text->report($db, $options);
  175
+ cover -report text2
178 176
 
179 177
 =head1 DESCRIPTION
180 178
 

0 notes on commit 04ad3fe

Please sign in to comment.
Something went wrong with that request. Please try again.