Skip to content

Exclude types with @typedoc false from generated documentation #858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2018
Merged

Exclude types with @typedoc false from generated documentation #858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/ex_doc/retriever.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,11 +507,20 @@ defmodule ExDoc.Retriever do
exported = :lists.flatten(exported)

(Code.get_docs(module_info.name, :type_docs) || [])
|> Enum.filter(&elem(&1, 0) in exported)
|> Enum.filter(&(elem(&1, 0) in exported && typedoc?(&1)))
|> Enum.sort_by(&elem(&1, 0))
|> Enum.map(&get_type(&1, source, module_info.abst_code))
end

# Skip typedocs explicitly marked as false
defp typedoc?({_, _, _, false}) do
false
end

defp typedoc?({_, _, _, _}) do
true
end

defp get_type(type, source, abst_code) do
{{name, arity}, doc_line, _, doc} = type

Expand Down
2 changes: 2 additions & 0 deletions test/fixtures/types_and_specs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ defmodule TypesAndSpecs do
@typep private :: any
@opaque opaque :: {Dict.t}
@type ref :: {:binary.part, public(any)}
@typedoc false
@type internal :: any

@spec add(integer, opaque) :: integer
def add(x, _), do: x + x
Expand Down