From: Dagfinn Ilmari Mannsåker Date: Mon, 22 Sep 2014 16:46:39 +0000 (+0100) Subject: Fix broken POD links found by App::PodLinkChecker X-Git-Tag: v0.11021~25 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ac7adbab6451299d70b5ecc59c6bb7f8a6f9473b;p=dbsrgits%2FSQL-Translator.git Fix broken POD links found by App::PodLinkChecker --- diff --git a/lib/SQL/Translator.pm b/lib/SQL/Translator.pm index e0bee17..0ee48f0 100644 --- a/lib/SQL/Translator.pm +++ b/lib/SQL/Translator.pm @@ -767,6 +767,8 @@ UPDATE, DELETE). =head1 CONSTRUCTOR +=head2 new + The constructor is called C, and accepts a optional hash of options. Valid options are: diff --git a/lib/SQL/Translator/Parser/XML/SQLFairy.pm b/lib/SQL/Translator/Parser/XML/SQLFairy.pm index 7f54f39..4e6e874 100644 --- a/lib/SQL/Translator/Parser/XML/SQLFairy.pm +++ b/lib/SQL/Translator/Parser/XML/SQLFairy.pm @@ -43,10 +43,10 @@ tags then the order the tags appear in the XML will be used. =head2 default_value -Leave the attribute out all together to use the default in L. -Use empty quotes or 'EMPTY_STRING' for a zero length string. 'NULL' for an -explicit null (currently sets default_value to undef in the -Schema::Field obj). +Leave the attribute out all together to use the default in +L. Use empty quotes or 'EMPTY_STRING' +for a zero length string. 'NULL' for an explicit null (currently sets +default_value to undef in the field object). diff --git a/lib/SQL/Translator/Producer/GraphViz.pm b/lib/SQL/Translator/Producer/GraphViz.pm index 59529f0..f17a9d3 100644 --- a/lib/SQL/Translator/Producer/GraphViz.pm +++ b/lib/SQL/Translator/Producer/GraphViz.pm @@ -96,7 +96,7 @@ undefined (the default) - the result is returned as a string. =item * output_type (DEFAULT: 'png') This determines which -L +L will be invoked to generate the graph: C translates to C, C to C and so on. diff --git a/lib/SQL/Translator/Producer/TT/Base.pm b/lib/SQL/Translator/Producer/TT/Base.pm index 8155ff5..3a6105c 100644 --- a/lib/SQL/Translator/Producer/TT/Base.pm +++ b/lib/SQL/Translator/Producer/TT/Base.pm @@ -174,14 +174,14 @@ sub classes. # Convert produce call into an object method call sub produce { return __PACKAGE__->new( translator => shift )->run; }; -See L below for details. +See L below for details. The upshot of this is we can make new template producers by sub classing this base class, adding the above snippet and a template. The module also provides a number of hooks into the templating process, -see L for details. +see L for details. -See the L above for an example of creating a simple producer using +See the L above for an example of creating a simple producer using a single template stored in the producers DATA section. =head1 SUB CLASS HOOKS @@ -215,13 +215,13 @@ these fail, causing the produce call to fail with a 'no template!' error. sub tt_vars { ( foo => "bar" ); } Return hash of template vars to use in the template. Nothing added here -by default, but see L for the variables you get for free. +by default, but see L for the variables you get for free. =head2 tt_default_vars Return a hash-ref of the default vars given to the template. You wouldn't normally over-ride this, just inherit the default implementation, -to get the C & C variables, then over-ride L to add +to get the C & C variables, then over-ride L to add your own. The current default variables are: @@ -303,7 +303,7 @@ paths. - Pass in template vars from the producer args and command line. -- Merge in TT::Table. +- Merge in L. - Hooks to pre-process the schema and post-process the output. diff --git a/lib/SQL/Translator/Producer/TT/Table.pm b/lib/SQL/Translator/Producer/TT/Table.pm index 7d8d041..799ca54 100644 --- a/lib/SQL/Translator/Producer/TT/Table.pm +++ b/lib/SQL/Translator/Producer/TT/Table.pm @@ -48,10 +48,10 @@ allows you to write the result for each table to a separate file. It needs one additional producer_arg of C which is the file name of the template to use. This template will be passed a template var of C, which is the current -L table we are producing, which you -can then use to walk the schema via the methods documented in that -module. You also get L as a shortcut to the -L for the table and C, +L table we are producing, +which you can then use to walk the schema via the methods documented +in that module. You also get C as a shortcut to the +L for the table and C, the L object for this parse in case you want to get access to any of the options etc set here. @@ -296,7 +296,8 @@ implicitly through use in a project but need some proper tests). - Better hooks for filename generation. -- Integrate with L and L. +- Integrate with L and + L. =head1 SEE ALSO diff --git a/lib/SQL/Translator/Schema/Constraint.pm b/lib/SQL/Translator/Schema/Constraint.pm index d5227b5..7742bf7 100644 --- a/lib/SQL/Translator/Schema/Constraint.pm +++ b/lib/SQL/Translator/Schema/Constraint.pm @@ -179,7 +179,7 @@ names and keep them in order by the first occurrence of a field name. The fields are returned as Field objects if they exist or as plain names if not. (If you just want the names and want to avoid the Field's overload -magic use L). +magic use L). Returns undef or an empty list if the constraint has no fields set. diff --git a/lib/SQL/Translator/Utils.pm b/lib/SQL/Translator/Utils.pm index b297ab7..1966e81 100644 --- a/lib/SQL/Translator/Utils.pm +++ b/lib/SQL/Translator/Utils.pm @@ -545,13 +545,13 @@ L. =head2 carp_ro Takes a field name and returns a reference to a function can be used -L a read-only accessor to make it L +L a read-only accessor to make it L instead of die when passed an argument. =head2 batch_alter_table_statements Takes diff and argument hashes as passed to -L +L and an optional list of producer functions to call on the calling package. Returns the list of statements returned by the producer functions.