Skip to content

Commit

Permalink
Add config parser documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuelsmann committed Aug 7, 2023
1 parent 0244a9b commit ec92160
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions lib/Workflow/Config/YAML.pm
Expand Up @@ -66,3 +66,73 @@ sub _translate_yaml {
}

1;


__END__
=pod
=head1 NAME
Workflow::Config::YAML - Parse workflow configurations as YAML data structures
=head1 VERSION
This documentation describes version 1.57 of this package
=head1 SYNOPSIS
# either of these is acceptable
my $parser = Workflow::Config->new( 'yaml' );
my $parser = Workflow::Config->new( 'yml' );
my $conf = $parser->parse( 'condition',
'my_conditions.yml', 'your_conditions.yaml' );
=head1 DESCRIPTION
Implementation of configuration parser for serialized YAML data
structures from files/data. See L<Workflow::Config> for C<parse()>
description.
=head1 METHODS
=head2 parse
This method is required implemented by L<Workflow::Config>.
It takes two arguments:
=over
=item * a string indicating the type of configuration. For a complete list of
types please refer to L<Workflow::Config>
=item * a list of filenames containing at least a single file name
=back
The method returns a list of configuration parameters.
=head1 SEE ALSO
=over
=item * L<Workflow::Config>
=back
=head1 COPYRIGHT
Copyright (c) 2004-2021 Chris Winters. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
Please see the F<LICENSE>
=head1 AUTHORS
Please see L<Workflow>
=cut

0 comments on commit ec92160

Please sign in to comment.