ddox and exempting dependencies

Anonymouse asdf at asdf.net
Wed Dec 5 15:55:45 UTC 2018


As far as I understand you use dub.json "-ddoxFilterArgs": [ 
"--ex", "pattern" ] to make ddox exclude files from the 
documentation it generates. However, it still parses, warns and 
errors out on dependencies, even if they're set up to be exempted.

1. $ dub init
> [...]
> Add dependency (leave empty to skip) []: requests
> Added dependency requests ~>1.0.3

2. edit dub.json to include:
> "-ddoxFilterArgs":    [
>     "--ex", "cachetools."
> ]

3. $ dub build -b ddox
> Performing "ddox" build using /usr/bin/dmd for x86_64.
> cachetools 0.0.6: building configuration "library"...
> ../../../.dub/packages/cachetools-0.0.6/cachetools/source/cachetools/hash.d(14,6): Error: unmatched --- in DDoc comment
> /usr/bin/dmd failed with exit code 1.

The offending lines look like this:
> /// For classes (and structs with toHash method) we use 
> v.toHash() to compute hash.
> /// 
> -------------------------------------------------------------------------------

Am I doing it right?


More information about the Digitalmars-d-learn mailing list