# \#edoc

**URL:** https://erlangforums.com/tag/edoc/596.md

[Latest](https://erlangforums.com/latest.md) · [Categories](https://erlangforums.com/categories.md) · [Tags](https://erlangforums.com/tags.md)

---

## [Rebar3 ex\_doc crashes on a backtick in a comment for native -doc projects - is my fix in the right place?](https://erlangforums.com/t/rebar3-ex-doc-crashes-on-a-backtick-in-a-comment-for-native-doc-projects-is-my-fix-in-the-right-place/5730)

<div class="topic-metadata">

**Author:** [@eagle-head](https://erlangforums.com/u/eagle-head)\
**Replies:** 0\
**Last updated:** [June 19, 2026, 1:33am UTC](https://erlangforums.com/t/rebar3-ex-doc-crashes-on-a-backtick-in-a-comment-for-native-doc-projects-is-my-fix-in-the-right-place/5730 "2026-06-19T01:33:48Z")

</div>

Hi all :waving\_hand: While building HTML docs for a small Erlang lib of mine that’s documented 100% with native OTP 27+ attributes (-moduledoc / -doc, EEP-59 — zero @doc EDoc comments), rebar3 ex\_doc kept aborting with: …

---

## [Why is the documentation I write missing from my types? (OTP25, rebar3\_ex\_doc)](https://erlangforums.com/t/why-is-the-documentation-i-write-missing-from-my-types-otp25-rebar3-ex-doc/4493)

<div class="topic-metadata">

**Author:** [@weaver](https://erlangforums.com/u/weaver)\
**Replies:** 4\
**Last updated:** [February 22, 2025, 4:34pm UTC](https://erlangforums.com/t/why-is-the-documentation-i-write-missing-from-my-types-otp25-rebar3-ex-doc/4493 "2025-02-22T16:34:34Z")

</div>

Hi there! I’m generating documentation for a project written in OTP 25, and I’m trying to document my -type attributes. I’ve tried several different approaches (%% @doc before, %% on the same line, and %% after the -typ…

---

## [How to attach comments to forms when they are spaced by line breaks?](https://erlangforums.com/t/how-to-attach-comments-to-forms-when-they-are-spaced-by-line-breaks/3665)

<div class="topic-metadata">

**Author:** [@williamthome](https://erlangforums.com/u/williamthome)\
**Replies:** 3\
**Last updated:** [May 31, 2024, 4:14pm UTC](https://erlangforums.com/t/how-to-attach-comments-to-forms-when-they-are-spaced-by-line-breaks/3665 "2024-05-31T16:14:40Z")

</div>

For example: -module(foo). -export(\[foo/0, bar/0\]). %% @doc I'm attached to a function :) foo() -\> foo. %% @doc I'm not because of the line break :( bar() -\> bar. Running: 1\> {source, File} = proplists:lookup(sourc…

---

## [Documentation for types similar to Elixir's \`@typedoc\`](https://erlangforums.com/t/documentation-for-types-similar-to-elixirs-typedoc/2499)

<div class="topic-metadata">

**Author:** [@Benjamin-Philip](https://erlangforums.com/u/Benjamin-Philip)\
**Replies:** 1\
**Last updated:** [March 25, 2023, 8:51am UTC](https://erlangforums.com/t/documentation-for-types-similar-to-elixirs-typedoc/2499 "2023-03-25T08:51:23Z")

</div>

How do you write documentation for a type? For example, if I define a type in Elixir, I can write documentation for it like this: @typedoc """ A pet animal. """ @type pet :: :cat | :dog However, the following errors ou…

---

## [How to generate documentation for specific modules using rebar3?](https://erlangforums.com/t/how-to-generate-documentation-for-specific-modules-using-rebar3/2474)

<div class="topic-metadata">

**Author:** [@alfetahe](https://erlangforums.com/u/alfetahe)\
**Replies:** 3\
**Last updated:** [March 23, 2023, 2:13pm UTC](https://erlangforums.com/t/how-to-generate-documentation-for-specific-modules-using-rebar3/2474 "2023-03-23T14:13:20Z")

</div>

I am unable to generate documentation only for specific modules using rebar3 and when publishing the library, the documentation will be generated for all modules automatically. Now running this command locally I get the…