diff --git a/tools/README.md b/tools/README.md index 181313f0..3fed32a1 100644 --- a/tools/README.md +++ b/tools/README.md @@ -16,7 +16,7 @@ The annotations can be attached to the function implementation, which is the mos ### `FUNCTION` -Any function with a reasonably complete implementation which is not templated or synthetic (see below) should be annotated with `FUNCTION`. +Functions with a reasonably complete implementation which are not templated or synthetic (see below) should be annotated with `FUNCTION`. ``` // FUNCTION: LEGO1 0x100b12c0 @@ -31,7 +31,7 @@ MxCore* MxObjectFactory::Create(const char* p_name) ### `STUB` -Any function with no or a very incomplete implementation should be annotated with `STUB`. These will not be compared to the original assembly. +Functions with no or a very incomplete implementation should be annotated with `STUB`. These will not be compared to the original assembly. ``` // STUB: LEGO1 0x10011d50 @@ -43,7 +43,7 @@ LegoCameraController::LegoCameraController() ### `TEMPLATE` -Any templated function should be annotated with `TEMPLATE`. Since the goal is to eventually have a full accounting of all the functions present in the binaries, please make an effort to find and annotate every function of a templated class. +Templated functiosn should be annotated with `TEMPLATE`. Since the goal is to eventually have a full accounting of all the functions present in the binaries, please make an effort to find and annotate every function of a templated class. ``` // TEMPLATE: LEGO1 0x100c0ee0 @@ -58,7 +58,7 @@ Any templated function should be annotated with `TEMPLATE`. Since the goal is to ### `SYNTHETIC` -Any synthetic function should be annotated with `SYNTHETIC`. A synthetic function is generated by the compiler; for the time being, the only case is the "scalar deleting destructor" found in virtual tables. Note: `SYNTHETIC` takes precedence over `TEMPLATE`. +Synthetic functions should be annotated with `SYNTHETIC`. A synthetic function is generated by the compiler; for the time being, the only case is the "scalar deleting destructor" found in virtual tables. Note: `SYNTHETIC` takes precedence over `TEMPLATE`. ``` // SYNTHETIC: LEGO1 0x10003210 @@ -73,7 +73,7 @@ Any synthetic function should be annotated with `SYNTHETIC`. A synthetic functio ## Virtual tables (**WIP**) -Any class with a virtual table should be annotated using the `VTABLE` marker, which includes the module name and address of the virtual table. Additionally, virtual function declarations should be annotated with a comment indicating their relative offset. Please use the following example as a reference. +Classes with a virtual table should be annotated using the `VTABLE` marker, which includes the module name and address of the virtual table. Additionally, virtual function declarations should be annotated with a comment indicating their relative offset. Please use the following example as a reference. ``` // VTABLE: LEGO1 0x100dc900 @@ -88,7 +88,7 @@ public: ## Class size (**WIP**) -Any classe's size should be annotated using the `SIZE` marker. If you are unsure about the class size in the original binary, please use the currently available information (known member variables) and detail the circumstances in an extra comment if necessary. +Classes should be annotated using the `SIZE` marker to indicate their size. If you are unsure about the class size in the original binary, please use the currently available information (known member variables) and detail the circumstances in an extra comment if necessary. ``` // SIZE 0x1c @@ -101,7 +101,7 @@ public: ## Member variables (**WIP**) -Any member variable should be annotated with its relative offset. +Member variablse should be annotated with their relative offsets. ``` class MxDSObject : public MxCore { @@ -114,7 +114,7 @@ private: ## Global variables (**WIP**) -Any global variable should be annotated using the `GLOBAL` marker, which includes the module name and address of the variable. +Global variables should be annotated using the `GLOBAL` marker, which includes the module name and address of the variable. ``` // GLOBAL: LEGO1 0x100f456c