mirror of
https://github.com/open-goal/jak-project.git
synced 2024-10-20 11:26:18 -04:00
abf61a94fb
Adding support for better child-type method docstrings. This is a
problem unique to methods.
Usually, a child-type will have the same signature and a common name
will apply, but the implementation is different. This means, you
probably want a different docstring to describe what is happening.
Currently this is possible to do via `:replace`. The problem with
replace is two fold:
- a replaced method ends up in the generated `deftype`...because you
usually change the signature!
- we don't put docstrings in the `deftype` in normal GOAL, this is just
something we do for the `all-types` file (they go in the `defmethod`
instead)
- more importantly, this means anytime you now want to change the
parent's name/args/return type -- you have to apply that change
everywhere.
So this is a better design you can now just declare the method like so:
```clj
(:override-doc "my new docstring" <method_id>)
```
And internally a pseudo-replaced method will be added, but it will
inherit everything from the parent (except the docstring of course)
Unrelated - I also made all the keyword args for declaring methods not
depend on ordering
This also adds support for documenting virtual and non-virtual state
handlers. For example:
```clj
(:states
(part-tester-idle (:event "test") symbol))
```
or
```clj
(idle () _type_ :state (:event "test") 20)
```
I will probably add the ability to give some sort of over-view docstring
at a later date.
Co-authored-by: water <awaterford111445@gmail.com>
251 lines
7.6 KiB
JSON
251 lines
7.6 KiB
JSON
{
|
|
"version": "0.2.1",
|
|
"defaults": {},
|
|
"configurations": [
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - Unit-Tests - Summary",
|
|
"args": ["--gtest_brief=1"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - Unit-Tests - Verbose",
|
|
"args": ["--gtest_brief=0"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - Draft Tests - Verbose",
|
|
"args": ["--gtest_brief=0", "--gtest_filter=\"*Draft*\""]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - TypeConsistency - Verbose",
|
|
"args": ["--gtest_brief=0", "--gtest_filter=\"*TypeConsistency*\""]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - TypeConsistency - Jak 2 - Verbose",
|
|
"args": ["--gtest_brief=0", "--gtest_filter=\"*Jak2TypeConsistency*\""]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc-test.exe (bin\\goalc-test.exe)",
|
|
"name": "Tests - WithGameTests - Verbose",
|
|
"args": ["--gtest_brief=0", "--gtest_filter=\"*WithGameTests*\""]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "offline-test.exe (bin\\offline-test.exe)",
|
|
"name": "Tests - Offline Tests - Jak 1",
|
|
"args": [
|
|
"--iso_data_path",
|
|
"${workspaceRoot}/iso_data/jak1",
|
|
"--game",
|
|
"jak1"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "offline-test.exe (bin\\offline-test.exe)",
|
|
"name": "Tests - Offline Tests - Jak 2",
|
|
"args": [
|
|
"--iso_data_path",
|
|
"${workspaceRoot}/iso_data/jak2",
|
|
"--game",
|
|
"jak2"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "offline-test.exe (bin\\offline-test.exe)",
|
|
"name": "Tests - Offline Tests - Jak 1 - Specific File",
|
|
"args": [
|
|
"--iso_data_path",
|
|
"${workspaceRoot}/iso_data/jak1",
|
|
"--game",
|
|
"jak1",
|
|
"--file",
|
|
"wall-plat"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "offline-test.exe (bin\\offline-test.exe)",
|
|
"name": "Tests - Offline Tests - Jak 2 - Specific File",
|
|
"args": [
|
|
"--iso_data_path",
|
|
"${workspaceRoot}/iso_data/jak2",
|
|
"--game",
|
|
"jak2",
|
|
"--file",
|
|
<<<<<<< HEAD
|
|
"path-h"
|
|
=======
|
|
"nav-enemy"
|
|
>>>>>>> e5d6ac1c4122115c179fe620c8c8d6c04ed217fe
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Runtime (no kernel)",
|
|
"args": ["-fakeiso", "-debug", "-nokernel", "-v", "-nodisplay"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Runtime (with kernel)",
|
|
"args": ["-fakeiso", "-debug", "-v"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Runtime (boot)",
|
|
"args": ["-boot", "-fakeiso", "-debug", "-v"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Runtime (boot no debug)",
|
|
"args": ["-boot", "-fakeiso", "-v"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Jak 2 - Runtime (boot)",
|
|
"args": ["-boot", "-fakeiso", "-debug", "-v", "-jak2"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "gk.exe (bin\\gk.exe)",
|
|
"name": "Game - Jak 2 - Runtime (no boot)",
|
|
"args": ["-fakeiso", "-debug", "-v", "-jak2"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc.exe (bin\\goalc.exe)",
|
|
"name": "REPL",
|
|
"args": ["--user-auto"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "goalc.exe (bin\\goalc.exe)",
|
|
"name": "REPL - Jak 2",
|
|
"args": ["--user-auto", "--game", "jak2"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "decompiler.exe (bin\\decompiler.exe)",
|
|
"name": "Decompiler - Jak 1",
|
|
"args": [
|
|
"${workspaceRoot}/decompiler/config/jak1_ntsc_black_label.jsonc",
|
|
"${workspaceRoot}/iso_data",
|
|
"${workspaceRoot}/decompiler_out"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "decompiler.exe (bin\\decompiler.exe)",
|
|
"name": "Decompiler - Jak 1 PAL",
|
|
"args": [
|
|
"${workspaceRoot}/decompiler/config/jak1_pal.jsonc",
|
|
"${workspaceRoot}/iso_data",
|
|
"${workspaceRoot}/decompiler_out"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "decompiler.exe (bin\\decompiler.exe)",
|
|
"name": "Decompiler - Jak 2",
|
|
"args": [
|
|
"${workspaceRoot}/decompiler/config/jak2_ntsc_v1.jsonc",
|
|
"${workspaceRoot}/iso_data",
|
|
"${workspaceRoot}/decompiler_out"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "decompiler.exe (bin\\decompiler.exe)",
|
|
"name": "Decompiler - Jak 2 - Extract",
|
|
"args": [
|
|
"${workspaceRoot}/decompiler/config/jak2_ntsc_v1.jsonc",
|
|
"${workspaceRoot}/iso_data",
|
|
"${workspaceRoot}/decompiler_out",
|
|
"--config-override \"{\\\"decompile_code\\\": false}\""
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "memory_dump_tool.exe (bin\\memory_dump_tool.exe)",
|
|
"name": "Tools - EE Memory Analyze - Jak 1",
|
|
"args": ["\"${workspaceRoot}/eeMemory.bin\"", "--output-path", "\"${workspaceRoot}\"", "--game", "jak1"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "memory_dump_tool.exe (bin\\memory_dump_tool.exe)",
|
|
"name": "Tools - EE Memory Analyze - Jak 2",
|
|
"args": ["\"${workspaceRoot}/eeMemory.bin\"", "--output-path", "\"${workspaceRoot}\"", "--game", "jak2"]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "dgo_unpacker.exe (bin\\dgo_unpacker.exe)",
|
|
"name": "Tools - DGO Unpacker (test)",
|
|
"args": [
|
|
"C:\\GameData\\Jak1\\Backup\\DGO-PAL\\GAME",
|
|
"C:\\GameData\\Jak1\\Backup\\DISC-PAL\\CGO\\GAME.CGO"
|
|
]
|
|
},
|
|
{
|
|
"type": "default",
|
|
"project": "CMakeLists.txt",
|
|
"projectTarget": "extractor.exe (bin\\extractor.exe)",
|
|
"name": "Tools - Extractor - Full",
|
|
"args": ["\"E:\\ISOs\\Jak\\Jak 1.iso\""]
|
|
},
|
|
{
|
|
"type" : "default",
|
|
"project" : "CMakeLists.txt",
|
|
"projectTarget" : "lsp.exe (bin\\lsp.exe)",
|
|
"name" : "Tools - LSP",
|
|
"args" : []
|
|
},
|
|
{
|
|
"type" : "default",
|
|
"project" : "CMakeLists.txt",
|
|
"projectTarget" : "type_searcher.exe (bin\\type_searcher.exe)",
|
|
"name" : "Tools - Type Searcher",
|
|
"args" : ["--game", "jak2", "--output-path", "./search-results.json", "--size", 255, "--fields", "[{\\\"type\\\":\\\"quaternion\\\",\\\"offset\\\":48}]"]
|
|
}
|
|
]
|
|
}
|