chore: update modules docs

Author: heywhy

lib/elasticlunr/core/document_store.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.DocumentStore do
-  @moduledoc false
-
   alias Elasticlunr.Index
 
   defstruct save: true, documents: %{}, document_info: %{}, length: 0

lib/elasticlunr/core/field.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Field do
-  @moduledoc false
-
   alias Elasticlunr.{Index, Pipeline, Token, Utils}
 
   @fields ~w[pipeline query_pipeline store store_positions flnorm tf idf ids documents terms]a

lib/elasticlunr/core/index.ex

@@ -12,8 +12,6 @@ defmodule Elasticlunr.Index.IdPipeline do
 end
 
 defmodule Elasticlunr.Index do
-  @moduledoc false
-
   alias Elasticlunr.{Field, Pipeline, Token}
   alias Elasticlunr.Index.IdPipeline
   alias Elasticlunr.Dsl.{Query, QueryRepository}

lib/elasticlunr/core/token.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Token do
-  @moduledoc false
-
   defstruct ~w[token metadata]a
 
   @type t :: %__MODULE__{

lib/elasticlunr/dsl/query.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Dsl.Query do
-  @moduledoc false
-
   alias Elasticlunr.{Index, Dsl.QueryRepository}
 
   @type score_results ::

lib/elasticlunr/dsl/query/bool_query.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.Dsl.BoolQuery do
-  @moduledoc false
   use Elasticlunr.Dsl.Query
 
   alias Elasticlunr.Index

lib/elasticlunr/dsl/query/match_all_query.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.Dsl.MatchAllQuery do
-  @moduledoc false
   use Elasticlunr.Dsl.Query
 
   alias Elasticlunr.Index

lib/elasticlunr/dsl/query/match_query.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.Dsl.MatchQuery do
-  @moduledoc false
   use Elasticlunr.Dsl.Query
 
   alias Elasticlunr.{Index, Dsl.QueryRepository}

lib/elasticlunr/dsl/query/not_query.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.Dsl.NotQuery do
-  @moduledoc false
   use Elasticlunr.Dsl.Query
 
   alias Elasticlunr.Index

lib/elasticlunr/dsl/query/terms_query.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.Dsl.TermsQuery do
-  @moduledoc false
   use Elasticlunr.Dsl.Query
 
   alias Elasticlunr.{Index, Token}

lib/elasticlunr/dsl/query_repository.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Dsl.QueryRepository do
-  @moduledoc false
-
   alias Elasticlunr.Dsl.{BoolQuery, MatchAllQuery, MatchQuery, NotQuery, TermsQuery}
 
   def get(:not), do: NotQuery

lib/elasticlunr/manager/index_manager.ex

@@ -1,5 +1,4 @@
 defmodule Elasticlunr.IndexManager do
-  @moduledoc false
   use GenServer
 
   alias Elasticlunr.{Index, IndexRegistry, IndexSupervisor}

lib/elasticlunr/pipeline.ex

@@ -1,13 +1,11 @@
 defmodule Elasticlunr.Pipeline do
-  @moduledoc false
-
   alias Elasticlunr.{Token, Tokenizer}
   alias Elasticlunr.Pipeline.{Stemmer, StopWordFilter, Trimmer}
 
   defstruct callback: []
 
   @type t :: %__MODULE__{
-          callback: list()
+          callback: list(module() | function())
         }
 
   @callback call(Token.t()) :: Token.t() | list(Token.t()) | nil

lib/elasticlunr/pipeline/stemmer.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Pipeline.Stemmer do
-  @moduledoc false
-
   alias Elasticlunr.Token
 
   @behaviour Elasticlunr.Pipeline

lib/elasticlunr/pipeline/stop_word_filter.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Pipeline.StopWordFilter do
-  @moduledoc false
-
   alias Elasticlunr.Token
 
   @behaviour Elasticlunr.Pipeline

lib/elasticlunr/pipeline/trimmer.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Pipeline.Trimmer do
-  @moduledoc false
-
   alias Elasticlunr.Token
 
   @behaviour Elasticlunr.Pipeline

lib/elasticlunr/tokenizer.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Tokenizer do
-  @moduledoc false
-
   alias Elasticlunr.Token
 
   @default_separator ~r/[\s\-]+/

lib/elasticlunr/utils/process.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Utils.Process do
-  @moduledoc false
-
   @spec child_pid?(tuple, atom) :: boolean
   def child_pid?({:undefined, pid, :worker, [mod]}, mod) when is_pid(pid), do: true
   def child_pid?(_child, _module), do: false

lib/elasticlunr/utlis.ex

@@ -1,6 +1,4 @@
 defmodule Elasticlunr.Utils do
-  @moduledoc false
-
   @spec levenshtein_distance(binary, binary) :: integer()
   def levenshtein_distance(a, b) do
     ta = String.downcase(a) |> to_charlist |> List.to_tuple()