From dd3d1ec12f47da3ae777950e98b2ce57f3a42a18 Mon Sep 17 00:00:00 2001 From: Thierry Moisan Date: Tue, 12 Aug 2008 20:05:33 -0400 Subject: [PATCH] Adding basic documentation to Siman --- Siman.i | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/Siman.i b/Siman.i index 6825f97..f2978ef 100644 --- a/Siman.i +++ b/Siman.i @@ -12,4 +12,51 @@ gsl_siman_solve_many /; %EXPORT_TAGS = ( all => [ @EXPORT_OK ] ); + +__END__ + +=head1 NAME + +Math::GSL::Siman - Simulated Annealing + +=head1 SYNOPSIS + +This module is not yet implemented. Patches Welcome! + +use Math::GSL::Siman qw /:all/; + +=head1 DESCRIPTION + +Here is a list of all the functions in this module : + +=over + +=item * C + +=item * C + +=back + + +For more informations on the functions, we refer you to the GSL offcial +documentation: L + + Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want + + +=head1 AUTHORS + +Jonathan Leto and Thierry Moisan + +=head1 COPYRIGHT AND LICENSE + +Copyright (C) 2008 Jonathan Leto and Thierry Moisan + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +=cut + + + %} -- 2.11.4.GIT