summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationEntry.h
blob: 15d70307978f952441e1dfcdcbc5a66a11427af0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#pragma once

#include "cmConfigure.h" // IWYU pragma: keep

#include <string>

/** Standard documentation entry for cmDocumentation's formatting.  */
struct cmDocumentationEntry
{
#if __cplusplus <= 201103L
  cmDocumentationEntry(std::string const& name, std::string const& brief)
    : Name{ name }
    , Brief{ brief }
  {
  }
#endif

  std::string Name;
  std::string Brief;
  char CustomNamePrefix = ' ';
};