Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
ocamldoc: @param tags #8804
The command that I use is
In fact, I have in the module Utils the following code:
However, if I use just the name of the part of an argument, it works:
But I don't really understand why.
Thank you in advance for your reading.
There are two issues going on simultaneously here.
(** Return the last location of a program @param block The block of C/ASM located statements @return The last location of the block *) let lastLocOfProgram (program : loc * ('a * loc) list) : loc =
Second, it seems that ocamldoc does not know how to extract argument names when a single argument is explicitly annotated as a tuple.
Note that those two problems do not affect your second example.
Thus an easy workaround four your first example would be to both
@rudelune if you are new to ocaml, I think it may also be useful to add that
A good pattern you'll find in part of stdlib itself (see for example the documentation of the Array module) is to have a sample function call that names your arguments and then have a free form text describing the resulting value of the function using the argument names.
Applying the pattern to your case, a more idiomatic way would be:
Do you think that I would leave this issue unclosed because of the bug about types annotation?
Thank you again!