From 7f309869f2c1f65f91b83c4f064a9361c5652f53 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Tue, 29 Jul 2014 00:34:27 -0400 Subject: [PATCH] Marking lots of stuff as :nodoc: --- lib/squib.rb | 4 +++- lib/squib/card.rb | 21 +++++++++++++++------ lib/squib/deck.rb | 9 +++++++++ lib/squib/graphics/background.rb | 2 ++ lib/squib/graphics/image.rb | 4 ++++ lib/squib/graphics/save_doc.rb | 1 + lib/squib/graphics/save_images.rb | 2 ++ lib/squib/graphics/shapes.rb | 2 ++ lib/squib/graphics/text.rb | 14 ++++++++++++++ lib/squib/input_helpers.rb | 2 ++ 10 files changed, 54 insertions(+), 7 deletions(-) diff --git a/lib/squib.rb b/lib/squib.rb index c4b84b6..12079b1 100644 --- a/lib/squib.rb +++ b/lib/squib.rb @@ -8,7 +8,9 @@ require 'squib/deck' require 'squib/card' module Squib - + + # :nodoc: + # @api private def logger @logger ||= Logger.new(STDOUT) end diff --git a/lib/squib/card.rb b/lib/squib/card.rb index 1e6cda7..8c7c3e6 100644 --- a/lib/squib/card.rb +++ b/lib/squib/card.rb @@ -2,11 +2,20 @@ require 'cairo' require 'squib/input_helpers' module Squib + # Back end graphics. Private. class Card - include Squib::InputHelpers - attr_reader :width, :height - attr_accessor :cairo_surface, :cairo_context + include Squib::InputHelpers + # :nodoc: + # @api private + attr_reader :width, :height + + # :nodoc: + # @api private + attr_accessor :cairo_surface, :cairo_context + + # :nodoc: + # @api private def initialize(deck, width, height) @deck=deck; @width=width; @height=height @cairo_surface = Cairo::ImageSurface.new(width,height) @@ -22,6 +31,6 @@ module Squib require 'squib/graphics/save_images' require 'squib/graphics/shapes' require 'squib/graphics/text' - - end -end \ No newline at end of file + + end + end \ No newline at end of file diff --git a/lib/squib/deck.rb b/lib/squib/deck.rb index c7c6a9d..49a6c29 100644 --- a/lib/squib/deck.rb +++ b/lib/squib/deck.rb @@ -14,8 +14,17 @@ module Squib class Deck include Enumerable include Squib::InputHelpers + + # :nodoc: + # @api private attr_reader :width, :height + + # :nodoc: + # @api private attr_reader :cards + + # :nodoc: + # @api private attr_reader :text_hint # Squib's constructor that sets the immutable properties. diff --git a/lib/squib/graphics/background.rb b/lib/squib/graphics/background.rb index c635b67..d4950d2 100644 --- a/lib/squib/graphics/background.rb +++ b/lib/squib/graphics/background.rb @@ -1,6 +1,8 @@ module Squib class Card + # :nodoc: + # @api private def background(color) cc = cairo_context cc.set_source_color(color) diff --git a/lib/squib/graphics/image.rb b/lib/squib/graphics/image.rb index e256350..22a1f6d 100644 --- a/lib/squib/graphics/image.rb +++ b/lib/squib/graphics/image.rb @@ -1,6 +1,8 @@ module Squib class Card + # :nodoc: + # @api private def png(file, x, y, alpha) cc = cairo_context png = Cairo::ImageSurface.from_png(file) @@ -8,6 +10,8 @@ module Squib cc.paint(alpha) end + # :nodoc: + # @api private def svg(file, id, x, y, width, height) svg = RSVG::Handle.new_from_file(file) width = svg.width if width == :native diff --git a/lib/squib/graphics/save_doc.rb b/lib/squib/graphics/save_doc.rb index 36443e1..0fd509a 100644 --- a/lib/squib/graphics/save_doc.rb +++ b/lib/squib/graphics/save_doc.rb @@ -34,6 +34,7 @@ module Squib end end + # :nodoc: # @api private def trim(surface, trim, width, height) if trim > 0 diff --git a/lib/squib/graphics/save_images.rb b/lib/squib/graphics/save_images.rb index 0155520..4635f8b 100644 --- a/lib/squib/graphics/save_images.rb +++ b/lib/squib/graphics/save_images.rb @@ -1,6 +1,8 @@ module Squib class Card + # :nodoc: + # @api private def save_png(i, dir, prefix) cairo_context.target.write_to_png("#{dir}/#{prefix}#{i}.png") end diff --git a/lib/squib/graphics/shapes.rb b/lib/squib/graphics/shapes.rb index c2d37f4..8fb1478 100644 --- a/lib/squib/graphics/shapes.rb +++ b/lib/squib/graphics/shapes.rb @@ -1,6 +1,8 @@ module Squib class Card + # :nodoc: + # @api private def rect(x, y, width, height, x_radius, y_radius, fill_color, stroke_color, stroke_width) cc = cairo_context cc.rounded_rectangle(x, y, width, height, x_radius, y_radius) diff --git a/lib/squib/graphics/text.rb b/lib/squib/graphics/text.rb index 3e89a28..7538b90 100644 --- a/lib/squib/graphics/text.rb +++ b/lib/squib/graphics/text.rb @@ -3,6 +3,8 @@ require 'pango' module Squib class Card + # :nodoc: + # @api private def draw_text_hint(x,y,layout, color) return if color.nil? && @deck.text_hint.nil? color ||= @deck.text_hint @@ -14,6 +16,8 @@ module Squib rect(x,y,w,h,0,0,'#0000',color, 2.0) end + # :nodoc: + # @api private def ellipsize(layout, options) unless options[:ellipsize].nil? h = { :none => Pango::Layout::ELLIPSIZE_NONE, @@ -28,6 +32,8 @@ module Squib layout end + # :nodoc: + # @api private def wrap(layout, options) unless options[:wrap].nil? h = { :word => Pango::Layout::WRAP_WORD, @@ -42,6 +48,8 @@ module Squib layout end + # :nodoc: + # @api private def align(layout, options) unless options[:align].nil? h = { :left => Pango::ALIGN_LEFT, @@ -53,6 +61,8 @@ module Squib layout end + # :nodoc: + # @api private def valign(cc, layout, extents, x, y, valign) if layout.height > 0 case valign @@ -64,12 +74,16 @@ module Squib end end + # :nodoc: + # @api private def setwh(layout, options) layout.width = options[:width] * Pango::SCALE unless options[:width].nil? || options[:width] == :native layout.height = options[:height] * Pango::SCALE unless options[:height].nil? || options[:height] == :native layout end + # :nodoc: + # @api private def text(str, font, x, y, color, options) cc = cairo_context cc.set_source_color(color) diff --git a/lib/squib/input_helpers.rb b/lib/squib/input_helpers.rb index 8350b4c..27d6d85 100644 --- a/lib/squib/input_helpers.rb +++ b/lib/squib/input_helpers.rb @@ -1,6 +1,8 @@ require 'squib/constants' module Squib + # :nodoc: + # @api private module InputHelpers # @api private