diff options
| author | Gavin Howard <gavin@yzena.com> | 2021-07-15 22:23:12 -0600 |
|---|---|---|
| committer | Gavin Howard <gavin@yzena.com> | 2021-07-15 22:23:12 -0600 |
| commit | bac45669bebe0b15cb9a36f42a8f3cc8ad50be70 (patch) | |
| tree | 4417ef97cef75ba4f919324a1e0687a3a334a0e5 /include | |
| parent | 6f86c1064be9511da98f380e7bab3fc2d04bbdfe (diff) | |
| download | platform_external_bc-bac45669bebe0b15cb9a36f42a8f3cc8ad50be70.tar.gz platform_external_bc-bac45669bebe0b15cb9a36f42a8f3cc8ad50be70.tar.bz2 platform_external_bc-bac45669bebe0b15cb9a36f42a8f3cc8ad50be70.zip | |
Do a lot of documentation work and some refactoring
Signed-off-by: Gavin Howard <gavin@yzena.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/program.h | 4 | ||||
| -rw-r--r-- | include/vm.h | 7 |
2 files changed, 7 insertions, 4 deletions
diff --git a/include/program.h b/include/program.h index 57a47060..95ffe6cd 100644 --- a/include/program.h +++ b/include/program.h @@ -194,7 +194,9 @@ typedef struct BcProgram { /** * Retires (completes the execution of) an instruction. Some instructions - * require special retirement, but most can use this. + * require special retirement, but most can use this. This basically pops the + * operands while preserving the result (which we assumed was pushed before the + * actual operation). * @param p The program. * @param nres The number of results returned by the instruction. * @param nops The number of operands used by the instruction. diff --git a/include/vm.h b/include/vm.h index 9198e58b..9eb8813c 100644 --- a/include/vm.h +++ b/include/vm.h @@ -628,7 +628,8 @@ void bc_vm_info(const char* const help); void bc_vm_boot(int argc, char *argv[]); /** - * Initializes some of the BcVm global. + * Initializes some of the BcVm global. This is separate to make things easier + * on the library code. */ void bc_vm_init(void); @@ -796,9 +797,9 @@ void bc_vm_handleError(BcErr e, size_t line, ...); * Handle a fatal error. * @param e The error. */ -#if !BC_ENABLE_LIBRARY && !BC_ENABLE_MEMCHECK +#if !BC_ENABLE_MEMCHECK BC_NORETURN -#endif // !BC_ENABLE_LIBRARY && !BC_ENABLE_MEMCHECK +#endif // !BC_ENABLE_MEMCHECK void bc_vm_fatalError(BcErr e); /** |