[Proposal] @docp for private docs

[Niklas Johansson]

I think it would be great to have the possibility to write documentations for private functions similar to writing documentation for public functions. Maybe something like this.

@docp """
Increase with one
"""
defp convert(x) do
  x + 1
end

This tag will not generate "real" documentation but aims to make the code more readable "in the editor". And to help other developers understand the private function.

By using @docp, it will look very simlar to a public function with a @doc tag.

Kind regards
Niklas

[esurk....@gmail.com]

Hi Niklas,

This has already been discussed a few times.

https://elixirforum.com/t/proposal-docp-for-private-function-documentation-and-doctests/3732

https://groups.google.com/g/elixir-lang-talk/c/0JKd9XKmIas/m/5927z5BdBgAJ

Kind regrads

Marcus