lib/vedeu/interfaces/clear.rb in vedeu-0.8.15 vs lib/vedeu/interfaces/clear.rb in vedeu-0.8.16
- old
+ new
@@ -10,32 +10,22 @@
include Vedeu::Common
class << self
- # Clear the interface with the given name.
- #
- # @example
- # Vedeu.trigger(:_clear_view_, name)
- # Vedeu.clear_by_name(name)
- #
+ # {include:file:docs/dsl/by_method/clear_by_name.md}
# @return [Array<Array<Vedeu::Cells::Char>>]
# @see #initialize
def render(name = Vedeu.focus)
name || Vedeu.focus
new(name).render
end
alias clear_by_name render
alias by_name render
- # Clear the content of the interface with the given name.
- #
- # @example
- # Vedeu.trigger(:_clear_view_content_, name)
- # Vedeu.clear_content_by_name(name)
- #
+ # {include:file:docs/dsl/by_method/clear_content_by_name.md}
# @return [Array<Array<Vedeu::Cells::Char>>]
# @see #initialize
def clear_content_by_name(name = Vedeu.focus)
name || Vedeu.focus
@@ -44,11 +34,10 @@
end # Eigenclass
# Return a new instance of Vedeu::Interfaces::Clear.
#
- # @param name [String|Symbol] The name of the interface to
- # clear.
+ # @macro param_name
# @param options [Hash]
# @option options content_only [Boolean] Only clear the content
# not the border as well. Defaults to false.
# @option options direct [Boolean] Write the content directly
# to the terminal using a faster mechanism. The virtual buffer