dsnipe

dsnipe

Hello.
I’m using ApiDoc to create a documentation for my API with this hex: GitHub - sldab/mix_apidoc: An Elixir Mix task for apidoc · GitHub
So I define many @apidoc module attributes for few modules. As they are never used inside functions I’m getting a warning: module attribute @apidoc was set but never used. Which is not a big deal, but a bit annoying.
Is there any way to suppress these warnings for a whole application?

Showing Posts 1 to 3

NobbZ

NobbZ

Yes, consume the attributes or do not set them. This warning was introduced with Elixir 1.4 as far as I remember, so sldab had a lot of time to react on this change.

Elixir wise you can not do anything about the warning except for fixing it.

mbuhot

mbuhot

You might be able to create a macro api_doc with the generated: true option to declare the attribute?

dsnipe

dsnipe OP

I solved the problem.
It’s possible to use @before_compile hook and invoke Module.delete_attribute(env.module, :apidoc) inside it. So it removes all attributes before a compilation.
In my case, I use Phoenix controllers.
So I put in my_project_web.ex inside quote:

def controller
  quote do
    @before_compile MyProjectWeb
    # ...
  end
end

and in the root of MyProjectWeb module added function:

  def __before_compile__(env) do
    Module.delete_attribute(env.module, :apidoc)
  end
— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
kpanic
Hi everyone, I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding. I sta...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New
apz
I’m new to elixir and just tried to install the elixirLS extension for VScode(ium) and it is throwing some errors that I would like help ...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews