ddox filters out my doc

Jean-Louis Leroy via Digitalmars-d-learn digitalmars-d-learn at puremagic.com
Sat Jul 15 01:29:52 PDT 2017


I began to write documentation for my open method library. After 
googling around quite a bit, I came across the incantation:

dub build -b ddox

Problem is, it generates no doc. And I believe that it actually 
says so:

Performing "ddox" build using dmd for x86_64.
methods ~genesis: building configuration "library"...
Performing "debug" build using dmd for x86_64.
[...]
Running ../../../.dub/packages/ddox-0.16.2/ddox/ddox filter 
--min-protection=Protected --only-documented docs.json
Reading doc file...
Parsing JSON...
Filtering modules...
No name for module source/methods.d - ignoring
Writing filtered docs...

My module has a name in dub.sdl. After running ddox I see that an 
empty docs.json has been created in my root dir. Maybe I must put 
things in there? But I haven't found such a file in several dlang 
projects I have sought inspiration from...

Project is here: https://github.com/jll63/meth.d/tree/genesis and 
the exact snapshot I am using is here: 
https://github.com/jll63/meth.d/tree/28b3419a6f5f9936fb95e906fc990e00568a32f8


More information about the Digitalmars-d-learn mailing list