root/lang/perl/Senna/trunk/lib/Senna.pm @ 4360

Revision 4360, 1.7 kB (checked in by daisuke, 6 years ago)

lang/perl/Senna; more doc cleanup

  • Property svn:keywords set to Id
Line 
1# $Id$
2#
3# Copyright (c) 2005-2008 Daisuke Maki <daisuke@endeworks.jp>
4# All rights reserved.
5
6package Senna;
7use strict;
8use warnings;
9use vars qw($VERSION @ISA);
10use 5.008;
11use XSLoader;
12
13BEGIN
14{
15    $VERSION = '0.60000';
16    XSLoader::load(__PACKAGE__, $VERSION);
17}
18
19END
20{
21    cleanup();
22}
23
24use Senna::DB;
25use Senna::Constants;
26use Senna::Ctx;
27use Senna::Encoding;
28use Senna::Index;
29use Senna::Query;
30use Senna::RC;
31use Senna::Snippet;
32use Senna::Symbol;
33
34
351;
36
37__END__
38
39=head1 NAME
40
41Senna - Perl Binding for Senna Full Text Search Engine
42
43=head1 SYNOPSIS
44
45  use Senna;
46
47  my $index = Senna::Index->create(
48    path => "...",
49  );
50  my $info = $index->info;
51
52=head1 DESCRIPTION
53
54This module provides a Perl binding to libsenna, an embeddable full-text search
55engine.
56
57While Senna remains a personal favorite to search for Japanese text,
58Senna (the API) is in a constant state of flux which makes things really hard
59for binding development. This module tries hard to keep up with the changes,
60but if you see breakage, PATCHES ARE ENCOURAGED. Please see L<CODE|CODE>
61
62=head1 METHODS
63
64=head2 info
65
66=head2 cleanup
67
68Performs C level cleanup for Senna. You do NOT need to use this method.
69It's called automatically at END block.
70
71=head1 CODE
72
73Senna is graciously hosted by coderepos (http://coderepos.org/share)
74For latest version, please grab from:
75
76  http://svn.coderepos.org/share/lang/perl/Senna/trunk
77
78=head1 AUTHOR
79
80Copyright (c) 2005-2008 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
81
82=head1 CONTRIBUTORS
83
84Jiro Nishiguchi
85
86=head1 LICENSE
87
88This program is free software; you can redistribute it and/or modify it
89under the same terms as Perl itself.
90
91See http://www.perl.com/perl/misc/Artistic.html
92
93=cut
Note: See TracBrowser for help on using the browser.