• Andrew Edwards (8/8) Oct 20 2017 Given a documented source file (eg. process.d), I can generate
• FreeSlave (12/20) Oct 20 2017 dmd has no knowledge of ddox. Ddox is a separate program that
• lobo (15/23) Oct 22 2017 I would recommend adrdox because it is so quick and simple to use

Andrew Edwards <edwards.ac gmail.com> writes:

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

FreeSlave <freeslave93 gmail.com> writes:

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

dmd has no knowledge of ddox. Ddox is a separate program that 
takes a json output of dmd ddoc and generates nicer docs. 
https://github.com/rejectedsoftware/ddox

Example of usage:
dmd -o- -X -Xfdocs.json [list of options that used to build the 
project, including the list of source files...]
/path/to/ddox generate-html --navigation-type=ModuleTree 
docs.json docs/

If you're using dub to build your project, then generating ddox 
documentation as easy as
dub build --build=ddox

lobo <swamp.lobo gmail.com> writes:

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