qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-22 20:41:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

[qfcc] Fix some stale documentation comments

Browse source 
It does little good for documentation to refer to fields that don't
exist (because a certain someone forgot to change the docs when changing
the field names, I wonder who :P).
This commit is contained in:
Bill Currie 2022-01-07 15:59:06 +09:00
parent 23613ca985
commit c96cb1f302
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
tools/qfcc/include/obj_file.h
View file

@ -218,23 +218,21 @@ typedef struct qfo_func_s {
referenced relocs referenced relocs
unreferenced relocs unreferenced relocs
For \c ref_op_* relocation types, \c ofs is the code section address of the For \c ref_op_* relocation types, \c offset is the code section address
statement that needs to be adjusted. of the statement that needs to be adjusted.
For \c rel_def_* relocation types, For \c rel_def_* relocation types, \c offset refers to the data section
\c ofs refers to the data section address of the word that needs to be address of the word that needs to be adjusted.
adjusted.
For \c ref_*_def(_ofs) relocation types, \c def is the index of the For \c ref_*_def(_ofs) relocation types, \c target is the index of the
referenced def. referenced def.
For \c ref_*_op relocation types, \c def is the address of For \c ref_*_op relocation types, \c target is the address of the
the referenced statement. referenced statement.
For \c ref_*_string relocation types, \c def is For \c ref_*_string relocation types, \c target is always 0.
always 0.
For \c ref_*_field(_ofs) relocation types, \c def is the index of For \c ref_*_field(_ofs) relocation types, \c target is the index of
the referenced field def. the referenced field def.
*/ */
typedef struct qfo_reloc_s { typedef struct qfo_reloc_s {