vrod
Hello! I am wondering if there is somewhere a “documentation cheetsheet”? I am looking at Writing documentation — Elixir v1.20.2 but I do not see a list of all available documentation attributes. I only see this sentence “such as @moduledoc, @typedoc, and @doc” but I am not knowing which options I can use or if other attributes are existing or which options they accept.
What should I use to documentation of @callback?
I am not seeing documentation for a function that implements callback. For exmaple:
defmodule Y do
@doc """
My documentation here
"""
@callback something() :: keyword()
end
defmodule X do
@behaviour Y
@impl true
def something() do
[a: "apple"]
end
end
However, my X module shows no functions in its documentation. This is not what I expect. ex_doc 0.24.2.
Thank you!
Trending in Questions
I’m aware of 2 such projects, are there others?
git: GitHub - team-alembic/realworld: A fullstack Phoenix LiveView application with back...
New
I having some trouble figuring out if I have set myself too strict of standards for my production server. Currently I can handle 75% of r...
New
Hi everyone.
My team and I have been working on a fairly modest app based around video streaming and chat, but we’ve landed a customer t...
New
I really like the adapter patterns that ecto, nebulex, waffle, etc. use and would love find something similar for a key management servic...
New
Hello folks!
So at work, we are seeing some situations where we have to define some “fixed” strings that are used across the codebase in...
New
How Can I Optimise Compile Time Dependencies
I have been building an elixir application for about 2 years now. Many modules and files ha...
New
Other Trending Topics
A little off-topic, but I feel like people here have a good head on their shoulders.
I used to be quite good at making software. Was luc...
New
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
I love Elixir. It’s one of 2 programming languages I’ve ever fallen in love with.
But I don’t use it anymore.
Serverless was the promis...
New
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #library
- #deployment
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #ai
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixirconf-us
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #elixirconf-eu
- #api
- #forms
- #security
- #metaprogramming










Showing Posts 1 to 8- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
hauleth
Just
@docwill work.vrod
Thank you hauleth! Does the above work for you? I still see no documented functions in
Xhauleth
I would need to check, because it have been some time since I have implemented last behaviour that required documentation in Elixir (I implement most of behaviours in Erlang).
axelson
@behaviour is documented in the documentation for Module. The rest of the attributes are documented there as well.
eksperimental
You are right. It is a bug in ExDoc
eksperimental
@vrod, I already filed a report callbacks implementations are not listed in the module if `@impl true` · Issue #1352 · elixir-lang/ex_doc · GitHub
Will look into into a submit a PR tonight if I can.
eksperimental
Actually, this behaviour comes from Elixir.
vrod
Thank you! I read the bug report and I think I understand what Jose has said.