hexapdf 0.32.1 → 0.33.0

data/lib/hexapdf/content/graphic_object/geom2d.rb

@@ -43,6 +43,22 @@ module HexaPDF
 
       # This class provides support for drawing Geom2D objects like line segments and polygons.
       #
+      # By default, the paths for the objects are not only added to the canvas but are also stroked
+      # or filled (depending on the specific Geom2D object).
+      #
+      # Supported Geom2D objects are:
+      #
+      # * Geom2D::Point
+      # * Geom2D::Segment
+      # * Geom2D::Polygon
+      # * Geom2D::PolygonSet
+      #
+      # Examples:
+      #
+      #   #>pdf-center
+      #   canvas.draw(:geom2d, object: ::Geom2D::Point(-10, 10))
+      #   canvas.draw(:geom2d, object: ::Geom2D::Polygon([10, 10], [30, 20], [0, 50]))
+      #
       # See: Geom2D - https://github.com/gettalong/geom2d
       class Geom2D
 
@@ -53,10 +69,12 @@ module HexaPDF
           new.configure(**kwargs)
         end
 
-        # The Geom2D object that should be drawn
+        # The Geom2D object that should be drawn.
+        #
+        # This attribute *must* be set before drawing.
         attr_accessor :object
 
-        # The radius to use when drawing Geom2D::Point objects; defaults to 1
+        # The radius to use when drawing Geom2D::Point objects, defaults to 1.
         #
         # Examples:
         #
@@ -66,7 +84,7 @@ module HexaPDF
         attr_accessor :point_radius
 
         # Specifies whether only paths should be drawn or if they should be stroked/filled too
-        # (default).
+        # (the default).
         #
         # Examples:
         #
@@ -76,6 +94,8 @@ module HexaPDF
         attr_accessor :path_only
 
         # Creates a Geom2D drawing support object.
+        #
+        # A call to #configure is mandatory afterwards to set the #object to be drawn.
         def initialize
           @object = nil
           @point_radius = 1
@@ -84,7 +104,8 @@ module HexaPDF
 
         # Configures the Geom2D drawing support object. The following arguments are allowed:
         #
-        # :object:: The object that should be drawn.
+        # :object:: The object that should be drawn. If this argument has not been set before and is
+        #           also not given, an error will be raised when calling #draw.
         # :point_radius:: The radius of the points when drawing points.
         # :path_only:: Whether only the path should be drawn.
         #
@@ -92,18 +113,33 @@ module HexaPDF
         # methods for the inital values.
         #
         # Returns self.
-        def configure(object:, point_radius: nil, path_only: nil)
-          @object = object
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   obj = canvas.graphic_object(:geom2d, object: ::Geom2D::Point(0, 0))
+        #   canvas.draw(obj)
+        #   canvas.opacity(fill_alpha: 0.5).fill_color("hp-blue").
+        #     draw(obj, point_radius: 10)
+        def configure(object: nil, point_radius: nil, path_only: nil)
+          @object = object if object
           @point_radius = point_radius if point_radius
           @path_only = path_only if path_only
           self
         end
 
         # Draws the Geom2D object onto the given Canvas.
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   obj = canvas.graphic_object(:geom2d, object: ::Geom2D::Point(0, 0))
+        #   obj.draw(canvas)
         def draw(canvas)
           case @object
           when ::Geom2D::Point then draw_point(canvas)
           when ::Geom2D::Segment then draw_segment(canvas)
+          when ::Geom2D::Rectangle then draw_rectangle(canvas)
           when ::Geom2D::Polygon then draw_polygon(canvas)
           when ::Geom2D::PolygonSet then draw_polygon_set(canvas)
           else
@@ -124,6 +160,11 @@ module HexaPDF
           canvas.stroke unless @path_only
         end
 
+        def draw_rectangle(canvas)
+          canvas.rectangle(@object.x, @object.y, @object.width, @object.height)
+          canvas.stroke unless @path_only
+        end
+
         def draw_polygon(canvas)
           return unless @object.nr_of_vertices > 1
           canvas.move_to(@object[0].x, @object[0].y)

data/lib/hexapdf/content/graphic_object/solid_arc.rb

@@ -41,41 +41,43 @@ module HexaPDF
       # This graphic object represents a solid elliptical arc, i.e. an arc that has an inner and
       # an outer set of a/b values.
       #
+      # Note that only the path itself is added to the canvas. So depending on the use-case the path
+      # itself still has to be, for example, stroked.
+      #
       # This graphic object is registered under the :solid_arc key for use with the
       # HexaPDF::Content::Canvas class.
       #
-      # Thus it can be used to create
+      # It can be used to create
       #
       # * an (*elliptical*) *disk* (when the inner a/b are zero and the difference between start and
       #   end angles is greater than or equal to 360),
       #
       #     #>pdf-center
-      #     canvas.fill_color("red").
-      #       draw(:solid_arc, outer_a: 80, outer_b: 50, end_angle: 360).
+      #     canvas.fill_color("hp-blue").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50).
       #       fill_stroke
       #
       # * an (*elliptical*) *sector* (when the inner a/b are zero and the difference between start
       #   and end angles is less than 360),
       #
       #     #>pdf-center
-      #     canvas.fill_color("red").
+      #     canvas.fill_color("hp-blue").
       #       draw(:solid_arc, outer_a: 80, outer_b: 50, start_angle: 20, end_angle: 230).
       #       fill_stroke
       #
       # * an (*elliptical*) *annulus* (when the inner a/b are nonzero and the difference between
-      #   start and end angles is greater than or equal to 360), and
+      #   start and end angles is greater than or equal to 360),
       #
       #     #>pdf-center
-      #     canvas.fill_color("red").
-      #       draw(:solid_arc, outer_a: 80, outer_b: 50, inner_a: 70, inner_b: 30,
-      #            end_angle: 360).
+      #     canvas.fill_color("hp-blue").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50, inner_a: 70, inner_b: 30).
       #       fill_stroke
       #
-      # * an (*elliptical*) *annular sector* (when the inner a/b are nonzero and the difference
+      # * and an (*elliptical*) *annular sector* (when the inner a/b are nonzero and the difference
       #   between start and end angles is less than 360)
       #
       #     #>pdf-center
-      #     canvas.fill_color("red").
+      #     canvas.fill_color("hp-blue").
       #       draw(:solid_arc, outer_a: 80, outer_b: 50, inner_a: 70, inner_b: 30,
       #            start_angle: 20, end_angle: 230).
       #       fill_stroke
@@ -90,7 +92,7 @@ module HexaPDF
           new.configure(**kwargs)
         end
 
-        # x-coordinate of center point
+        # x-coordinate of center point, defaults to 0.
         #
         # Examples:
         #
@@ -98,10 +100,10 @@ module HexaPDF
         #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, cx: 50).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50).stroke
         attr_reader :cx
 
-        # y-coordinate of center point
+        # y-coordinate of center point, defaults to 0.
         #
         # Examples:
         #
@@ -109,91 +111,96 @@ module HexaPDF
         #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, cy: 50).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cy: 50).stroke
         attr_reader :cy
 
         # Length of inner semi-major axis which (without altering the #inclination) is parallel to
-        # the x-axis
+        # the x-axis, defaults to 0.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, inner_a: 5).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, inner_a: 5).stroke
         attr_reader :inner_a
 
-        # Length of inner semi-minor axis which (without altering the #inclination) is parallel to the
-        # y-axis
+        # Length of inner semi-minor axis which (without altering the #inclination) is parallel to
+        # the y-axis, defaults to 0.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, inner_b: 20).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, inner_b: 20).stroke
         attr_reader :inner_b
 
         # Length of outer semi-major axis which (without altering the #inclination) is parallel to
-        # the x-axis
+        # the x-axis, defaults to 1.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, outer_a: 45).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, outer_a: 45).stroke
         attr_reader :outer_a
 
         # Length of outer semi-minor axis which (without altering the #inclination) is parallel to the
-        # y-axis
+        # y-axis, defaults to 1.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, outer_b: 40).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, outer_b: 40).stroke
         attr_reader :outer_b
 
-        # Start angle of the solid arc in degrees
+        # Start angle of the solid arc in degrees, defaults to 0.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, start_angle: 60).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, start_angle: 60).stroke
         attr_reader :start_angle
 
-        # End angle  of the solid arc in degrees
+        # End angle  of the solid arc in degrees, defaults to 0.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, end_angle: 120).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, end_angle: 120).stroke
         attr_reader :end_angle
 
-        # Inclination in degrees of semi-major axis in respect to x-axis
+        # Inclination in degrees of semi-major axis in respect to x-axis, defaults to 0.
         #
         # Examples:
         #
         #   #>pdf-center
-        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #   solid_arc = canvas.graphic_object(:solid_arc, cx: -50, outer_a: 30, outer_b: 20,
         #                                     inner_a: 20, inner_b: 10)
         #   canvas.draw(solid_arc).stroke
-        #   canvas.stroke_color("red").draw(solid_arc, inclination: 40).stroke
+        #   canvas.stroke_color("hp-blue").draw(solid_arc, cx: 50, inclination: 40).stroke
         attr_reader :inclination
 
         # Creates a solid arc with default values (a unit disk at the origin).
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   canvas.draw(:solid_arc).stroke
         def initialize
           @cx = @cy = 0
           @inner_a = @inner_b = 0
@@ -218,6 +225,13 @@ module HexaPDF
         # for the inital values.
         #
         # Returns self.
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc)
+        #   solid_arc.configure(outer_a: 30, outer_b: 20, inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
         def configure(cx: nil, cy: nil, inner_a: nil, inner_b: nil, outer_a: nil, outer_b: nil,
                       start_angle: nil, end_angle: nil, inclination: nil)
           @cx = cx if cx
@@ -234,6 +248,14 @@ module HexaPDF
         end
 
         # Draws the solid arc on the given Canvas.
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   solid_arc.draw(canvas)
+        #   canvas.stroke
         def draw(canvas)
           angle_difference = (@end_angle - @start_angle).abs
           if @inner_a == 0 && @inner_b == 0

data/lib/hexapdf/content/graphic_object.rb

@@ -49,16 +49,15 @@ module HexaPDF
     # A graphic object should only use the path creation methods or other graphic objects when it
     # is drawn. Stroking and filling, or optionally clipping, is left to the user.
     #
-    # The Content::Canvas class provides a Content::Canvas#draw method that can be used to draw
-    # complex graphic objects as well as a Content::Canvas#graphic_object method to retrieve an
-    # instance of a graphic object for custom use. The latter method uses graphic object factories
-    # that can be registered via a name using the document specific 'graphic_object.map'
-    # configuration option.
+    # The Canvas class provides a Canvas#draw method that can be used to draw complex graphic
+    # objects as well as a Canvas#graphic_object method to retrieve an instance of a graphic object
+    # for custom use. The latter method uses graphic object factories that can be registered via a
+    # name using the document specific 'graphic_object.map' configuration option.
     #
     # == Implementation of a Graphic Object
     #
-    # Graphic objects are normally implemented as classes since this automatically allows using
-    # the class itself as the graphic object's factory.
+    # Graphic objects are usually implemented as classes since this automatically allows using the
+    # class itself as the graphic object's factory.
     #
     # A graphic object factory is an object that responds to #configure(**kwargs) and returns a
     # configured graphic object. When the factory is implemented as a class, the #configure method

data/lib/hexapdf/content/graphics_state.rb

@@ -43,6 +43,8 @@ module HexaPDF
   module Content
 
     # Associates a name with a value, used by various graphics state parameters.
+    #
+    # See LineCapStyle, LineJoinStyle, TextRenderingMode
     class NamedValue
 
       # The value itself.
@@ -73,12 +75,12 @@ module HexaPDF
     end
 
     # Defines all available line cap styles as constants. Each line cap style is an instance of
-    # NamedValue, see ::normalize. For use with e.g. Content::Canvas#line_cap_style.
+    # NamedValue, see ::normalize. For use with e.g. Canvas#line_cap_style.
     #
-    # See: PDF1.7 s8.4.3.3
+    # See: PDF2.0 s8.4.3.3
     module LineCapStyle
 
-      # Returns the argument normalized to a valid line cap style.
+      # Returns the argument normalized to a valid line cap style, i.e. a NamedValue instance.
       #
       # * 0 or +:butt+ can be used for the BUTT_CAP style.
       # * 1 or +:round+ can be used for the ROUND_CAP style.
@@ -96,7 +98,7 @@ module HexaPDF
 
       # Stroke is squared off at the endpoint of a path.
       #
-      # Specify as 0 or :butt.
+      # Specify as 0 or +:butt+.
       #
       #   #>pdf-small-hide
       #   canvas.line_cap_style(:butt)
@@ -106,7 +108,7 @@ module HexaPDF
 
       # A semicircular arc is drawn at the endpoint of a path.
       #
-      # Specify as 1 or :round.
+      # Specify as 1 or +:round+.
       #
       #   #>pdf-small-hide
       #   canvas.line_cap_style(:round)
@@ -116,7 +118,7 @@ module HexaPDF
 
       # The stroke continues half the line width beyond the endpoint of a path.
       #
-      # Specify as 2 or :projecting_square.
+      # Specify as 2 or +:projecting_square+.
       #
       #   #>pdf-small-hide
       #   canvas.line_cap_style(:projecting_square)
@@ -127,12 +129,12 @@ module HexaPDF
     end
 
     # Defines all available line join styles as constants. Each line join style is an instance of
-    # NamedValue, see ::normalize For use with e.g. Content::Canvas#line_join_style.
+    # NamedValue, see ::normalize For use with e.g. Canvas#line_join_style.
     #
-    # See: PDF1.7 s8.4.3.4
+    # See: PDF2.0 s8.4.3.4
     module LineJoinStyle
 
-      # Returns the argument normalized to a valid line join style.
+      # Returns the argument normalized to a valid line join style, i.e. a NamedValue instance.
       #
       # * 0 or +:miter+ can be used for the MITER_JOIN style.
       # * 1 or +:round+ can be used for the ROUND_JOIN style.
@@ -150,7 +152,7 @@ module HexaPDF
 
       # The outer lines of the two segments continue until they meet at an angle.
       #
-      # Specify as 0 or :miter.
+      # Specify as 0 or +:miter+.
       #
       #   #>pdf-small-hide
       #   canvas.line_join_style(:miter)
@@ -162,7 +164,7 @@ module HexaPDF
 
       # An arc of a circle is drawn around the point where the segments meet.
       #
-      # Specify as 1 or :round.
+      # Specify as 1 or +:round+.
       #
       #   #>pdf-small-hide
       #   canvas.line_join_style(:round)
@@ -175,7 +177,7 @@ module HexaPDF
       # The two segments are finished with butt caps and the space between the ends is filled with a
       # triangle.
       #
-      # Specify as 2 or :bevel.
+      # Specify as 2 or +:bevel+.
       #
       #   #>pdf-small-hide
       #   canvas.line_join_style(:bevel)
@@ -188,7 +190,7 @@ module HexaPDF
     end
 
     # The line dash pattern defines how a line should be dashed. For use with e.g.
-    # Content::Canvas#line_dash_pattern.
+    # Canvas#line_dash_pattern.
     #
     # A dash pattern consists of two parts: the dash array and the dash phase. The dash array
     # defines the length of alternating dashes and gaps (important: starting with dashes). And the
@@ -204,7 +206,17 @@ module HexaPDF
     #   [3 5] 6                   2 unit gap, 3 unit dash, 5 unit gap, 3 unit dash, ...
     #   [2 3] 6                   1 unit dash, 3 unit gap, 2 unit dash, 3 unit gap, ...
     #
-    # See: PDF1.7 s8.4.3.6
+    # And visualized it looks like this:
+    #
+    #   #>pdf-canvas-hide
+    #   canvas.line_width(2)
+    #   [[[], 0], [[3], 0], [[3], 1], [[2, 1], 0],
+    #    [[3, 5], 6], [[2, 3], 6]].each_with_index do |(arr, phase), index|
+    #     canvas.line_dash_pattern(arr, phase)
+    #     canvas.line(20, 180 - index * 30, 180, 180 - index * 30).stroke
+    #   end
+    #
+    # See: PDF2.0 s8.4.3.6
     class LineDashPattern
 
       # :call-seq:
@@ -261,9 +273,9 @@ module HexaPDF
     end
 
     # Defines all available rendering intents as constants. For use with e.g.
-    # Content::Canvas#rendering_intent.
+    # Canvas#rendering_intent.
     #
-    # See: PDF1.7 s8.6.5.8
+    # See: PDF2.0 s8.6.5.8
     module RenderingIntent
 
       # Returns the argument normalized to a valid rendering intent.
@@ -295,12 +307,12 @@ module HexaPDF
     end
 
     # Defines all available text rendering modes as constants. Each text rendering mode is an
-    # instance of NamedValue. For use with e.g. Content::Canvas#text_rendering_mode.
+    # instance of NamedValue. For use with e.g. Canvas#text_rendering_mode.
     #
-    # See: PDF1.7 s9.3.6
+    # See: PDF2.0 s9.3.6
     module TextRenderingMode
 
-      # Returns the argument normalized to a valid text rendering mode.
+      # Returns the argument normalized to a valid text rendering mode, i.e. a NamedValue instance.
       #
       # * 0 or +:fill+ can be used for the FILL mode.
       # * 1 or +:stroke+ can be used for the STROKE mode.
@@ -328,95 +340,92 @@ module HexaPDF
 
       # Fill text.
       #
-      # Specify as 0 or :fill.
+      # Specify as 0 or +:fill+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
       #   canvas.text_rendering_mode(:fill)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       FILL = NamedValue.new(:fill, 0)
 
       # Stroke text.
       #
-      # Specify as 1 or :stroke.
+      # Specify as 1 or +:stroke+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.stroke_color("hp-blue").line_width(0.5)
       #   canvas.text_rendering_mode(:stroke)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       STROKE = NamedValue.new(:stroke, 1)
 
       # Fill, then stroke text.
       #
-      # Specify as 2 or :fill_stroke.
+      # Specify as 2 or +:fill_stroke+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.stroke_color("hp-blue").line_width(0.5)
       #   canvas.text_rendering_mode(:fill_stroke)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       FILL_STROKE = NamedValue.new(:fill_stroke, 2)
 
       # Neither fill nor stroke text (invisible).
       #
-      # Specify as 3 or :invisible.
+      # Specify as 3 or +:invisible+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
       #   canvas.text_rendering_mode(:invisible)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
-      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
+      #   canvas.stroke_color("hp-blue").line_width(20).line(30, 20, 30, 80).stroke
       INVISIBLE = NamedValue.new(:invisible, 3)
 
       # Fill text and add to path for clipping.
       #
-      # Specify as 4 or :fill_clip.
+      # Specify as 4 or +:fill_clip+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
       #   canvas.text_rendering_mode(:fill_clip)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
-      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
+      #   canvas.stroke_color("hp-orange").line_width(20).line(30, 20, 30, 80).stroke
       FILL_CLIP = NamedValue.new(:fill_clip, 4)
 
       # Stroke text and add to path for clipping.
       #
-      # Specify as 5 or :stroke_clip.
+      # Specify as 5 or +:stroke_clip+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.stroke_color("hp-blue").line_width(0.5)
       #   canvas.text_rendering_mode(:stroke_clip)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
-      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
+      #   canvas.stroke_color("hp-orange").line_width(20).line(30, 20, 30, 80).stroke
       STROKE_CLIP = NamedValue.new(:stroke_clip, 5)
 
       # Fill, then stroke text and add to path for clipping.
       #
-      # Specify as 6 or :fill_stroke_clip.
+      # Specify as 6 or +:fill_stroke_clip+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.stroke_color("hp-blue").line_width(0.5)
       #   canvas.text_rendering_mode(:fill_stroke_clip)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
-      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
+      #   canvas.stroke_color("hp-orange").line_width(20).line(30, 20, 30, 80).stroke
       FILL_STROKE_CLIP = NamedValue.new(:fill_stroke_clip, 6)
 
       # Add text to path for clipping.
       #
-      # Specify as 7 or :clip.
+      # Specify as 7 or +:clip+.
       #
       #   #>pdf-small-hide
       #   canvas.font("Helvetica", size: 13)
-      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.stroke_color("hp-blue").line_width(0.5)
       #   canvas.text_rendering_mode(:clip)
       #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
-      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
+      #   canvas.stroke_color("hp-orange").line_width(20).line(30, 20, 30, 80).stroke
       CLIP = NamedValue.new(:clip, 7)
 
     end
@@ -429,7 +438,7 @@ module HexaPDF
     #
     # The device-dependent graphics state parameters have not been implemented!
     #
-    # See: PDF1.7 s8.4.1
+    # See: PDF2.0 s8.4.1
     class GraphicsState
 
       # The current transformation matrix.
@@ -540,14 +549,14 @@ module HexaPDF
       #
       # This returns the character spacing multiplied by #scaled_horizontal_scaling.
       #
-      # See PDF1.7 s9.4.4
+      # See PDF2.0 s9.4.4
       attr_reader :scaled_character_spacing
 
       # The scaled word spacing used in glyph displacement calculations.
       #
       # This returns the word spacing  multiplied by #scaled_horizontal_scaling.
       #
-      # See PDF1.7 s9.4.4
+      # See PDF2.0 s9.4.4
       attr_reader :scaled_word_spacing
 
       # The scaled font size used in glyph displacement calculations.
@@ -556,7 +565,7 @@ module HexaPDF
       # (0.001 for all fonts except Type3 fonts or the scaling specified in /FontMatrix for Type3
       # fonts) and multiplied by #scaled_horizontal_scaling.
       #
-      # See PDF1.7 s9.4.4, HexaPDF::Type::FontType3
+      # See PDF2.0 s9.4.4, HexaPDF::Type::FontType3
       attr_reader :scaled_font_size
 
       # The scaled horizontal scaling used in glyph displacement calculations.
@@ -564,7 +573,7 @@ module HexaPDF
       # Since the horizontal scaling attribute is stored in percent of 100, this method returns the
       # correct value for calculations.
       #
-      # See PDF1.7 s9.4.4
+      # See PDF2.0 s9.4.4
       attr_reader :scaled_horizontal_scaling
 
       # Initializes the graphics state parameters to their default values.