You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While writing the documentation for a project, it appeared to me that odoc was generating a category for the parameters of my functor:
However, even when trying to add a comment to my functor argument (I tried several things), odoc seemed to ignore them while ocamlformat was giving me the following error:
[unexpected-docstring]: unattached documentation comment (ignored) Hint: (Warning 50) This file contains a documentation comment (** ... *) that the OCaml compiler does not know how to attach to the AST.
Would it be possible to add the support for such a thing ? The error from ocamlformat & a private disussion with @Julow seems to indicate that it would not be that easy and would require some changes to the compiler, but it would be a really nice addition to be able to directly comment them and use the Parameters category rather than use @param inside the functor's documentation.
The text was updated successfully, but these errors were encountered:
I think that documentation comments on functor parameter definitions would be a good addition to the language. But until this is implemented and accepted upstream, perhaps we could handle @param tags specifically in cases of functors ?
I suggest attaching @param under the corresponding argument in the "Parameters" section. A warning would be generated for @param tags that do not name an existing parameter but it wouldn't be dropped.
While writing the documentation for a project, it appeared to me that
odoc
was generating a category for the parameters of my functor:However, even when trying to add a comment to my functor argument (I tried several things),
odoc
seemed to ignore them whileocamlformat
was giving me the following error:Would it be possible to add the support for such a thing ? The error from
ocamlformat
& a private disussion with @Julow seems to indicate that it would not be that easy and would require some changes to the compiler, but it would be a really nice addition to be able to directly comment them and use theParameters
category rather than use@param
inside the functor's documentation.The text was updated successfully, but these errors were encountered: