Skip to content

Commit c0f4e67

Browse files
author
Raven G. Duran
committed
Started updating the documentation
1 parent 2821d25 commit c0f4e67

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

documentation.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
Documentation
22
========
33

4-
This is the initial documentation. I'll update it from time to time if I found bugs or things that
5-
needs to be discussed.
4+
This is the documentation for the source code. I'll update it from time to time if I found bugs or things that
5+
needs to be discussed.
6+
7+
#### Node Structure
8+
```C
9+
struct node {
10+
int value;
11+
struct node *parent;
12+
struct node *left;
13+
struct node *right;
14+
} *tRoot = NULL, *tLeaf = NULL;
15+
```
16+
17+
The node is composed of 1 value and 3 pointers: (This is a bit self-explanatory, but for the sake of formality let's just define it)
18+
* value : The variable to hold the value for the node
19+
* parent : Points to the parent of the node
20+
* left : Points to the smaller sub-tree node
21+
* right : Points to the bigger sub-tree node
22+
23+
There are also 2 global pointer variables used in the whole program:
24+
* tRoot : Points to the root of the whole tree
25+
* tLeaf : Points to the last inserted leaf in the tree

0 commit comments

Comments
 (0)