search

dlang-community / harbored-mod

A documentation generator for D with support for both DDoc and Markdown.
Boost Software License 1.0
18 stars 14 forks source link

Enabling/disabling documentation based on protection attributes #18

Open kiith-sa opened 9 years ago

kiith-sa commented 9 years ago

Currently we generate docs for everything with a doc comment regardless of protection attribute.

Allow teh user to disable private/package/protected.

By default, only public and protected members of non-final classes should be documented.

See DocVisitor.attributes, DocVisitor.writeAttributes(), search for protect in visitor.d for reference.

kiith-sa commented 9 years ago

A better way to do this may be to document everything by default (even undocumented symbols), but if JS is enabled, hide the private/package/undocumented symbols by default, with a button to expand them.

We still should have settings for whether private/package/undocumented should have documentation generated at all.