isledecomp/isle-portable
1
0
Fork 0
mirror of https://github.com/isledecomp/isle-portable.git synced 2024-11-22 23:48:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md [skip ci]

Browse source
This commit is contained in:
Christian Semmler 2024-01-19 23:24:03 +01:00 committed by GitHub
parent 837fc4b7cc
commit a2aa99485f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
tools/README.md
View file

@ -71,6 +71,21 @@ Synthetic functions should be annotated with `SYNTHETIC`. A synthetic function i
// MxList<MxRegionLeftRight *>::`scalar deleting destructor' // MxList<MxRegionLeftRight *>::`scalar deleting destructor'
``` ```
### `LIBRARY`
Functions located in 3rd party libraries should be annotated with `LIBRARY`. 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 every statically linked library, including the MSVC standard libraries.
```
// LIBRARY: ISLE 0x4061b0
// _MemPoolInit@4
// LIBRARY: ISLE 0x406520
// _MemPoolSetPageSize@8
// LIBRARY: ISLE 0x406630
// _MemPoolSetBlockSizeFS@8
```
## Virtual tables ## Virtual tables
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. 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.