Generating DDOX documentation
lobo
swamp.lobo at gmail.com
Sun Oct 22 22:48:14 UTC 2017
On Friday, 20 October 2017 at 10:47:57 UTC, Andrew Edwards wrote:
> Given a documented source file (eg. process.d), I can generate
> the DDOC version of the documentation with the -D switch of DMD
> as such:
>
> $ dmd -Dfprocess.html process.d
>
> What do I modify on that line to get the DDOX version of the
> same file?
>
> Thanks,
> Andrew
I would recommend adrdox because it is so quick and simple to use
and produces well indexed HTML. But you do have to build it once
before you can use it:
---
$ git clone https://github.com/adamdruppe/adrdox
$ cd adrdox
$ dub build
---
Produces a binary called "doc2" that you can put somewhere on
your path, or just run from the repo directory itself when
needed. For any project generating HTML documentation is trivial;
$ doc2 <path to sources> -o <output path>
bye,
lobo
More information about the Digitalmars-d-learn
mailing list