@param attributes lost in translation in EEP 59

[robertoaloi]

The old-style EDoc allowed the @param tag to document individual function parameters.

When applying an automatic conversion from EDoc to EEP 59 doc attributes via the edoc_doclet_markdown doclet:

edoc:application(example, [{preprocess, true}, {doclet, edoc_doclet_markdown}, {layout, edoc_layout_chunks}]).

The documentation for @param is gone. This could be surprising for some users and could lead to unexpected information loss. A possibility could be to convert the lines tagged with @param using a dotted list or equivalent.

For example, we could go from:

% @param ParamaterA This is the first parameter
% @param ParamaterB This is the second parameter

To:

* `ParameterA` This is the first parameter
* `ParameterB` This is the second parameter

[garazdawi]

I think the code that needs to be updated is https://github.com/erlang/otp/blob/master/lib/edoc/src/edoc_layout_chunks.erl. This is not something that we will look at anytime soon, so a PR would help speed things along.

[robertoaloi]

@garazdawi I actually suspect the issue is not limited to the @param tag, but to all tags, which seem to be excluded from the migrated docs.

[garazdawi]

I know some are included, @since for instance. Maybe @erszcz can shed som light as it is he that wrote the code.