fixup documentation a tiny bit
This commit is contained in:
parent
6893ef4c4d
commit
9140d36820
|
@ -11,7 +11,7 @@ The binary being used is the US game binary, original filename `SLUS_200.95`, ho
|
|||
## Why not a matching decompilation?
|
||||
|
||||
While this was briefly considered, the time it would take is far greater, let alone the fact that tooling for matching decompilations
|
||||
is nearly nonexistant and would have to be written from scratch specifically for this project.
|
||||
for the PS2 is nearly nonexistant and would have to be written from scratch specifically for this project.
|
||||
|
||||
Later on, it might be worth considering again, however, for now, a functional decompilation will mean faster, more promising results.
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ Most of the documentation here is enforced by [clang-format](https://clang.llvm.
|
|||
|
||||
# Code Style
|
||||
|
||||
## Indentation & Braces
|
||||
## Braces/Indentation
|
||||
|
||||
Any block scopes should have the brace on the next line, like so:
|
||||
|
||||
|
@ -25,7 +25,7 @@ catch(...)
|
|||
|
||||
Tabs are used for indentation throughout the codebase.
|
||||
|
||||
## Naming
|
||||
## Naming Rules
|
||||
|
||||
### Variables
|
||||
|
||||
|
@ -46,6 +46,8 @@ For quick reference:
|
|||
| `fl` | Float |
|
||||
| `d` | Double |
|
||||
|
||||
Enumerations or structures do not need special notations; naming of variables should be enough (pointers should only need `p`).
|
||||
|
||||
Additionally, there are also the following special prefixes:
|
||||
|
||||
| Name | Meaning |
|
||||
|
@ -111,14 +113,14 @@ public:
|
|||
// Morph
|
||||
void Morph();
|
||||
|
||||
void NotImplemented(int &iOutput); // only for reference output
|
||||
void ReferenceExample(int &iOutput); // only for reference output
|
||||
};
|
||||
|
||||
// TODO: probably won't advocate for this unless
|
||||
// I have to since structs are types in C++
|
||||
typedef struct
|
||||
{
|
||||
int iNumber;
|
||||
int iNumber;
|
||||
} tBxStructure;
|
||||
|
||||
// example of a legacy function and type name
|
||||
|
|
Loading…
Reference in New Issue