ddox empty public methods/interfaces etc

Andrey andrey at kabylin.ru
Thu Nov 9 03:45:45 UTC 2017


On Tuesday, 7 November 2017 at 14:02:28 UTC, Steven Schveighoffer 
wrote:
> On 11/6/17 11:01 PM, Andrey wrote:
>> Hello is there way to automatically generate documentation for 
>> public methods, interfaces, fields etc.? e.g. now I should 
>> write somethink like this to generate documentation for enum 
>> Bacgkround:
>>> ///
>>> enum Background {
>>>     transparent,  ///
>>>     light,  ///
>>>     dark,  ///
>>>     action,  /// Background for action panel, e.g. with 
>>> buttons OK, Cancel etc.
>>> }
>> 
>> I would like to write insted this:
>>> enum Background {
>>>     transparent,
>>>     light,
>>>     dark,
>>>     action,  /// Background for action panel, e.g. with 
>>> buttons OK, Cancel etc.
>>> }
>> 
>> and avoid all redundant comments.
>
> Sorry, this isn't possible. Ddoc requires opt-in for public 
> documentation. The alternative would be opt-out, which would 
> look even worse I think.
>
> -Steve

I just added to dub.json this:

> "-ddoxFilterArgs": [
>     "--min-protection=Public"
> ]

i.e. without --only-documented option, in this way ddox will 
generate documentation for all public methods, even if there is 
no docstring.


More information about the Digitalmars-d-learn mailing list