Skip to content

Commit

Permalink
Add @moduledoc false to modules that don't need HexDocs documentation (
Browse files Browse the repository at this point in the history
…closes #162) and create a basic ExDoc config (#163)

* solves: #162

Add @moduledoc false to all modules except:
Hologram
Hologram.AssetNotFoundError
Hologram.CompileError
Hologram.Component
Hologram.Component.Action
Hologram.Component.Command
Hologram.Page
Hologram.ParamError
Hologram.Router
Hologram.Router.Helpers
Hologram.Server
Hologram.Socket
Hologram.TemplateSyntaxError
Hologram.UI.Link
Hologram.UI.Runtime
Mix.Tasks.Compile.Hologram
Mix.Tasks.Holo.Compiler.ExRuntimeMfas
Mix.Tasks.Holo.Compiler.PageExFunSizes
Mix.Tasks.Holo.Compiler.PageToMfaPaths
Mix.Tasks.Holo.Compiler.RuntimeToMfaPaths
Mix.Tasks.Holo.Routes
Mix.Tasks.Holo.Test.CheckFileNames

Note: the compiler warns about references to types within below hidden modules:
Hologram.Commons.Types
Hologram.Compiler.AST

* Suggested docs project configuration
TODO: create git tags and change source_ref value to current app version

* Remove api_reference and main docs configuration.
  • Loading branch information
Eiji7 authored Jan 22, 2025
1 parent 958fc16 commit 5361cdf
Show file tree
Hide file tree
Showing 162 changed files with 496 additions and 91 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Components.DefaultLayout do
@moduledoc false

use Hologram.Component
alias Hologram.UI.Runtime

Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page1.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page1 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page10.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page10 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page100.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page100 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page11.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page11 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page12.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page12 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page13.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page13 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page14.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page14 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page15.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page15 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page16.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page16 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page17.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page17 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page18.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page18 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page19.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page19 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page2.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page2 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page20.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page20 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page21.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page21 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page22.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page22 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page23.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page23 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page24.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page24 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page25.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page25 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page26.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page26 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page27.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page27 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page28.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page28 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page29.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page29 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page3.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page3 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page30.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page30 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page31.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page31 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page32.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page32 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page33.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page33 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page34.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page34 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page35.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page35 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page36.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page36 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page37.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page37 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page38.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page38 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page39.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page39 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page4.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page4 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page40.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page40 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page41.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page41 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page42.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page42 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page43.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page43 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page44.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page44 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page45.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page45 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page46.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page46 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page47.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page47 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page48.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page48 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page49.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page49 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page5.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page5 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page50.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page50 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page51.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page51 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
2 changes: 2 additions & 0 deletions benchmarks/support/fixtures/pages/page52.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# credo:disable-for-this-file Credo.Check.Readability.Specs
defmodule Hologram.Benchmarks.Fixtures.Page52 do
@moduledoc false

use Hologram.Page

import Hologram.Commons.KernelUtils, only: [inspect: 1]
Expand Down
Loading

0 comments on commit 5361cdf

Please sign in to comment.