From d36907b74cf6426789b5df50fca088df57dd2eaf Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Thu, 24 Jul 2014 21:39:48 -0400 Subject: [PATCH] More documentation to satisfy Inch --- lib/squib/api/image.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/squib/api/image.rb b/lib/squib/api/image.rb index 4ce34ae..3892589 100644 --- a/lib/squib/api/image.rb +++ b/lib/squib/api/image.rb @@ -18,7 +18,10 @@ module Squib end # Renders an entire svg file at the given location. Uses the SVG-specified units and DPI to determine the pixel width and height. - # See {file:samples/load-images.rb samples/load-images.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples. + # @example + # svg 1..2, 'icon.svg', '#stone', x: 50, y:50 + # + # See {file:samples/load-images.rb samples/load-images.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples. # # @param range: the range of cards over which this will be rendered. See {file:API.md#label-Specifying+Ranges Specifying Ranges} # @param file: the svg file to render. See {file:API.md#Specifying+Files Specifying Files} @@ -27,7 +30,7 @@ module Squib # @param y: the y-coordinate to place # @param width: the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. # @param height: the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. - # @return [nil] + # @return [nil] essentially a void method # @api public def svg(range: :all, file: nil, id: nil, x: 0, y: 0, width: :native, height: :native) range = rangeify(range)