mrdocs::doc::Parts

Which parts of the documentation to copy.

Synopsis

Declared in <mrdocs/Metadata/DocComment/Inline/Parts.hpp>

enum class Parts : int;

Description

  • all: copy the brief and the description.

  • brief: only copy the brief.

  • description: only copy the description.

Members

Name

Description

all

Copy the brief and the description

brief

Copy the brief

description

Copy the description

Non-Member Functions

Name

Description

toString

Return the name of the Parts as a string.

Created with MrDocs