www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.learn - DDox and filters.

reply Danni Coy via Digitalmars-d-learn <digitalmars-d-learn puremagic.com> writes:
I am trying to build my projects documentation via the ddox system via dub.
It seems that my modules are being documented and then filtered out.

Ironically for a documentation system there isn't a lot of documentation.
What is the minimum I need in order for documentation to show up?
how do I control the filter options.
Jul 26
parent reply Soulsbane <paul acheronsoft.com> writes:
On Thursday, 27 July 2017 at 03:01:50 UTC, Danni Coy wrote:
 I am trying to build my projects documentation via the ddox 
 system via dub. It seems that my modules are being documented 
 and then filtered out.

 Ironically for a documentation system there isn't a lot of 
 documentation.
 What is the minimum I need in order for documentation to show 
 up?
 how do I control the filter options.
I think I had this problem and solved it by adding a comment block at the top describing the module.
Jul 27
parent Danni Coy via Digitalmars-d-learn <digitalmars-d-learn puremagic.com> writes:
yup figured it out -
module documentation needs to go *above*
the module declaration or you get nothing.

On Fri, Jul 28, 2017 at 11:53 AM, Soulsbane via Digitalmars-d-learn <
digitalmars-d-learn puremagic.com> wrote:

 On Thursday, 27 July 2017 at 03:01:50 UTC, Danni Coy wrote:

 I am trying to build my projects documentation via the ddox system via
 dub. It seems that my modules are being documented and then filtered out.

 Ironically for a documentation system there isn't a lot of documentation.
 What is the minimum I need in order for documentation to show up?
 how do I control the filter options.
I think I had this problem and solved it by adding a comment block at the top describing the module.
Jul 27