Cross-platform documentation

ZombineDev via Digitalmars-d digitalmars-d at puremagic.com
Tue May 31 00:19:21 PDT 2016


On Tuesday, 31 May 2016 at 07:12:06 UTC, Jacob Carlborg wrote:
> Currently the documentation for Phobos and druntime is 
> generated on (I'm guessing) Linux. This can sometimes cause 
> problems when platform specific declarations are removed due to 
> them not being available on Linux. Sometimes it looks even 
> worse when none of the declarations are available on Linux [1].
>
> How feasible would it be to generate cross-platform 
> documentation by generating the docs on all platforms. For a 
> given module, diff the all versions generated by the different 
> platforms. If there's a difference, generate a button for each 
> version. The button will show the documentation for that 
> particular platform.
>
> [1] http://dlang.org/phobos/core_attribute.html

The idiom is to use version (CoreDdoc) for druntime or version 
(StdDdoc) for Phobos and to put inside declarations that you want 
to be visible in all documentation builds. And then use version 
(SomePlatform) for the actual definitions.


More information about the Digitalmars-d mailing list