Add POD documentation and code optimization

giterlizzi · Feb 27, 2024 · fd83bdb · fd83bdb
1 parent 79f6dd0
commit fd83bdb
Show file tree

Hide file tree

Showing 55 changed files with 3,639 additions and 106 deletions.
diff --git a/lib/CSAF.pm b/lib/CSAF.pm
@@ -13,7 +13,7 @@ use CSAF::Document;
 
 use overload '""' => 'to_string';
 
-our $VERSION = '0.10';
+our $VERSION = '0.11';
 
 our $CACHE = {};
 

diff --git a/lib/CSAF/Builder.pm b/lib/CSAF/Builder.pm
@@ -15,9 +15,9 @@ sub build {
 
     my ($self, $skip_validation) = @_;
 
-    my $document        = $self->csaf->document->TO_BUILD;
-    my $vulnerabilities = $self->csaf->vulnerabilities->TO_BUILD;
-    my $product_tree    = $self->csaf->product_tree->TO_BUILD;
+    my $document        = $self->csaf->document->TO_CSAF;
+    my $vulnerabilities = $self->csaf->vulnerabilities->TO_CSAF;
+    my $product_tree    = $self->csaf->product_tree->TO_CSAF;
 
     my $csaf = {document => $document};
 

diff --git a/lib/CSAF/Type/Acknowledgment.pm b/lib/CSAF/Type/Acknowledgment.pm
@@ -16,7 +16,7 @@ sub _check_isa_array {
     Carp::croak 'must be an array' if (ref $_[0] ne 'ARRAY');
 }
 
-sub TO_BUILD {
+sub TO_CSAF {
 
     my $self = shift;
 
@@ -33,3 +33,72 @@ sub TO_BUILD {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+CSAF::Type::Acknowledgment
+
+=head1 SYNOPSIS
+
+    use CSAF::Type::Acknowledgment;
+    my $type = CSAF::Type::Acknowledgment->new( );
+
+
+=head1 DESCRIPTION
+
+
+
+=head2 METHODS
+
+L<CSAF::Type::Acknowledgment> inherits all methods from L<CSAF::Type::Base> and implements the following new ones.
+
+=over
+
+=item $type->names
+
+=item $type->organization
+
+=item $type->summary
+
+=item $type->urls
+
+=back
+
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/giterlizzi/perl-CSAF/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software.  The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/giterlizzi/perl-CSAF>
+
+    git clone https://github.com/giterlizzi/perl-CSAF.git
+
+
+=head1 AUTHOR
+
+=over 4
+
+=item * Giuseppe Di Terlizzi <gdt@cpan.org>
+
+=back
+
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is copyright (c) 2023-2024 by Giuseppe Di Terlizzi.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut
diff --git a/lib/CSAF/Type/Acknowledgments.pm b/lib/CSAF/Type/Acknowledgments.pm
@@ -7,6 +7,64 @@ use warnings;
 use Moo;
 extends 'CSAF::Type::List';
 
-has item_class_name => (is => 'ro', default => 'CSAF::Type::Acknowledgment');
+has item_class => (is => 'ro', default => 'CSAF::Type::Acknowledgment');
 
 1;
+
+__END__
+
+=head1 NAME
+
+CSAF::Type::Acknowledgments
+
+=head1 SYNOPSIS
+
+    use CSAF::Type::Acknowledgments;
+    my $type = CSAF::Type::Acknowledgments->new( );
+
+
+=head1 DESCRIPTION
+
+L<CSAF::Type::Acknowledgments> is a collection of L<CSAF::Type::Acknowledgment> elements.
+
+
+=head2 METHODS
+
+L<CSAF::Type::Acknowledgments> inherits all methods from L<CSAF::Type::List>.
+
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/giterlizzi/perl-CSAF/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software.  The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/giterlizzi/perl-CSAF>
+
+    git clone https://github.com/giterlizzi/perl-CSAF.git
+
+
+=head1 AUTHOR
+
+=over 4
+
+=item * Giuseppe Di Terlizzi <gdt@cpan.org>
+
+=back
+
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is copyright (c) 2023-2024 by Giuseppe Di Terlizzi.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut
diff --git a/lib/CSAF/Type/AggregateSeverity.pm b/lib/CSAF/Type/AggregateSeverity.pm
@@ -10,7 +10,7 @@ extends 'CSAF::Type::Base';
 has text      => (is => 'rw');
 has namespace => (is => 'rw');
 
-sub TO_BUILD {
+sub TO_CSAF {
 
     my $self = shift;
 
@@ -26,3 +26,68 @@ sub TO_BUILD {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+CSAF::Type::AggregateSeverity
+
+=head1 SYNOPSIS
+
+    use CSAF::Type::AggregateSeverity;
+    my $type = CSAF::Type::AggregateSeverity->new( );
+
+
+=head1 DESCRIPTION
+
+
+
+=head2 METHODS
+
+L<CSAF::Type::AggregateSeverity> inherits all methods from L<CSAF::Type::Base> and implements the following new ones.
+
+=over
+
+=item $type->namespace
+
+=item $type->text
+
+=back
+
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/giterlizzi/perl-CSAF/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software.  The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/giterlizzi/perl-CSAF>
+
+    git clone https://github.com/giterlizzi/perl-CSAF.git
+
+
+=head1 AUTHOR
+
+=over 4
+
+=item * Giuseppe Di Terlizzi <gdt@cpan.org>
+
+=back
+
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is copyright (c) 2023-2024 by Giuseppe Di Terlizzi.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut
diff --git a/lib/CSAF/Type/Base.pm b/lib/CSAF/Type/Base.pm
@@ -7,7 +7,72 @@ use warnings;
 use Moo;
 use Carp;
 
-sub TO_BUILD { Carp::croak 'Method "TO_BUILD" not implemented by subclass' }
-sub TO_JSON  { shift->TO_BUILD }
+sub TO_CSAF { Carp::croak 'Method "TO_CSAF" not implemented by subclass' }
+sub TO_JSON { shift->TO_CSAF }
 
 1;
+
+__END__
+
+=head1 NAME
+
+CSAF::Type::Base
+
+=head1 SYNOPSIS
+
+    use CSAF::Type::Base;
+    my $type = CSAF::Type::Base->new( );
+
+
+=head1 DESCRIPTION
+
+
+
+=head2 METHODS
+
+L<CSAF::Type::Base> inherits all methods from L<CSAF::Type::Base> and implements the following new ones.
+
+=over
+
+=item $type->TO_JSON
+
+=item $type->TO_CSAF
+
+=back
+
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/giterlizzi/perl-CSAF/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software.  The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/giterlizzi/perl-CSAF>
+
+    git clone https://github.com/giterlizzi/perl-CSAF.git
+
+
+=head1 AUTHOR
+
+=over 4
+
+=item * Giuseppe Di Terlizzi <gdt@cpan.org>
+
+=back
+
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is copyright (c) 2023-2024 by Giuseppe Di Terlizzi.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut