Bug 2609 – No documentation generated for destructor

No documentation is generated for destructors: /// Yah struct S { /// Nah ~this() {} } Yah appears, Nah doesn't.

I also add that documentation is not generated for copy constructors, i.e. this(this).

This is a bit bizarre. In doc.c, around line 450, there's a lot of empty functions: void Dsymbol::emitComment(Scope *sc) { } void InvariantDeclaration::emitComment(Scope *sc) { } #if DMDV2 void PostBlitDeclaration::emitComment(Scope *sc) { } #endif void DtorDeclaration::emitComment(Scope *sc) { } void StaticCtorDeclaration::emitComment(Scope *sc) { } void StaticDtorDeclaration::emitComment(Scope *sc) { } void ClassInfoDeclaration::emitComment(Scope *sc) { } void ModuleInfoDeclaration::emitComment(Scope *sc) { } void TypeInfoDeclaration::emitComment(Scope *sc) { } I believe that all of these should be deleted. Deleting PostBlit and Dtor certainly fixes the bugs in this report. FuncDeclaration::emitComment() seems to handle them just fine.

The documentation for those functions should not be part of their interface presented to the user. That's why doc isn't generated for them. It was a deliberate choice, not a bug. I'll mark it as an enhancement request.

(In reply to comment #3) > The documentation for those functions should not be part of their interface > presented to the user. That's why doc isn't generated for them. > > It was a deliberate choice, not a bug. I'll mark it as an enhancement request. I think that's a reasonable decision, but the spec should state that doc isn't generated for them. Eg, after: If there is no documentation comment for a declaration, that declaration may not appear in the output. To ensure it does appear in the output, put an empty declaration comment for it. + Declarations which are not an explicit part of the interface do not have documentation generated for them. These include: + invariant + postblit + destructor + static constructors and destructors + class info, type info, and module info

Fixed DMD1.058 and DMD2.043.