]> git.vpit.fr Git - perl/modules/LaTeX-TikZ.git/blobdiff - lib/LaTeX/TikZ/Formatter.pm
Make sure POD headings are linkable
[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Formatter.pm
index 58c2985d4e20fdce2fdaf69108f1e0d04685c095..e06676affd631ee025852b30595eba295b8fee1c 100644 (file)
@@ -142,7 +142,9 @@ sub id {
  } map($tikz->$_, qw<unit format scale width height>), $origin;
 }
 
-=head2 C<render @sets>
+=head2 C<render>
+
+    my ($header_lines, $mod_lines, $content_lines) = $formatter->render(@sets);
 
 Processes all the L<LaTeX::TikZ::Set> objects given in C<@sets> to produce the actual TikZ code to insert in the LaTeX file.
 First, all the mods applied to the sets and their subsets are collected, and a declaration is emitted if needed for each of them by calling L<LaTeX::TikZ::Mod/declare>.
@@ -296,7 +298,9 @@ sub render {
  return \@header, \@decls, @bodies;
 }
 
-=head2 C<len $len>
+=head2 C<len>
+
+    my $physical_len = $formatter->len($logical_len);
 
 Format the given length according to the formatter options.
 
@@ -310,7 +314,9 @@ sub len {
  sprintf $tikz->format . $tikz->unit, $len * $tikz->scale;
 }
 
-=head2 C<angle $theta>
+=head2 C<angle>
+
+    my $physical_angle = $formatter->angle($logical_angle);
 
 Format the given angle (in radians) according to the formatter options.
 
@@ -326,7 +332,9 @@ sub angle {
  sprintf $tikz->format, POSIX::ceil($a);
 }
 
-=head2 C<label $name, $pos>
+=head2 C<label>
+
+    my $label = $formatter->label($name, $pos);
 
 Returns the TikZ code for a point labeled C<$name> at position C<$pos> according to the formatter options.