I would like to add the documentation of a function to the official documentation page. It should have been a one liner to do this, but now I am somehow stuck… There is already a docstring available. However, I need to add the function declaration to the docs/src/index.md file. The function looks …

You can do ```@docs MyType MyType(::Integer) ``` if you have a docstring for both the type and the functor. But do note that you can run into trouble if you have a constructor and a functor method with the same signature – due to a docsystem bug, one of them will get overwritten by the other.

How to document this

General Usage

roble June 22, 2020, 9:57am 7

I am thankful for you two @zekeriya.sari and @mortenpi looking into this. I think the PR where I had this issue passed the checks now and should sometime be merged

Topic		Replies	Views
Documenter.jl: @ref a specific method of a function General Usage documentation , documenter	4	1762	February 3, 2018
Is there a way to automatically generate documentation for all functions in a module General Usage documentation	1	1256	June 12, 2018
Assembling documentation in a loop General Usage documentation	0	401	November 28, 2018
Documenting a functor / callable struct General Usage functors	5	3871	January 18, 2018
Documenter: @ref to another module New to Julia	2	862	September 11, 2018

How to document this

Related topics