File: gen_class_pod.pm

package info (click to toggle)
cme 1.044-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 392 kB
  • sloc: perl: 1,301; makefile: 19; sh: 9
file content (51 lines) | stat: -rw-r--r-- 1,032 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# ABSTRACT: Generates pod doc from model files

package App::Cme::Command::gen_class_pod ;

use strict;
use warnings;
use 5.10.1;

use App::Cme -command ;
use Config::Model::Utils::GenClassPod;

sub command_names {
    my $self = shift ;
    return ( 'gen-class-pod' , $self->SUPER::command_names );
}

sub description {
    return << "EOD"
Generate pod documentation from configuration models found in ./lib directory
EOD

}

sub execute {
    my ($self, $opt, $args) = @_;
    gen_class_pod(@$args);
    return;
}

1;


=head1 SYNOPSIS

 cme gen-class-pod [ Foo ... ]

=head1 DESCRIPTION

This command scans C<./lib/Config/Model/models/*.d>
and generate pod documentation for each file found there using
L<Config::Model::generate_doc|Config::Model/"generate_doc ( top_class_name , [ directory ] )">

You can also pass one or more class names. C<gen_class_pod> will write
the documentation for each passed class and all other classes used by
the passed classes.

=head1 SEE ALSO

L<cme>, L<Config::Model::Utils::GenClassPod>

=cut