cppdocgen e2e test

This directory contains headers that are run through the document generator, and golden versions of the generated documentation.

How this file affects the output

The contents of this README file will comprise the top of the generated index.md.

Header files

• e2e_test/basics.h
• e2e_test/classes.h
• e2e_test/functions.h
• e2e_test/grouping.h
• e2e_test/namespace.h
• e2e_test/templates.h

Classes and structures

• BaseClass1 class
• BaseClass2 class
• BaseTemplate class
• BaseTemplate class
• BaseTemplate class
• myns::ClassInsideNamespace class
• DerivedClass class
• DerivesFromTemplate class
• MyClass class
• NoDeclarationClass class
• SimpleTestClass class
• SimpleTestStructure struct
• StandaloneUnion union
• myns::StructInsideNamespace struct
• UnnamedStructTypedef struct
• tagged_struct struct
• tagged_struct_separate struct

Functions

• CustomTitleFunction(…)
• GetStringFromVectors(…)
• GroupedExplicitlyOne(…)
• GroupedExplicitlyTwo(…)
• GroupedImplicitly(…)
• myns::FunctionInsideNamespace()
• TemplateFunction(…)
• ThisShouldHaveNoDeclaration()
• UndocumentedFunction()
• UngroupedOne()
• UngroupedTwo()

Enums

• MyFancyEnum
• myns::EnumInsideNamespace
• MySimpleEnum
• NoDeclEnum

Typedefs and aliases

• myns::StructInsideNamespaceTypedef
• myns::StructInsideNamespaceUsing
• SimpleTestStructureTypedef
• SimpleTestStructureUsing
• tagged_struct_separate_t
• tagged_struct_t

Macros

• API_FLAG_1
• API_FLAG_2
• DOCUMENTED_BUT_NO_DECL
• GROUPED_ONE
• GROUPED_TWO
• UNGROUPED_ONE
• UNGROUPED_TWO