diff options
Diffstat (limited to 'Source/cmDocumentationEntry.h')
-rw-r--r-- | Source/cmDocumentationEntry.h | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Source/cmDocumentationEntry.h b/Source/cmDocumentationEntry.h new file mode 100644 index 0000000..afbca5e --- /dev/null +++ b/Source/cmDocumentationEntry.h @@ -0,0 +1,37 @@ +/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying + file Copyright.txt or https://cmake.org/licensing for details. */ +#ifndef cmDocumentationEntry_h +#define cmDocumentationEntry_h + +#include "cmConfigure.h" // IWYU pragma: keep + +#include <string> + +/** Standard documentation entry for cmDocumentation's formatting. */ +struct cmDocumentationEntry +{ + std::string Name; + std::string Brief; + char CustomNamePrefix = ' '; + cmDocumentationEntry() = default; + cmDocumentationEntry(const char* doc[2]) + { + if (doc[0]) { + this->Name = doc[0]; + } + if (doc[1]) { + this->Brief = doc[1]; + } + } + cmDocumentationEntry(const char* n, const char* b) + { + if (n) { + this->Name = n; + } + if (b) { + this->Brief = b; + } + } +}; + +#endif |