On 10/13/17 4:29 PM, Sönke Ludwig wrote:
On Thu, 12 Oct 2017 14:41:51 -0400, Steven Schveighoffer wrote:
I can't for the life of me figure out how to get dub to call ddox with a
different --file-name-style option. How does it work?I'd imagine for those building ddox on Windows or Mac, this would be a
common question...-Steve
Hm, this is actually something that is not supported by the current built-in functionality "-b ddox". The only possibility to customize it is to either use a different doc tool, or using the ddoxFilterArgs experimental option, but that doesn't work for output options.
On my mac, the filenames are case insensitive, so I get a bad build of
ddox (I have a factory function called nullDev that builds a type called
NullDev, which result in the same filename). This kind of makes the
whole feature useless, no?
You can of course just take the generated docs.json file and call
dub ddox -- generate-htmldirectly.
I'm sure there's a typo here, dub ddox is not a command, and ddox I'm
guessing is buried somewhere in dub's infrastructure?
The question is if it makes sense to add another experimental option specific to ddox ("ddoxGenerateArgs"), or to work towards a more general solution for integrating documentation generators.
I would recommend a way to simply pass flags as-is to any build command.
Sort of like dmd -L passes that parameter verbatim to the linker.
In this case, ddox is ddox. There is no worry about cross-platform
incompatibility.
A further alternative, could ddox default to a different file naming
scheme for MacOS and Windows?
-Steve