Docs
  1. 🏠
  2. | Hyde Sample Docs
  3. | classes.cpp
  4. | class_example
🌖

class_example

Defined in <classes.cpp>

an example class that demonstrates what Hyde documents.

class class_example;

Enumerations

color

an example enumeration within the class.

​

Types

Type Definition Notes
typedef_example
std::string

a nested typedef expression.

using_example
std::string

a nested using expression.

Member Fields

Field Type Notes
_deprecated_member int

a deprecated member variable that contains a message. Apparently this works?!

(private, deprecated("example deprecation message"))
_nested class_example::nested_class_example

an instance of the nested class example defined earlier.

(private)
_static_member const int

static member variable.

_x int

some variable that holds an integer.

(private)

Member Functions

(constructor) (2 overloads)
deprecated

deprecated member function.

​
deprecated_with_message

deprecated member function that contains a compile-time deprecation message.

​
member_function

example member function.

​
member_function_trailing_return_type

member function with a trailing return type.

​
overloaded

multiple descriptions

​ (6 overloads)
static_method

static member function.

​
template_member_function

multiple descriptions

​ (2 overloads)

Classes

nested_class_example

a class definition contained within example_class.

​

Hyde Example Docs — Website showing a possible Jekyll-formatted hyde output.

Page owner(s): fosterbrereton Last updated 2024-10-01 15:42:11 +0000