Documenting contracts in Ddoc

H. S. Teoh hsteoh at quickfur.ath.cx
Wed Jan 1 22:17:55 PST 2014


On Thu, Jan 02, 2014 at 03:42:53AM +0000, bearophile wrote:
> Ross Hays:
> 
> >I am putting this topic in the learn forum because I may be wrong
> >and it may be possible. If, however, it is not possible, that
> >maybe it is worth a official suggestion?
> 
> Currently contracts don't go in DDoc, but they could.
[...]

They *should*. This is one of the glaring weak points of DDoc.

A related issue is the ability to pretty-print signature constraints:
the latest dmd will (finally!) include sig constraints in the generated
docs, but right now it just comes out as a big block of text, which has
poor readability. There really should be a way to pretty-print the sig
constraint so that it's more readable.


T

-- 
Lottery: tax on the stupid. -- Slashdotter


More information about the Digitalmars-d-learn mailing list