Modules.ddoc

modules.ddoc contains a list of the modules to include in the project documentation. It is a template file; copy it out of the bootDoc repository before editing it.

This file uses candyDoc-style format. Projects which previously used candyDoc can use the same modules.ddoc with bootDoc.

Format

modules.ddoc defines a single macro, MODULES. It is a simple list of expansions of the pre-defined MODULE macro with no separator between expansions. The MODULE macro is passed the fully qualified name of a module; not the name of the file the module resides in.

For example, for a project with the three modules foo.d, bar/foo.d and bar/baz.d, the modules.ddoc file should look like this:

MODULES =
    $(MODULE foo)
    $(MODULE bar.foo)
    $(MODULE bar.baz)

As with all .ddoc files, remember to put a newline at the end of the file.