Improve doc

lib/datagrid/column_names_attribute.rb

@@ -21,6 +21,7 @@ module ClassMethods
       # will always present in the grid table and won't be listed
       # in column names selection
       # Accepts same options as <tt>:enum</tt> filter
+      # @return [Datagrid::Filters::BaseFilter] Defined filter object
       # @example
       #   column_names_filter(header: "Choose columns")
       # @see Datagrid::Filters::ClassMethods#filter

lib/datagrid/columns.rb

@@ -243,8 +243,7 @@ def data(*column_names)
       self.rows(*column_names).unshift(self.header(*column_names))
     end
 
-    # Return Array of Hashes where keys are column names and values are column values
-    # for each row in filtered datagrid relation.
+    # @return [Array<{Symbol => Object}>] an array of hashes representing the rows in the filtered datagrid relation
     #
     # @example
     #   class MyGrid
@@ -301,7 +300,7 @@ def columns(*column_names, data: false, html: false)
     end
 
     # @param column_names [Array<String, Symbol>] list of column names if you want to limit data only to specified columns
-    # @return columns that can be represented in plain data(non-html) way
+    # @return [Array<Datagrid::Columns::Column>] columns that can be represented in plain data(non-html) way
     def data_columns(*column_names, **options)
       self.columns(*column_names, **options, data: true)
     end

lib/datagrid/core.rb

@@ -36,8 +36,7 @@ def datagrid_attribute(name, &block)
         end
       end
 
-      # Defines a scope at class level
-      # @return [void]
+      # @return [void] Defines a scope at class level
       # @example
       #   scope { User }
       #   scope { Project.where(deleted: false) }
@@ -123,6 +122,9 @@ def inherited(child_class)
 
     end
 
+    # @param [{String, Symbol => Object}, nil] attributes a hash of attributes to initialize the object
+    # @yield [block] an optional block that is passed to the scope method for further customization
+    # @return [void] Initializes a new instance with optional attributes and an optional block.
     def initialize(attributes = nil, &block)
       super()
 
@@ -175,7 +177,7 @@ def assets
       scope
     end
 
-    # Returns serializable query arguments skipping all nil values
+    # @return [{Symbol => Object}] serializable query arguments skipping all nil values
     # @example
     #   grid = ProductsGrid.new(category: 'dresses', available: true)
     #   grid.as_query # => {category: 'dresses', available: true}
@@ -187,7 +189,7 @@ def as_query
       attributes
     end
 
-    # @return [Hash<Symbol, Hash<Symbol, Object>>] query parameters to link this grid from a page
+    # @return [{ Symbol => { Symbol => Object } }] query parameters to link this grid from a page
     # @example
     #   grid = ProductsGrid.new(category: 'dresses', available: true)
     #   Rails.application.routes.url_helpers.products_path(grid.query_params)
@@ -196,7 +198,7 @@ def query_params(attributes = {})
       { param_name.to_sym => as_query.merge(attributes) }
     end
 
-    # Redefines scope at instance level
+    # @return [void] redefines scope at instance level
     # @example
     #   class MyGrid
     #     scope { Article.order('created_at desc') }
@@ -228,8 +230,7 @@ def original_scope
       scope_value.call
     end
 
-    # Resets current instance scope to default scope defined in a class
-    # @return [void]
+    # @return [void] Resets current instance scope to default scope defined in a class
     def reset_scope
       self.scope_value = self.class.scope_value
     end
@@ -263,8 +264,7 @@ def ==(other)
         scope == other.scope
     end
 
-    # Resets loaded assets and column values cache
-    # @return [void]
+    # @return [void] Resets loaded assets and column values cache
     def reset
       assets.reset
     end

lib/datagrid/filters.rb

@@ -47,7 +47,7 @@ def self.included(base)
 
     module ClassMethods
 
-      # @return [Datagrid::Filters::Filter, nil] filter definition object by name
+      # @return [Datagrid::Filters::BaseFilter, nil] filter definition object by name
       def filter_by_name(attribute)
         if attribute.is_a?(Datagrid::Filters::BaseFilter)
           unless ancestors.include?(attribute.grid_class)
@@ -68,7 +68,7 @@ def filter_by_name(attribute)
       # @param [Symbol] type filter type that defines type case and GUI representation of a filter
       # @param [Hash] options hash of options
       # @param [Proc] block proc to apply the filter
-      # @return [Datagrid::Filters::Filter] Filter definition object
+      # @return [Datagrid::Filters::BaseFilter] Filter definition object
       # @see https://github.com/bogdan/datagrid/wiki/Filters
       #
       # Available options:
@@ -120,7 +120,7 @@ def inspect
         "#{super}(#{filters_inspection})"
       end
 
-      # @return [Array<Datagrid::Filters::Filter>] all defined filters
+      # @return [Array<Datagrid::Filters::BaseFilter>] all defined filters
       def filters
         filters_array
       end
@@ -170,7 +170,7 @@ def filter_value_as_string(name)
       end
     end
 
-    # @return [Datagrid::Filters::Filter, nil] filter object with the given name
+    # @return [Datagrid::Filters::BaseFilter, nil] filter object with the given name
     def filter_by_name(name)
       self.class.filter_by_name(name)
     end
@@ -197,7 +197,7 @@ def select_values(filter)
       find_select_filter(filter).select_values(self)
     end
 
-    # @return [Array<Datagrid::Filters::Filter>] all currently enabled filters
+    # @return [Array<Datagrid::Filters::BaseFilter>] all currently enabled filters
     def filters
       self.class.filters.select do |filter|
         filter.enabled?(self)

lib/datagrid/helper.rb

@@ -74,6 +74,7 @@ def datagrid_header(grid, options = {})
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
     #
+    # @return [String]
     # @example
     #   = datagrid_rows(grid) # Generic table rows Layout
     #
@@ -85,7 +86,7 @@ def datagrid_rows(grid, assets = grid.assets, **options, &block)
       datagrid_renderer.rows(grid, assets, **options, &block)
     end
 
-    # Renders ordering controls for the given column name
+    # @return [String] renders ordering controls for the given column name
     #
     # Supported options:
     #
@@ -141,7 +142,6 @@ def datagrid_order_path(grid, column, descending)
       datagrid_renderer.order_path(grid, column, descending, request)
     end
 
-
     protected
 
     def datagrid_renderer

lib/datagrid/scaffold.rb

@@ -1,5 +1,6 @@
 require "rails/generators"
 
+# @!visibility private
 class Datagrid::Scaffold < Rails::Generators::NamedBase
 
   include Rails::Generators::ResourceHelpers

lib/datagrid/utils.rb

@@ -1,6 +1,6 @@
 module Datagrid
   # @!visibility private
-  module Utils # :nodoc:
+  module Utils
     class << self