Skip to content

Doc comments with * at the beginning of each lines. #1224

@panglesd

Description

@panglesd

I've seen several libraries use this style of comments:

    (** [decode_float dec buff ofs len] decodes [len] samples in each channel and puts
      * the result in [buff] starting at position [ofs].
      * @raise Hole_in_data if there was an interruption of the data.
      * @raise Invalid_parameters if all the data cannot fit in the buffer starting at the given position.
      *)

However, the * at the beginning of lines confuse odoc. Should this be dealt in the odoc parser, or upstream in OCaml?

Here are some examples, taken from @jonludlam's list in #1138:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions