From: Dave Rolsky Date: Fri, 25 Dec 2009 15:51:19 +0000 (-0600) Subject: Updated docs to not mention new(), document initialize(), and various other doc cleanup X-Git-Tag: 0.22~10 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=0b3df90672d2c2eb62f71873c44219dea02816fa;p=gitmo%2FMooseX-Singleton.git Updated docs to not mention new(), document initialize(), and various other doc cleanup --- diff --git a/lib/MooseX/Singleton.pm b/lib/MooseX/Singleton.pm index 6b8a84b..7d00542 100644 --- a/lib/MooseX/Singleton.pm +++ b/lib/MooseX/Singleton.pm @@ -72,38 +72,37 @@ C lets you easily upgrade (or downgrade, as it were) your L class to a singleton. All you should need to do to transform your class is to change C to -C. This module uses a new class metaclass and instance -metaclass, so if you're doing metamagic you may not be able to use this. +C. This module uses metaclass roles to do its magic, so +it should cooperate with most other C modules. -C gives your class an C method that can be used to -get a handle on the singleton. It's actually just an alias for C. +=head1 METHODS -Alternatively, C<< YourPackage->method >> should just work. This includes -accessors. +A singleton class will have the following additional methods: -If you need to reset your class's singleton object for some reason (e.g. -tests), you can call C<< YourPackage->_clear_instance >>. +=head2 Singleton->instance -=head1 TODO +This returns the singleton instance for the given package. This method does +I accept any arguments. If the instance does not yet exist, it is created +with its defaults values. This means that if your singleton requires +arguments, calling C will die if the object has not already been +initialized. -=over +=head2 Singleton->initialize(%args) -=item Always more tests and doc +This method can be called I. It explicitly initializes +the singleton object with the given arguments. -=item Fix speed boost +=head2 Singleton->_clear_instance -C invokes C every time C<< Package->method >> is called, which -incurs a nontrivial runtime cost. I've implemented a short-circuit for this -case, which does eliminate nearly all of the runtime cost. However, it's ugly -and should be fixed in a more elegant way. - -=back +This clears the existing singleton instance for the class. Obviously, this is +meant for use only inside the class itself. =head1 BUGS -All complex software has bugs lurking in it, and this module is no -exception. If you find a bug please either email me, or add the bug -to cpan-RT. +Please report any bugs or feature requests to +C, or through the web interface at +L. We will be notified, and then you'll automatically be +notified of progress on your bug as we make changes. =head1 AUTHORS @@ -121,7 +120,7 @@ Ricardo SIGNES Erjbs@cpan.orgE =head1 COPYRIGHT AND LICENSE -Copyright 2007, 2008 Infinity Interactive +Copyright 2007-2009 Infinity Interactive This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.