Showing unittest in documentation (Was Re: std.unittests [updated] for review)

Jens Mueller jens.k.mueller at gmx.de
Mon Jan 24 12:39:43 PST 2011


Andrei Alexandrescu wrote:
> On 1/24/11 1:50 PM, Jens Mueller wrote:
> >Jonathan M Davis wrote:
> >>I think that it's been discussed a time or two, but nothing has been done about
> >>it. It wouldn't be entirely straightforward to do. Essentially, either a
> >>unittest block would have to be generated from the Examples section in the
> >>documentation, or you'd have to have some way to indicate that a particular
> >>unittest block got put into the documentation as an Examples section. It's
> >>certainly true that it would be ideal to have a way to avoid the duplication,
> >>but we don't have one at the moment, and it hasn't yet been a high enough
> >>priority to sort out how to do it and implement it.
> >
> >I see. I understand that it does not have high priority. Just wondered
> >whether ...
> >
> >Jens
> 
> The change is much simpler than what Jonathan suggests. A change can
> be made such that any unittest preceded by a documentation comment
> is automatically considered an example.
> 
> /**
>  Example:
> */
> unittest
> {
>     writeln("This is how it works.");
> }

That does not work for me.
$ dmd -unittest -D -Dftest.html test.d

I get an empty example.
<dl><dt><big>void <u>__unittest2</u>();
</big></dt>
<dd><b>Example:</b><br>
<br><br>

</dd>
</dl>

Jens


More information about the Digitalmars-d mailing list