1Test::Spellunker(3)   User Contributed Perl Documentation  Test::Spellunker(3)
2
3
4

NAME

6       Test::Spellunker - check for spelling errors in POD files
7

SYNOPSIS

9           use Test::Spellunker;
10           all_pod_files_spelling_ok();
11

FUNCTIONS

13       all_pod_files_spelling_ok( [@files/@directories] )
14           Checks all the files for POD spelling. It gathers all_pod_files()
15           on each file/directory, and declares a "plan" in Test::More for you
16           (one test for each file), so you must not call "plan" yourself.
17
18           If @files is empty, the function finds all POD files in the blib
19           directory; or the lib, bin and scripts directories if blib does not
20           exist.  A POD file is one that ends with .pod, .pl, .plx, or .pm;
21           or any file where the first line looks like a perl shebang line.
22
23           If you're testing a distribution, just create a t/pod-spell.t with
24           the code in the "SYNOPSIS".
25
26           Returns true if every POD file has correct spelling, or false if
27           any of them fail.  This function will show any spelling errors as
28           diagnostics.
29
30       pod_file_spelling_ok( $filename[, $testname ] )
31           "pod_file_spelling_ok" will test that the given POD file has no
32           spelling errors.
33
34           When it fails, "pod_file_spelling_ok" will show any spelling errors
35           as diagnostics.
36
37           The optional second argument is the name of the test.  If it is
38           omitted, "pod_file_spelling_ok" chooses a default test name "POD
39           spelling for $filename".
40
41       all_pod_files( [@dirs] )
42           Returns a list of all the Perl files in each directory and its
43           subdirectories, recursively. If no directories are passed, it
44           defaults to blib if blib exists, or else lib if not. Skips any
45           files in CVS or .svn directories.
46
47           A Perl file is:
48
49              Any file that ends in .PL, .pl, .plx, .pm, .pod or .t.
50              Any file that has a first line with a shebang and "perl" on it.
51
52           Furthermore, files for which the filter set by
53           "set_pod_file_filter" return false are skipped. By default, this
54           filter passes everything through.
55
56           The order of the files returned is machine-dependent.  If you want
57           them sorted, you'll have to sort them yourself.
58
59       add_stopwords(@words)
60           Add words that should be skipped by the spellcheck. Note that
61           Pod::Spell already skips words believed to be code, such as
62           everything in verbatim (indented) blocks and code marked up with
63           ""..."", as well as some common Perl jargon.
64
65       load_dictionary($filename_or_fh)
66           Load stopwords from $filename_or_fh. You may want to use it as
67           "load_dictionary(\*DATA)".
68

HOW DO I ADD FILE SPECIFIC STOPWORDS?

70       You can put it by following style POD annotation.
71
72           __END__
73
74           =for stopwords foo bar
75
76           =head1 NAME
77
78           ...
79

THANKS TO

81       Inspired from Test::Spelling. And most of document was taken from
82       Test::Spelling.
83
84
85
86perl v5.28.1                      2019-02-02               Test::Spellunker(3)
Impressum