X-Git-Url: http://git.ieval.ro/?p=zeal.git;a=blobdiff_plain;f=lib%2FZeal%2FDocset.pm;fp=lib%2FZeal%2FDocset.pm;h=88c52e284b2f5d09e764cf518a2bdca05d06a7d3;hp=3a54621a2cade5ea3c9be240f58116e8a4fa1355;hb=0469af4b76d7a33b0de2fcc696928b22a53099b9;hpb=9f3addb587e04de3fdace8ff2e373cc241297d84 diff --git a/lib/Zeal/Docset.pm b/lib/Zeal/Docset.pm index 3a54621..88c52e2 100644 --- a/lib/Zeal/Docset.pm +++ b/lib/Zeal/Docset.pm @@ -83,6 +83,17 @@ Zeal::Docset - Class representing a Dash/Zeal docset =head1 SYNOPSIS use Zeal::Docset; + my $ds = Zeal::Docset->new('/home/mgv/docsets/Perl.docset'); + say $ds->$path; # /home/mgv/docsets/Perl.docset + say $ds->name; # Perl + say $ds->id; # perl + say $ds->family; # perl + + # In SQL LIKE, % is .* and _ is . + my @matches = $ds->query('perlopen%'); # finds perlopenbsd and perlopentut + my $doc = $ds->query('perlsec'); # A Zeal::Document object for perlsec + my $html = $ds->get('perls_c'); # HTML documentation of perlsec + my @docs = $ds->list; # all documents =head1 DESCRIPTION