doc correct

Mohammed Sadique · Mohammed Sadique · commit 6047dfe15312 · 2025-01-10T16:35:42.000+05:30
diff --git a/lib/matplotex/blueprint.ex b/lib/matplotex/blueprint.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Blueprint do
+@moduledoc false
   @callback new(graph :: module(), params :: map()) :: any()
   @callback set_content(graphset :: any()) :: any()
   @callback add_elements(graphset :: any()) :: any()
diff --git a/lib/matplotex/blueprint/chord.ex b/lib/matplotex/blueprint/chord.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Blueprint.Chord do
+@moduledoc false
   @true_by_default false
   @false_by_default true
   defmacro chord(opts \\ []) do
diff --git a/lib/matplotex/blueprint/frame.ex b/lib/matplotex/blueprint/frame.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Blueprint.Frame do
+@moduledoc false
   alias Matplotex.Figure.Legend
   @default_margin 0.05
   @show_by_default true
diff --git a/lib/matplotex/element.ex b/lib/matplotex/element.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element do
+@moduledoc false
   @callback assemble(element :: struct()) :: String.t()
   def assemble(%module{} = element), do: module.assemble(element)
 
diff --git a/lib/matplotex/element/circle.ex b/lib/matplotex/element/circle.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Circle do
+@moduledoc false
   alias Matplotex.Element
   use Element
 
diff --git a/lib/matplotex/element/label.ex b/lib/matplotex/element/label.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Label do
+@moduledoc false
   alias Matplotex.Element
   use Element
   @default_fill "black"
diff --git a/lib/matplotex/element/legend.ex b/lib/matplotex/element/legend.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Legend do
+@moduledoc false
   alias Matplotex.Element.Label
   alias Matplotex.Element
 
diff --git a/lib/matplotex/element/line.ex b/lib/matplotex/element/line.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Line do
+@moduledoc false
   alias Matplotex.Element
   use Element
 
diff --git a/lib/matplotex/element/polygon.ex b/lib/matplotex/element/polygon.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Polygon do
+@moduledoc false
   alias Matplotex.Element
   use Element
   @default_fill "blue"
diff --git a/lib/matplotex/element/rad_legend.ex b/lib/matplotex/element/rad_legend.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.RadLegend do
+@moduledoc false
   alias Matplotex.Element.Label
   alias Matplotex.Element
   alias Matplotex.Element.Rect
diff --git a/lib/matplotex/element/rect.ex b/lib/matplotex/element/rect.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Rect do
+@moduledoc false
   alias Matplotex.Element
 
   @default_stroke_width 2
diff --git a/lib/matplotex/element/slice.ex b/lib/matplotex/element/slice.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Slice do
+@moduledoc false
   alias Matplotex.Element
   use Element
 
diff --git a/lib/matplotex/element/spline.ex b/lib/matplotex/element/spline.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Spline do
+@moduledoc false
   alias Matplotex.Element
   use Element
   @default_stroke_width 2
diff --git a/lib/matplotex/element/stencil.ex b/lib/matplotex/element/stencil.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Stencil do
+@moduledoc false
   def line(line) do
     ~s(
     <line
diff --git a/lib/matplotex/element/tick.ex b/lib/matplotex/element/tick.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Element.Tick do
+@moduledoc false
   alias Matplotex.Element
   alias Matplotex.Element.Line
   alias Matplotex.Element.Label
diff --git a/lib/matplotex/figure.ex b/lib/matplotex/figure.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure do
+@moduledoc false
   alias Matplotex.Figure.RcParams
   @row_column_default 1
   @margin_default 0.05
diff --git a/lib/matplotex/figure/areal.ex b/lib/matplotex/figure/areal.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal do
+@moduledoc false
   alias Matplotex.Figure.Areal.Ticker
   alias Matplotex.Utils.Algebra
   alias Matplotex.Figure.Dataset
diff --git a/lib/matplotex/figure/areal/bar_chart.ex b/lib/matplotex/figure/areal/bar_chart.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.BarChart do
+@moduledoc false
   import Matplotex.Figure.Numer
   alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Figure.Areal.Region
diff --git a/lib/matplotex/figure/areal/histogram.ex b/lib/matplotex/figure/areal/histogram.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Histogram do
+@moduledoc false
   alias Matplotex.Element.Rect
   alias Matplotex.Figure.RcParams
   alias Matplotex.Figure.Areal.PlotOptions
diff --git a/lib/matplotex/figure/areal/line_plot.ex b/lib/matplotex/figure/areal/line_plot.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.LinePlot do
+@moduledoc false
   alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Utils.Algebra
   alias Matplotex.Figure.Areal.Region
diff --git a/lib/matplotex/figure/areal/plot_options.ex b/lib/matplotex/figure/areal/plot_options.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.PlotOptions do
+@moduledoc false
   alias Matplotex.Figure
   alias Matplotex.Figure.TwoD
   alias Matplotex.Figure.RcParams
diff --git a/lib/matplotex/figure/areal/region.ex b/lib/matplotex/figure/areal/region.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Region do
+@moduledoc false
   alias Matplotex.Figure.Areal.XyRegion.Coords
   @zero_by_default 0
   defstruct x: @zero_by_default,
diff --git a/lib/matplotex/figure/areal/scatter.ex b/lib/matplotex/figure/areal/scatter.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Scatter do
+@moduledoc false
   alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Figure.Areal.Region
   alias Matplotex.Figure.Areal.Ticker
diff --git a/lib/matplotex/figure/areal/spline.ex b/lib/matplotex/figure/areal/spline.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Spline do
+@moduledoc false
   alias Matplotex.Element.Spline
   alias Matplotex.Figure.RcParams
   alias Matplotex.Figure.Areal
diff --git a/lib/matplotex/figure/areal/ticker.ex b/lib/matplotex/figure/areal/ticker.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Ticker do
+@moduledoc false
   @tick_in_plot 5
   def generate_ticks({min, max}) do
     step = (max - min) / @tick_in_plot
diff --git a/lib/matplotex/figure/areal/xy_region/coords.ex b/lib/matplotex/figure/areal/xy_region/coords.ex
@@ -1,3 +1,4 @@
 defmodule Matplotex.Figure.Areal.XyRegion.Coords do
+@moduledoc false
   defstruct [:label, :ticks, :grids]
 end
diff --git a/lib/matplotex/figure/cast.ex b/lib/matplotex/figure/cast.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Cast do
+@moduledoc false
   alias Matplotex.Figure.Lead
   alias Matplotex.Element.Legend
   alias Matplotex.Utils.Algebra
diff --git a/lib/matplotex/figure/coords.ex b/lib/matplotex/figure/coords.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Coords do
+@moduledoc false
   defstruct [
     :title,
     :x_label,
diff --git a/lib/matplotex/figure/dataset.ex b/lib/matplotex/figure/dataset.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Dataset do
+@moduledoc false
   @default_color "blue"
   @default_marker "o"
   @default_linestyle "_"
diff --git a/lib/matplotex/figure/dimension.ex b/lib/matplotex/figure/dimension.ex
@@ -1,3 +1,4 @@
 defmodule Matplotex.Figure.Dimension do
+@moduledoc false
   defstruct [:x_label, :y_label, :x_tick, :y_tick, :title]
 end
diff --git a/lib/matplotex/figure/font.ex b/lib/matplotex/figure/font.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Font do
+@moduledoc false
   @default_font_color "black"
   @default_font_family "Arial, Verdana, sans-serif"
   @default_font_style "normal"
diff --git a/lib/matplotex/figure/lead.ex b/lib/matplotex/figure/lead.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Lead do
+@moduledoc false
   alias Matplotex.Utils.Algebra
   alias Matplotex.Figure.Areal.XyRegion.Coords, as: XyCoords
   alias Matplotex.Figure.Font
diff --git a/lib/matplotex/figure/legend.ex b/lib/matplotex/figure/legend.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Legend do
+@moduledoc false
   defstruct [:labels, :title, :colors, :position, :size]
 
   @type t() :: %__MODULE__{labels: list(), title: String.t(), position: atom(), size: tuple()}
diff --git a/lib/matplotex/figure/marker.ex b/lib/matplotex/figure/marker.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Marker do
+@moduledoc false
   alias Matplotex.Utils.Algebra
   alias Matplotex.Element.Rect
   alias Matplotex.Element.Polygon
diff --git a/lib/matplotex/figure/numer.ex b/lib/matplotex/figure/numer.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Numer do
+@moduledoc false
   def round_to_best(value) when value > 10 do
     factor = value |> :math.log10() |> floor()
 
diff --git a/lib/matplotex/figure/radial.ex b/lib/matplotex/figure/radial.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Radial do
+@moduledoc false
   alias Matplotex.Utils.Algebra
 
   @callback create(struct(), list(), keyword()) :: struct()
diff --git a/lib/matplotex/figure/radial/accumulator.ex b/lib/matplotex/figure/radial/accumulator.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Radial.Accumulator do
+@moduledoc false
   alias Matplotex.Figure.Radial.LegendAcc
 
   @start_angle :math.pi() / 2
diff --git a/lib/matplotex/figure/radial/dataset.ex b/lib/matplotex/figure/radial/dataset.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Radial.Dataset do
+@moduledoc false
   defstruct sizes: [],
             labels: [],
             colors: [],
diff --git a/lib/matplotex/figure/radial/legend_acc.ex b/lib/matplotex/figure/radial/legend_acc.ex
@@ -1,3 +1,4 @@
 defmodule Matplotex.Figure.Radial.LegendAcc do
+@moduledoc false
   defstruct [:x, :y, :uheight, :uwidth]
 end
diff --git a/lib/matplotex/figure/radial/pie.ex b/lib/matplotex/figure/radial/pie.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Radial.Pie do
+@moduledoc false
   alias Matplotex.Figure.RcParams
   alias Matplotex.Utils.Algebra
   alias Matplotex.Figure.Areal.Region
diff --git a/lib/matplotex/figure/rc_params.ex b/lib/matplotex/figure/rc_params.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.RcParams do
+@moduledoc false
   alias Matplotex.Figure.Font
   @default_figsize {8, 6}
   @default_dpi 96
diff --git a/lib/matplotex/figure/sketch.ex b/lib/matplotex/figure/sketch.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Sketch do
+@moduledoc false
   alias Matplotex.Figure
   @dpi 96
 
diff --git a/lib/matplotex/figure/text.ex b/lib/matplotex/figure/text.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Text do
+@moduledoc false
   alias Matplotex.Figure.Text
   alias Matplotex.Figure.Font
 
diff --git a/lib/matplotex/figure/two_d.ex b/lib/matplotex/figure/two_d.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.TwoD do
+@moduledoc false
   defstruct [:x, :y]
 
   def update(%__MODULE__{x: x, y: y} = twod, opts, context) do
diff --git a/lib/matplotex/helpers.ex b/lib/matplotex/helpers.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Helpers do
+@moduledoc false
   def copy(term) do
     text =
       if is_binary(term) do
diff --git a/lib/matplotex/utils/algebra.ex b/lib/matplotex/utils/algebra.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Utils.Algebra do
+@moduledoc false
   alias Nx
 
   @tensor_data_type_bits 64
diff --git a/lib/matplotex/utils/helpers.ex b/lib/matplotex/utils/helpers.ex
@@ -1,16 +1,17 @@
 defmodule Matplotex.Utils.Helpers do
-  @moduledoc """
-  Module contains some misslenious helper functions
-  """
+@moduledoc false
+  # @moduledoc """
+  # Module contains some misslenious helper functions
+  # """
 
-  @doc """
-  Input params may contains params for that chart struct and params for
-  content struct this functions sgregates that and return a tuple with
-  params for chart struct and content struct.
-  ### Params
-  * params - Map contains input params
-  * content_fields - list of atoms contains field names
-  """
+  # @doc """
+  # Input params may contains params for that chart struct and params for
+  # content struct this functions sgregates that and return a tuple with
+  # params for chart struct and content struct.
+  # ### Params
+  # * params - Map contains input params
+  # * content_fields - list of atoms contains field names
+  # """
 
   @spec segregate_content(any(), list()) :: {any(), any()}
   def segregate_content(params, content_fields) do
diff --git a/lib/matplotex/utils/input_error.ex b/lib/matplotex/utils/input_error.ex
@@ -1,3 +1,4 @@
 defmodule Matplotex.InputError do
+@moduledoc false
   defexception [:keys, :message]
 end
diff --git a/lib/matplotex/utils/math_func.ex b/lib/matplotex/utils/math_func.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Utilities.MathFunc do
+@moduledoc false
   alias NX
   @tensor_double_data_type_bits 64
   def euclidean_distance(x1, y1, x2, y2) do
diff --git a/lib/matplotex/utils/svg.ex b/lib/matplotex/utils/svg.ex
@@ -1,7 +1,6 @@
 defmodule Matplotex.Utils.Svg do
-  @moduledoc """
-  Modules to wrap function shares common svg functions
-  """
+@moduledoc false
+
   def wrap_with_frame(%{width: width, height: height}, svg) do
     ~s(<svg width="#{width}"
     height="#{height}"
diff --git a/lib/matplotex/validation/helpers.ex b/lib/matplotex/validation/helpers.ex
@@ -1,4 +1,5 @@
 defmodule Matplotex.Validation.Helpers do
+@moduledoc false
   alias Matplotex.InputError
 
   # TODO: Move module specific validators to particular module

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Blueprint do`
	`2`	`+@moduledoc false`
`2`	`3`	`@callback new(graph :: module(), params :: map()) :: any()`
`3`	`4`	`@callback set_content(graphset :: any()) :: any()`
`4`	`5`	`@callback add_elements(graphset :: any()) :: any()`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Blueprint.Chord do`
	`2`	`+@moduledoc false`
`2`	`3`	`@true_by_default false`
`3`	`4`	`@false_by_default true`
`4`	`5`	`defmacro chord(opts \\ []) do`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Blueprint.Frame do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Figure.Legend`
`3`	`4`	`@default_margin 0.05`
`4`	`5`	`@show_by_default true`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element do`
	`2`	`+@moduledoc false`
`2`	`3`	`@callback assemble(element :: struct()) :: String.t()`
`3`	`4`	`def assemble(%module{} = element), do: module.assemble(element)`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.Circle do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element`
`3`	`4`	`use Element`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.Label do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element`
`3`	`4`	`use Element`
`4`	`5`	`@default_fill "black"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.Legend do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element.Label`
`3`	`4`	`alias Matplotex.Element`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.Line do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element`
`3`	`4`	`use Element`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.Polygon do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element`
`3`	`4`	`use Element`
`4`	`5`	`@default_fill "blue"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`defmodule Matplotex.Element.RadLegend do`
	`2`	`+@moduledoc false`
`2`	`3`	`alias Matplotex.Element.Label`
`3`	`4`	`alias Matplotex.Element`
`4`	`5`	`alias Matplotex.Element.Rect`