1CPAN::Changes::Group(3)User Contributed Perl DocumentatioCnPAN::Changes::Group(3)
2
3
4

NAME

6       CPAN::Changes::Group - A group of related change information within a
7       release
8

SYNOPSIS

10           my $rel = CPAN::Changes::Release->new(
11               version => '0.01',
12               date    => '2009-07-06',
13           );
14
15           my $grp = CPAN::Changes::Group->new(
16               name => 'BugFixes',
17           );
18
19           $grp->add_changes(
20             'Return a Foo object instead of a Bar object in foobar()'
21           );
22
23           $rel->attach_group( $grp ); # clobbers existing group if present.
24

DESCRIPTION

26       A release is made up of several groups. This object provides access to
27       all of the key data that embodies a such a group.
28
29       For instance:
30
31         0.27 2013-12-13
32
33         - Foo
34
35         [ Spec Changes ]
36
37         - Bar
38
39       Here, there are two groups, the second one, " Spec Changes " and the
40       first with the empty label "q[]".
41

METHODS

43   new( %args )
44       Creates a new group object, using %args as the default data.
45
46         Group->new(
47             name => 'Some Group Name',
48             changes    => [ ],
49         );
50
51   name()
52       Returns the name of the group itself.
53
54   changes( [ $group ] )
55       Gets the list of changes for this group as an arrayref of changes.
56
57   add_changes( @changes )
58       Appends a list of changes to the group.
59
60           $group->add_changes( 'Added foo() function' );
61
62   set_changes( @changes )
63       Replaces the existing list of changes with the supplied values.
64
65   clear_changes( )
66       Clears all changes from the group.
67
68   groups( sort => \&sorting_function )
69       Returns a list of current groups in this release.
70
71   is_empty()
72       Returns whether or not the given group has changes.
73
74   serialize()
75       Returns the group data as a string, suitable for inclusion in a Changes
76       file.
77

SEE ALSO

79       •   CPAN::Changes::Release
80
81       •   CPAN::Changes::Spec
82
83       •   CPAN::Changes
84
85       •   Test::CPAN::Changes
86

AUTHOR

88       Brian Cassidy <bricas@cpan.org>
89

91       Copyright 2011-2013 by Brian Cassidy
92
93       This library is free software; you can redistribute it and/or modify it
94       under the same terms as Perl itself.
95
96
97
98perl v5.34.0                      2021-07-22           CPAN::Changes::Group(3)
Impressum