[Issue 13676] [ddoc] DDoc should wrap each part of function declaration in dedicated macro to allow more readable formatting

via Digitalmars-d-bugs digitalmars-d-bugs at puremagic.com
Sat Dec 27 03:56:34 PST 2014


https://issues.dlang.org/show_bug.cgi?id=13676

bearophile_hugs at eml.cc changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |bearophile_hugs at eml.cc

--- Comment #1 from bearophile_hugs at eml.cc ---
In Scala they have added the @usecase annotation to face this problem:
https://wiki.scala-lang.org/display/SW/Tags+and+Annotations

>From that page:

@usecase <simple definition> In case the method definition is too complex, you
can add simple aliasing definition as a usecase. It will create another entry
in the scaladoc page as if the <simple definition> actually existed. The
description for the newly created entry is the same as the one for the current
symbol, just that it's preceded by [use case] to signal it's not a real entry.
An example can be seen in the ++ method of scala.collections.immutable.Set.


Elsewhere there is written:

the usecases inherit the comments from their parents, such as the explanation
and the annotations: @param, @tparam, @return, etc.

--


More information about the Digitalmars-d-bugs mailing list