Skip to content
This repository was archived by the owner on Jun 12, 2025. It is now read-only.

Commit 1eb26c9

Browse files
author
Patrick Rye
committed
Update Docs to v1.1.0
Finished Naming Notation guide (for now) Updated a few things to reflect this.
1 parent 781f653 commit 1eb26c9

File tree

4 files changed

+24
-13
lines changed

4 files changed

+24
-13
lines changed

Documentation/ChangeLog.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
All notable changes to this project will be documented here.
44
This project adheres to [Semantic Versioning](http://semver.org/)
55

6-
## UNRELEASED [4.0.0] - 2015-08-06 to 2015-08-12
6+
## UNRELEASED [4.0.0] - 2015-08-06 to 2015-08-13
77

88
### Notes
99

@@ -17,7 +17,7 @@ This project adheres to [Semantic Versioning](http://semver.org/)
1717

1818
* Windows.h library requirement
1919

20-
* Removed unneeded libraries (?) I think I got rid of old libraries but I'm not sure Again with the rewrite I'm not sure.
20+
* Removed unneeded libraries (?) I think I got rid of old libraries; again with the rewrite I'm not sure.
2121

2222
* The increase chance of the player with the highest fitness being selected over the other players.
2323

@@ -55,6 +55,8 @@ This project adheres to [Semantic Versioning](http://semver.org/)
5555

5656
* Define of Best Players
5757

58+
* Naming Notation
59+
5860

5961
## Old versions
6062

Documentation/Code Naming Notation.md renamed to Documentation/Naming Notation.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,30 @@ This method is slightly based on the [Hungarian Notation] (https://en.wikipedia.
88

99
## Scope
1010

11-
| Scope | Prefix | Example |
12-
| ------------- |:-------------------------:|--------------------|
13-
| Global | In Global Namespace or g_ | Global::blnLogging |
14-
| Local | None | strMyString |
15-
| zebra stripes | are neat | |
11+
| Scope | Prefix | Example |
12+
| ------------- |:----------------------------:|--------------------|
13+
| Global | In Global Namespace or g_ | Global::blnLogging |
14+
| Local | None | strMyString |
15+
| Constant | k | kblnMyConstant |
16+
| Define | DEFINED_ (everything in caps)| DEFINED_MAP_WIDTH |
1617

1718

1819
## Types
1920

20-
| Type | Prefix | Example |
21+
| Type | Prefix | Example |
2122
| ------------- |:------:|--------------------|
2223
| Boolean | bln | blnLogging |
2324
| Char | chr | chrNull |
2425
| Float | f | fTempFitness |
2526
| Integer | int/ i | iValue |
2627
| Unsigned Int | uint/u | uintSeed |
27-
| Float | f | fTempFitness |
28-
| Float | f | fTempFitness |
29-
| Float | f | fTempFitness |
30-
| Float | f | fTempFitness |
28+
| Unsigned Char | uchr | uchrValue |
29+
| Double | db | dbSomeValue |
30+
| String | str | strMyString |
31+
| Pointer | p | pstrStringPointer |
32+
| Long | lg | lgLong |
33+
| Unsigned Long | ulg | ulgValue |
34+
| Long Long | llg | llgWhyDoWeNeedThis |
3135

3236
## Classes / Structs
3337

@@ -38,3 +42,6 @@ This method is slightly based on the [Hungarian Notation] (https://en.wikipedia.
3842
| Struct | abr of struct name| plyPlayer |
3943

4044
The abr that should be used should be written in a comment.
45+
46+
Also the objects that have been declared in the global namespace do not have to follow this rule.
47+

Documentation/ReadMe.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Such documents include (at the moment) include :
1313
* ToDo
1414

1515
* Manual
16+
17+
* Naming Notation

Documentation/ToDo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Improvements to the code can be made as [Issues] (https://github.com/GamerMan779
1212

1313
* Figure out IOS compling
1414

15-
* Finish Naming Notation
15+
~~* Finish Naming Notation~~ 2015-08-13
1616

1717
~~* Add a brief manual describing what the config file options do, as well as a how to use file.~~ 2015-08-11
1818

0 commit comments

Comments
 (0)