mrdocs::DomCorpus::getDocComment

Return a Dom value representing the DocComment.

Synopsis

Declared in <mrdocs/Metadata/DomCorpus.hpp>

virtual
dom::Value
getDocComment(DocComment const& jd) const;

Description

The default implementation returns null. A Generator should override this member and return a value that has suitable strings in the generator's output format.

Return Value

a Dom value representing the DocComment.

Parameters

Name

Description

jd

A processed documentation comment attached to a declaration.

Created with MrDocs