Library API

Welcome to the developer reference to Exhale Companion. The code being documented here is largely meaningless and was only created to test various corner cases e.g. nested namespaces and the like.

Note

The text you are currently reading was fed to exhale_args using the afterTitleDescription key. Full reStructuredText syntax can be used.

Tip

Sphinx / Exhale support unicode! You’re conf.py already has it’s encoding declared as # -*- coding: utf-8 -*- by default. If you want to pass Unicode strings into Exhale, simply prefix them with a u e.g. u"👽😱💥" (of course you would actually do this because you are writing with åçćëñtß or non-English 寫作 😉).

Class Hierarchy

• Namespace arbitrary

  • Namespace arbitrary::nested

    • Namespace arbitrary::nested::dual_nested

      • Struct int3

    • Struct int2

    • Union NestedNamespacedUnion

  • Namespace arbitrary::second_nested

    • Class NestingFirstLastChild

    • Class NestingLastChild

  • Struct arbitrary_struct

  • Struct zed_struct

  • Class BaseClass

  • Template Class DerivedClass

  • Template Class DerivedClass< arbitrary::arbitrary_struct, N >

  • Template Class DerivedClass< bool, 2 >

  • Enum CAMERA_STATES

  • Union NamespacedUnion

• Namespace first

  • Namespace first::second

    • Namespace first::second::third

      • Namespace first::second::third::fourth

        • Namespace first::second::third::fourth::fifth

          • Struct deeper_namespace_testing

            • Struct deeper_namespace_testing::nested_struct

      • Struct only_namespace_testing

• Struct params

  • Union params::U

• Class SomeOuterClass

• Enum UnscopedEnum

• Union SupremeUnion

File Hierarchy

• Directory arbitrary

  • File BaseClass.h

  • File common.h

  • File DerivedClass.h

• File OuterFile.h

Below the hierarchies comes the full API listing.

1. The text you are currently reading is provided by afterHierarchyDescription.

2. The Title of the next section just below this normally defaults to Full API, but the title was changed by providing an argument to fullApiSubSectionTitle.

3. You can control the number of bullet points for each linked item on the remainder of the page using fullToctreeMaxDepth.

Custom Full API SubSection Title

Namespaces

• Namespace arbitrary
  • Detailed Description
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Unions

• Namespace arbitrary::nested
  • Namespaces
  • Classes
  • Unions

• Namespace arbitrary::nested::dual_nested
  • Classes

• Namespace arbitrary::second_nested
  • Classes
  • Typedefs
  • Variables

• Namespace external
  • Variables

• Namespace first
  • Namespaces

• Namespace first::second
  • Namespaces

• Namespace first::second::third
  • Namespaces
  • Classes

• Namespace first::second::third::fourth
  • Namespaces

• Namespace first::second::third::fourth::fifth
  • Classes

Classes and Structs

• Struct arbitrary_struct
  • Struct Documentation

• Struct int3
  • Struct Documentation

• Struct int2
  • Struct Documentation

• Struct zed_struct
  • Struct Documentation

• Struct deeper_namespace_testing
  • Nested Relationships
    • Nested Types
  • Struct Documentation

• Struct deeper_namespace_testing::nested_struct
  • Nested Relationships
  • Struct Documentation

• Struct only_namespace_testing
  • Struct Documentation

• Struct params
  • Nested Relationships
    • Nested Types
  • Struct Documentation

• Class BaseClass
  • Inheritance Relationships
    • Derived Types
  • Class Documentation

• Template Class DerivedClass
  • Inheritance Relationships
    • Base Type
  • Template Parameter Order
  • Class Documentation

• Template Class DerivedClass< arbitrary::arbitrary_struct, N >
  • Inheritance Relationships
    • Base Type
  • Template Parameter Order
  • Class Documentation

• Template Class DerivedClass< bool, 2 >
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class NestingFirstLastChild
  • Class Documentation

• Class NestingLastChild
  • Class Documentation

• Class SomeOuterClass
  • Inheritance Relationships
    • Base Type
  • Class Documentation

Enums

• Enum CAMERA_STATES
  • Enum Documentation

• Enum UnscopedEnum
  • Enum Documentation

Unions

• Union NamespacedUnion
  • Union Documentation

• Union NestedNamespacedUnion
  • Union Documentation

• Union params::U
  • Nested Relationships
  • Union Documentation

• Union SupremeUnion
  • Union Documentation

Functions

• Function arbitrary::arbitraryFunction
  • Function Documentation

• Function someCommonFunction
  • Function Documentation

Variables

• Variable arbitrary::second_nested::SN
  • Variable Documentation

• Variable common_float_variable
  • Variable Documentation

• Variable external::MAX_DEPTH
  • Variable Documentation

Defines

• Define AN_ARBITRARY_DEFINE
  • Define Documentation

• Define NAMESPACE_BEGIN
  • Define Documentation

• Define NAMESPACE_END
  • Define Documentation

Typedefs

• Typedef arbitrary::second_nested::death_star
  • Typedef Documentation

• Typedef super_bool
  • Typedef Documentation

You read all the way to the bottom?! This text is specified by giving an argument to afterBodySummary. As the docs state, this summary gets put in after a lot of information. It’s available for you to use if you want it, but from a design perspective it’s rather unlikely any of your users will even see this text.