More documentation to satisfy Inch

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)