Kyle's Doxygen Test
This is just a test of Doxygen
Loading...
Searching...
No Matches
Macros | Functions
utility.hpp File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MAGIC_NUMBER   1337
 Magic number for magical computation.
 
Five Gods constants.
#define MEW2KING   1
 Five Gods constants.
 
#define ARMADA   2
 Five Gods constants.
 
#define HUNGRYBOX   3
 Five Gods constants.
 
#define MANGO   4
 Five Gods constants.
 
#define PPMD   5
 Five Gods constants.
 

Functions

int square (int x)
 Squares a number.
 
int multiply (int x, int y)
 Multiplies two numbers.
 
int magic (int x)
 Function for magic math.
 
int battleOfTheFiveGods ()
 Multiplies all the gods together.
 

Macro Definition Documentation

◆ ARMADA

#define ARMADA   2

Five Gods constants.

These five constants represent the five gods.

Definition at line 21 of file utility.hpp.

◆ HUNGRYBOX

#define HUNGRYBOX   3

Five Gods constants.

These five constants represent the five gods.

Definition at line 22 of file utility.hpp.

◆ MAGIC_NUMBER

#define MAGIC_NUMBER   1337

Magic number for magical computation.

This number is selected to be the most elite number there is. No other numbers are more elite than this number.

Definition at line 10 of file utility.hpp.

◆ MANGO

#define MANGO   4

Five Gods constants.

These five constants represent the five gods.

Definition at line 23 of file utility.hpp.

◆ MEW2KING

#define MEW2KING   1

Five Gods constants.

These five constants represent the five gods.

Definition at line 20 of file utility.hpp.

◆ PPMD

#define PPMD   5

Five Gods constants.

These five constants represent the five gods.

Definition at line 24 of file utility.hpp.

Function Documentation

◆ battleOfTheFiveGods()

int battleOfTheFiveGods ( )

Multiplies all the gods together.

This function just multiplies the five god constants together.

Returns
The product of the five numbers.

Definition at line 15 of file utility.cpp.

15 {
16 return MEW2KING * ARMADA * HUNGRYBOX * MANGO * PPMD;
17}
#define PPMD
Five Gods constants.
Definition utility.hpp:24
#define ARMADA
Five Gods constants.
Definition utility.hpp:21
#define MEW2KING
Five Gods constants.
Definition utility.hpp:20
#define MANGO
Five Gods constants.
Definition utility.hpp:23
#define HUNGRYBOX
Five Gods constants.
Definition utility.hpp:22

References ARMADA, HUNGRYBOX, MANGO, MEW2KING, and PPMD.

Referenced by testNumbers().

Here is the caller graph for this function:

◆ magic()

int magic ( int  x)

Function for magic math.

This function multiplies a number by the magic number.

Parameters
xThe number on which to perfom magic.
Returns
The magic product of the number.

Definition at line 11 of file utility.cpp.

11 {
12 return MAGIC_NUMBER * x;
13}
#define MAGIC_NUMBER
Magic number for magical computation.
Definition utility.hpp:10

References MAGIC_NUMBER.

Referenced by testNumbers().

Here is the caller graph for this function:

◆ multiply()

int multiply ( int  x,
int  y 
)

Multiplies two numbers.

This function multiplies a number times another number and returns the result of those two numbers multiplied together. The result is the product of the two numbers, and that is the value that is returned by this function.

Parameters
xThe first operand.
yThe second operand.
Returns
The product of x and y.

Definition at line 7 of file utility.cpp.

7 {
8 return x * y;
9}

Referenced by Dog::run(), Dog::sleep(), and testNumbers().

Here is the caller graph for this function:

◆ square()

int square ( int  x)

Squares a number.

This function multiplies a given number by itself, which results in the square of that number.

Parameters
xThe number to square.
Returns
The square of the number.

Definition at line 3 of file utility.cpp.

3 {
4 return x * x;
5}

Referenced by testNumbers().

Here is the caller graph for this function: