From 608e2b836a17ade2c58b82348bcd25f8b5d4a352 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Fri, 29 Jan 2021 00:03:58 +0100 Subject: [PATCH] Added pod start tag and cut as end where missing --- lib/Workflow/Action.pm | 4 ++++ lib/Workflow/Action/InputField.pm | 2 ++ lib/Workflow/Action/Mailer.pm | 2 ++ lib/Workflow/Action/Null.pm | 4 +++- lib/Workflow/Base.pm | 4 ++++ lib/Workflow/Condition.pm | 2 ++ lib/Workflow/Condition/Evaluate.pm | 4 ++++ lib/Workflow/Condition/HasUser.pm | 4 ++++ lib/Workflow/Config.pm | 4 ++++ lib/Workflow/Config/Perl.pm | 4 ++++ lib/Workflow/Config/XML.pm | 4 ++++ lib/Workflow/Context.pm | 4 ++++ lib/Workflow/Exception.pm | 2 ++ lib/Workflow/Factory.pm | 1 + lib/Workflow/History.pm | 2 ++ lib/Workflow/Manual/Configuration.pod | 3 +++ lib/Workflow/Manual/Overview.pod | 4 ++++ lib/Workflow/Persister.pm | 2 ++ lib/Workflow/Persister/DBI.pm | 2 ++ lib/Workflow/Persister/DBI/AutoGeneratedId.pm | 2 ++ lib/Workflow/Persister/DBI/ExtraData.pm | 2 ++ lib/Workflow/Persister/DBI/SequenceId.pm | 2 ++ lib/Workflow/Persister/File.pm | 2 ++ lib/Workflow/Persister/RandomId.pm | 4 ++++ lib/Workflow/Persister/SPOPS.pm | 2 ++ lib/Workflow/Persister/UUID.pm | 4 ++++ lib/Workflow/State.pm | 2 ++ lib/Workflow/Validator.pm | 4 ++++ lib/Workflow/Validator/HasRequiredField.pm | 2 ++ lib/Workflow/Validator/InEnumeratedType.pm | 4 +++- lib/Workflow/Validator/MatchesDateFormat.pm | 4 ++++ 31 files changed, 90 insertions(+), 2 deletions(-) diff --git a/lib/Workflow/Action.pm b/lib/Workflow/Action.pm index beb1efad..014900a0 100644 --- a/lib/Workflow/Action.pm +++ b/lib/Workflow/Action.pm @@ -160,6 +160,8 @@ sub init { __END__ +=pod + =head1 NAME Workflow::Action - Base class for Workflow actions @@ -457,3 +459,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Action/InputField.pm b/lib/Workflow/Action/InputField.pm index 463226fc..f583039f 100644 --- a/lib/Workflow/Action/InputField.pm +++ b/lib/Workflow/Action/InputField.pm @@ -113,6 +113,8 @@ sub add_possible_values { __END__ +=pod + =head1 NAME Workflow::Action::InputField - Metadata about information required by an Action diff --git a/lib/Workflow/Action/Mailer.pm b/lib/Workflow/Action/Mailer.pm index 675809a9..11553e92 100644 --- a/lib/Workflow/Action/Mailer.pm +++ b/lib/Workflow/Action/Mailer.pm @@ -15,6 +15,8 @@ sub execute { __END__ +=pod + =head1 NAME Workflow::Action::Mailer - a stub for a SMTP capable action diff --git a/lib/Workflow/Action/Null.pm b/lib/Workflow/Action/Null.pm index 48634ea1..0cf60497 100644 --- a/lib/Workflow/Action/Null.pm +++ b/lib/Workflow/Action/Null.pm @@ -15,6 +15,8 @@ sub execute { __END__ +=pod + =head1 NAME Workflow::Action::Null - Workflow action for the terminally lazy @@ -67,4 +69,4 @@ it under the same terms as Perl itself. Chris Winters Echris@cwinters.comE - +=cut diff --git a/lib/Workflow/Base.pm b/lib/Workflow/Base.pm index 4c7298b4..910e4ef7 100644 --- a/lib/Workflow/Base.pm +++ b/lib/Workflow/Base.pm @@ -90,6 +90,8 @@ sub normalize_array { __END__ +=pod + =head1 NAME Workflow::Base - Base class with constructor @@ -200,3 +202,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Condition.pm b/lib/Workflow/Condition.pm index 00e3f20b..30405836 100644 --- a/lib/Workflow/Condition.pm +++ b/lib/Workflow/Condition.pm @@ -29,6 +29,8 @@ sub evaluate { __END__ +=pod + =head1 NAME Workflow::Condition - Evaluate a condition depending on the workflow state and environment diff --git a/lib/Workflow/Condition/Evaluate.pm b/lib/Workflow/Condition/Evaluate.pm index 6da935c5..b3ce266e 100644 --- a/lib/Workflow/Condition/Evaluate.pm +++ b/lib/Workflow/Condition/Evaluate.pm @@ -68,6 +68,8 @@ sub evaluate { __END__ +=pod + =head1 NAME Workflow::Condition::Evaluate - Inline condition that evaluates perl code for truth @@ -150,3 +152,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Condition/HasUser.pm b/lib/Workflow/Condition/HasUser.pm index f8c97b81..e52abea2 100644 --- a/lib/Workflow/Condition/HasUser.pm +++ b/lib/Workflow/Condition/HasUser.pm @@ -35,6 +35,8 @@ sub evaluate { __END__ +=pod + =head1 NAME Workflow::Condition::HasUser - Condition to determine if a user is available @@ -112,3 +114,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Config.pm b/lib/Workflow/Config.pm index 9eb56aed..6cebb38c 100644 --- a/lib/Workflow/Config.pm +++ b/lib/Workflow/Config.pm @@ -106,6 +106,8 @@ __PACKAGE__->register_factory_type( xml => 'Workflow::Config::XML' ); __END__ +=pod + =head1 NAME Workflow::Config - Parse configuration files for the workflow components @@ -449,3 +451,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Config/Perl.pm b/lib/Workflow/Config/Perl.pm index df2b38e6..63a89893 100644 --- a/lib/Workflow/Config/Perl.pm +++ b/lib/Workflow/Config/Perl.pm @@ -99,6 +99,8 @@ sub _translate_perl { __END__ +=pod + =head1 NAME Workflow::Config::Perl - Parse workflow configurations as Perl data structures @@ -157,3 +159,5 @@ it under the same terms as Perl itself. Jonas B. Nielsen (jonasbn) Ejonasbn@cpan.orgE, current maintainer. Chris Winters Echris@cwinters.comE, original author. + +=cut diff --git a/lib/Workflow/Config/XML.pm b/lib/Workflow/Config/XML.pm index d53c14ff..a55fcd48 100644 --- a/lib/Workflow/Config/XML.pm +++ b/lib/Workflow/Config/XML.pm @@ -103,6 +103,8 @@ sub _translate_xml { __END__ +=pod + =head1 NAME Workflow::Config::XML - Parse workflow configurations from XML content @@ -149,3 +151,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Context.pm b/lib/Workflow/Context.pm index c54cee96..e2de6a38 100644 --- a/lib/Workflow/Context.pm +++ b/lib/Workflow/Context.pm @@ -18,6 +18,8 @@ sub merge { __END__ +=pod + =head1 NAME Workflow::Context - Data blackboard for Workflows, Actions, Conditions and Validators @@ -78,3 +80,5 @@ it under the same terms as Perl itself. Jonas B. Nielsen (jonasbn) Ejonasbn@cpan.orgE, current maintainer. Chris Winters Echris@cwinters.comE, original author. + +=cut diff --git a/lib/Workflow/Exception.pm b/lib/Workflow/Exception.pm index aa8a172f..9f881e1f 100644 --- a/lib/Workflow/Exception.pm +++ b/lib/Workflow/Exception.pm @@ -111,6 +111,8 @@ sub _massage { __END__ +=pod + =head1 NAME Workflow::Exception - Base class for workflow exceptions diff --git a/lib/Workflow/Factory.pm b/lib/Workflow/Factory.pm index 559528fa..b2cdf76d 100644 --- a/lib/Workflow/Factory.pm +++ b/lib/Workflow/Factory.pm @@ -812,6 +812,7 @@ sub _validate_action_config { __END__ +=pod =head1 NAME diff --git a/lib/Workflow/History.pm b/lib/Workflow/History.pm index 7d7536a5..3eb4e4ad 100644 --- a/lib/Workflow/History.pm +++ b/lib/Workflow/History.pm @@ -58,6 +58,8 @@ sub clear_saved { __END__ +=pod + =head1 NAME Workflow::History - Recorded work on a workflow action or workflow itself diff --git a/lib/Workflow/Manual/Configuration.pod b/lib/Workflow/Manual/Configuration.pod index b0a8023c..c7bd4d23 100644 --- a/lib/Workflow/Manual/Configuration.pod +++ b/lib/Workflow/Manual/Configuration.pod @@ -1,4 +1,5 @@ =head1 Configuration Description +=pod =head2 Workflows @@ -121,3 +122,5 @@ Chris Winters Echris@cwinters.comE, original author. Jonas B. Nielsen (jonasbn) Ejonasbn@cpan.orgE, current maintainer. + +=cut diff --git a/lib/Workflow/Manual/Overview.pod b/lib/Workflow/Manual/Overview.pod index 26d01051..121079d0 100644 --- a/lib/Workflow/Manual/Overview.pod +++ b/lib/Workflow/Manual/Overview.pod @@ -1,3 +1,5 @@ +=pod + =head1 Basics of Workflows =over @@ -47,3 +49,5 @@ and Workflow. (Although the workflow isn't directly coded...) Chris Winters Echris@cwinters.comE, original author. Jonas B. Nielsen (jonasbn) Ejonasbn@cpan.orgE, current maintainer. + +=cut diff --git a/lib/Workflow/Persister.pm b/lib/Workflow/Persister.pm index 22d6f297..670d57ce 100644 --- a/lib/Workflow/Persister.pm +++ b/lib/Workflow/Persister.pm @@ -150,6 +150,8 @@ sub rollback_transaction { __END__ +=pod + =head1 NAME Workflow::Persister - Base class for workflow persistence diff --git a/lib/Workflow/Persister/DBI.pm b/lib/Workflow/Persister/DBI.pm index a113c9ab..550e9709 100644 --- a/lib/Workflow/Persister/DBI.pm +++ b/lib/Workflow/Persister/DBI.pm @@ -466,6 +466,8 @@ sub get_history_fields { __END__ +=pod + =head1 NAME Workflow::Persister::DBI - Persist workflow and history to DBI database diff --git a/lib/Workflow/Persister/DBI/AutoGeneratedId.pm b/lib/Workflow/Persister/DBI/AutoGeneratedId.pm index d5dc86a6..5df519f4 100644 --- a/lib/Workflow/Persister/DBI/AutoGeneratedId.pm +++ b/lib/Workflow/Persister/DBI/AutoGeneratedId.pm @@ -60,6 +60,8 @@ sub post_fetch_id { __END__ +=pod + =head1 NAME Workflow::Persister::DBI::AutoGeneratedId - Pull IDs from databases that autogenerate them diff --git a/lib/Workflow/Persister/DBI/ExtraData.pm b/lib/Workflow/Persister/DBI/ExtraData.pm index ffe12e91..3ba049f1 100644 --- a/lib/Workflow/Persister/DBI/ExtraData.pm +++ b/lib/Workflow/Persister/DBI/ExtraData.pm @@ -106,6 +106,8 @@ sub fetch_extra_workflow_data { __END__ +=pod + =head1 NAME Workflow::Persister::DBI::ExtraData - Fetch extra data with each workflow and put it into the context diff --git a/lib/Workflow/Persister/DBI/SequenceId.pm b/lib/Workflow/Persister/DBI/SequenceId.pm index faad95d2..4301c406 100644 --- a/lib/Workflow/Persister/DBI/SequenceId.pm +++ b/lib/Workflow/Persister/DBI/SequenceId.pm @@ -40,6 +40,8 @@ sub post_fetch_id {return} __END__ +=pod + =head1 NAME Workflow::Persister::DBI::SequenceId - Persister to fetch ID from a sequence diff --git a/lib/Workflow/Persister/File.pm b/lib/Workflow/Persister/File.pm index 284a12ef..45fdbc23 100644 --- a/lib/Workflow/Persister/File.pm +++ b/lib/Workflow/Persister/File.pm @@ -194,6 +194,8 @@ sub _get_history_path { __END__ +=pod + =head1 NAME Workflow::Persister::File - Persist workflow and history to the filesystem diff --git a/lib/Workflow/Persister/RandomId.pm b/lib/Workflow/Persister/RandomId.pm index bffa5b12..7685f504 100644 --- a/lib/Workflow/Persister/RandomId.pm +++ b/lib/Workflow/Persister/RandomId.pm @@ -34,6 +34,8 @@ sub post_fetch_id {return} __END__ +=pod + =head1 NAME Workflow::Persister::RandomId - Persister to generate random ID @@ -90,3 +92,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Persister/SPOPS.pm b/lib/Workflow/Persister/SPOPS.pm index 019797d0..800b53b1 100644 --- a/lib/Workflow/Persister/SPOPS.pm +++ b/lib/Workflow/Persister/SPOPS.pm @@ -136,6 +136,8 @@ sub fetch_history { __END__ +=pod + =head1 NAME Workflow::Persister::SPOPS - Persist workflows using SPOPS diff --git a/lib/Workflow/Persister/UUID.pm b/lib/Workflow/Persister/UUID.pm index 89ef71c6..0d2c9e62 100644 --- a/lib/Workflow/Persister/UUID.pm +++ b/lib/Workflow/Persister/UUID.pm @@ -23,6 +23,8 @@ sub post_fetch_id {return} __END__ +=pod + =head1 NAME Workflow::Persister::UUID - Persister to generate Universally Unique Identifiers @@ -90,3 +92,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/State.pm b/lib/Workflow/State.pm index d027fc58..f03f19d5 100644 --- a/lib/Workflow/State.pm +++ b/lib/Workflow/State.pm @@ -463,6 +463,8 @@ sub _get_next_condition_count { __END__ +=pod + =head1 NAME Workflow::State - Information about an individual state in a workflow diff --git a/lib/Workflow/Validator.pm b/lib/Workflow/Validator.pm index b24f364c..7d819bd2 100644 --- a/lib/Workflow/Validator.pm +++ b/lib/Workflow/Validator.pm @@ -35,6 +35,8 @@ sub validate { __END__ +=pod + =head1 NAME Workflow::Validator - Ensure data are valid @@ -153,3 +155,5 @@ it under the same terms as Perl itself. =head1 AUTHORS Chris Winters Echris@cwinters.comE + +=cut diff --git a/lib/Workflow/Validator/HasRequiredField.pm b/lib/Workflow/Validator/HasRequiredField.pm index 5798fee2..ca33d43a 100644 --- a/lib/Workflow/Validator/HasRequiredField.pm +++ b/lib/Workflow/Validator/HasRequiredField.pm @@ -26,6 +26,8 @@ sub validate { __END__ +=pod + =head1 NAME Workflow::Validator::HasRequiredField - Validator to ensure certain data are in the context diff --git a/lib/Workflow/Validator/InEnumeratedType.pm b/lib/Workflow/Validator/InEnumeratedType.pm index 9d67ac40..bd1be876 100644 --- a/lib/Workflow/Validator/InEnumeratedType.pm +++ b/lib/Workflow/Validator/InEnumeratedType.pm @@ -51,6 +51,8 @@ sub is_enumerated_value { __END__ +=pod + =head1 NAME Workflow::Validator::InEnumeratedType - Ensure a value is one of a declared set of values @@ -224,4 +226,4 @@ Current maintainer Jonas B. Nielsen Ejonasbn@cpan.orgE Original author Chris Winters Echris@cwinters.comE - +=cut diff --git a/lib/Workflow/Validator/MatchesDateFormat.pm b/lib/Workflow/Validator/MatchesDateFormat.pm index bc991d02..e69a7614 100644 --- a/lib/Workflow/Validator/MatchesDateFormat.pm +++ b/lib/Workflow/Validator/MatchesDateFormat.pm @@ -56,6 +56,8 @@ sub validate { __END__ +=pod + =head1 NAME Workflow::Validator::MatchesDateFormat - Ensure a stringified date matches a given pattern @@ -153,3 +155,5 @@ it under the same terms as Perl itself. Current maintainer Jonas B. Nielsen Ejonasbn@cpan.orgE Original author Chris Winters Echris@cwinters.comE + +=cut