Contents

HiddenFriendsClass Class

A test class demonstrating hidden friend functions. More...

Header: #include <HiddenFriendsClass>

Public Functions

HiddenFriendsClass()
void publicMethod()
void swap(HiddenFriendsClass &a, HiddenFriendsClass &b)
bool operator==(const HiddenFriendsClass &lhs, const HiddenFriendsClass &rhs)

Detailed Description

This class contains hidden friend functions declared in the private section. These should appear in documentation regardless of includeprivate setting because they have public visibility through ADL.

Member Function Documentation

HiddenFriendsClass::HiddenFriendsClass()

Public constructor.

Creates a HiddenFriendsClass instance.

void HiddenFriendsClass::publicMethod()

Public member function.

This should always appear in documentation.

Related Non-Members

void swap(HiddenFriendsClass &a, HiddenFriendsClass &b)

Hidden friend swap function.

This hidden friend should also appear in documentation. Uses the standard swap idiom.

a First object to swap. b Second object to swap.

bool operator==(const HiddenFriendsClass &lhs, const HiddenFriendsClass &rhs)

Hidden friend equality operator.

This hidden friend should appear in documentation despite being declared in the private section, because it has public visibility through argument-dependent lookup (ADL).

lhs Left-hand side operand. rhs Right-hand side operand.

Returns true if objects are equal.