From f4a72303cb15abbebefb907480b46737d6c51d9d Mon Sep 17 00:00:00 2001 From: playerskel <97991990+playerskel@users.noreply.github.com> Date: Mon, 24 Jan 2022 00:09:02 +0100 Subject: [PATCH] Whitespace (#1112) * remove trailing whitespaces * minor docs tweaks * some more trailing whitespaces * few more tweaks --- Doxyfile | 4 +- assets/xml/objects/gameplay_dangeon_keep.xml | 4 +- assets/xml/objects/gameplay_field_keep.xml | 4 +- assets/xml/objects/object_ani.xml | 6 +- assets/xml/objects/object_aob.xml | 2 +- assets/xml/objects/object_bird.xml | 2 +- assets/xml/objects/object_blkobj.xml | 2 +- assets/xml/objects/object_box.xml | 2 +- assets/xml/objects/object_bv.xml | 4 +- assets/xml/objects/object_crow.xml | 2 +- assets/xml/objects/object_ddan_objects.xml | 4 +- assets/xml/objects/object_dekunuts.xml | 2 +- assets/xml/objects/object_dnk.xml | 2 +- assets/xml/objects/object_dns.xml | 2 +- assets/xml/objects/object_ds.xml | 2 +- assets/xml/objects/object_dy_obj.xml | 4 +- assets/xml/objects/object_ec.xml | 2 +- assets/xml/objects/object_ei.xml | 2 +- assets/xml/objects/object_fd.xml | 2 +- assets/xml/objects/object_fd2.xml | 2 +- assets/xml/objects/object_fhg.xml | 4 +- assets/xml/objects/object_fu.xml | 4 +- assets/xml/objects/object_fw.xml | 2 +- assets/xml/objects/object_ge1.xml | 2 +- assets/xml/objects/object_gla.xml | 2 +- assets/xml/objects/object_gnd.xml | 54 +++++++------- assets/xml/objects/object_gt.xml | 8 +-- assets/xml/objects/object_hintnuts.xml | 2 +- assets/xml/objects/object_in.xml | 2 +- assets/xml/objects/object_jj.xml | 6 +- assets/xml/objects/object_km1.xml | 8 +-- assets/xml/objects/object_kw1.xml | 8 +-- assets/xml/objects/object_kz.xml | 2 +- assets/xml/objects/object_link_boy.xml | 38 +++++----- assets/xml/objects/object_link_child.xml | 34 ++++----- assets/xml/objects/object_ma1.xml | 2 +- assets/xml/objects/object_ma2.xml | 2 +- assets/xml/objects/object_mizu_objects.xml | 10 +-- assets/xml/objects/object_mo.xml | 6 +- assets/xml/objects/object_ms.xml | 2 +- assets/xml/objects/object_oF1d_map.xml | 8 +-- assets/xml/objects/object_owl.xml | 8 +-- assets/xml/objects/object_po_sisters.xml | 10 +-- assets/xml/objects/object_ru1.xml | 8 +-- assets/xml/objects/object_ru2.xml | 4 +- assets/xml/objects/object_sa.xml | 4 +- assets/xml/objects/object_sd.xml | 2 +- assets/xml/objects/object_skj.xml | 4 +- assets/xml/objects/object_spot00_break.xml | 2 +- assets/xml/objects/object_spot06_objects.xml | 4 +- assets/xml/objects/object_spot08_obj.xml | 4 +- assets/xml/objects/object_spot16_obj.xml | 2 +- assets/xml/objects/object_sst.xml | 2 +- assets/xml/objects/object_wf.xml | 6 +- assets/xml/objects/object_zl1.xml | 2 +- assets/xml/objects/object_zl4.xml | 2 +- assets/xml/overlays/ovl_Bg_Ganon_Otyuka.xml | 6 +- assets/xml/overlays/ovl_Bg_Jya_Cobra.xml | 2 +- assets/xml/overlays/ovl_Boss_Ganon.xml | 2 +- assets/xml/overlays/ovl_En_Bili.xml | 2 +- assets/xml/overlays/ovl_End_Title.xml | 4 +- assets/xml/scenes/dungeons/ddan.xml | 2 +- assets/xml/scenes/overworld/souko.xml | 4 +- docs/Documenting.md | 6 +- docs/tutorial/beginning_decomp.md | 22 +++--- docs/tutorial/contents.md | 34 ++++----- docs/tutorial/data.md | 8 +-- docs/tutorial/draw_functions.md | 13 ++-- docs/tutorial/helper_scripts.md | 2 +- docs/tutorial/introduction.md | 14 ++-- docs/tutorial/merging.md | 2 +- docs/tutorial/object_decomp.md | 2 +- docs/tutorial/other_functions.md | 72 +++++++++---------- docs/tutorial/pre-decomp.md | 2 +- docs/tutorial/types_structs_padding.md | 6 +- extract_assets.py | 2 +- extract_baserom.py | 2 +- first_diff.py | 4 +- format.sh | 4 +- include/message_data_fmt.h | 4 +- include/message_data_static.h | 2 +- include/ultra64/controller.h | 2 +- include/ultra64/mbi.h | 4 +- include/ultra64/pfs.h | 2 +- include/ultra64/r4300.h | 4 +- include/z64.h | 6 +- include/z64animation.h | 8 +-- include/z64camera.h | 9 ++- include/z64collision_check.h | 10 +-- include/z64cutscene.h | 8 +-- include/z64cutscene_commands.h | 18 ++--- include/z64scene.h | 4 +- progress.py | 2 +- src/code/z_map_data.c | 10 +-- .../ovl_Bg_Gnd_Darkmeiro/z_bg_gnd_darkmeiro.h | 4 +- .../ovl_Bg_Spot15_Rrbox/z_bg_spot15_rrbox.h | 4 +- .../ovl_Bg_Toki_Hikari/z_bg_toki_hikari.h | 2 +- .../actors/ovl_Boss_Dodongo/z_boss_dodongo.h | 2 +- .../actors/ovl_Boss_Ganon/z_boss_ganon.h | 2 +- src/overlays/actors/ovl_Demo_Du/z_demo_du.h | 2 +- src/overlays/actors/ovl_Demo_Gj/z_demo_gj.h | 2 +- .../actors/ovl_Door_Shutter/z_door_shutter.h | 8 +-- src/overlays/actors/ovl_En_Ba/z_en_ba.h | 6 +- src/overlays/actors/ovl_En_Bb/z_en_bb.h | 2 +- src/overlays/actors/ovl_En_Dh/z_en_dh.h | 4 +- .../actors/ovl_En_Dodongo/z_en_dodongo.h | 2 +- src/overlays/actors/ovl_En_Dog/z_en_dog.h | 2 +- .../actors/ovl_En_Ex_Ruppy/z_en_ex_ruppy.h | 2 +- src/overlays/actors/ovl_En_Fr/z_en_fr.h | 14 ++-- src/overlays/actors/ovl_En_Fu/z_en_fu.h | 2 +- src/overlays/actors/ovl_En_Fz/z_en_fz.h | 10 +-- .../actors/ovl_En_G_Switch/z_en_g_switch.h | 2 +- src/overlays/actors/ovl_En_Go/z_en_go.h | 4 +- src/overlays/actors/ovl_En_Go2/z_en_go2.h | 18 ++--- .../actors/ovl_En_Heishi1/z_en_heishi1.h | 2 +- .../actors/ovl_En_Heishi2/z_en_heishi2.h | 2 +- src/overlays/actors/ovl_En_Nwc/z_en_nwc.h | 2 +- src/overlays/actors/ovl_En_Skb/z_en_skb.h | 4 +- src/overlays/actors/ovl_En_Tp/z_en_tp.h | 2 +- .../ovl_En_Wonder_Item/z_en_wonder_item.h | 2 +- .../z_eff_ss_fire_tail.h | 2 +- .../gamestates/ovl_file_choose/file_choose.h | 56 +++++++-------- sym_info.py | 2 +- tools/assist.py | 2 +- tools/bootstrap_actors.py | 10 +-- tools/bootstrap_fx.py | 4 +- tools/convert_chars.py | 8 +-- tools/create_actor_headers.py | 6 +- tools/disasm_elf_msg.py | 2 +- tools/elf2rom.c | 4 +- tools/elf32.c | 16 ++--- tools/find_unused_asm.sh | 26 +++---- tools/fix_data_stuff.py | 4 +- tools/format_s_files.py | 2 +- tools/get_actor_sizes.py | 10 +-- tools/ichaindis.py | 6 +- tools/migrate-rodata.py | 7 +- tools/mkdmadata.c | 2 +- tools/mkldscript.c | 4 +- tools/msgdis.py | 18 ++--- tools/overlayhelpers/filemap.py | 22 +++--- tools/overlayhelpers/lmapmark.py | 2 +- tools/overlayhelpers/mapmark.py | 4 +- tools/regconvert.py | 4 +- tools/spec.c | 2 +- tools/specprocess.py | 2 +- tools/split_out_overlay_funcs.py | 6 +- tools/util.c | 4 +- tools/vt_fmt.py | 4 +- tools/vtxdis.c | 2 +- 150 files changed, 493 insertions(+), 494 deletions(-) diff --git a/Doxyfile b/Doxyfile index 67f2da713b..8d98f6bf9b 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "Ocarina of Time Source" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -291,7 +291,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. -EXTENSION_MAPPING = +EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable diff --git a/assets/xml/objects/gameplay_dangeon_keep.xml b/assets/xml/objects/gameplay_dangeon_keep.xml index b8b31ecb4d..d16eb4c41c 100644 --- a/assets/xml/objects/gameplay_dangeon_keep.xml +++ b/assets/xml/objects/gameplay_dangeon_keep.xml @@ -41,8 +41,8 @@ - - + + diff --git a/assets/xml/objects/gameplay_field_keep.xml b/assets/xml/objects/gameplay_field_keep.xml index b795937073..28fa975d7d 100644 --- a/assets/xml/objects/gameplay_field_keep.xml +++ b/assets/xml/objects/gameplay_field_keep.xml @@ -41,10 +41,10 @@ - + - + diff --git a/assets/xml/objects/object_ani.xml b/assets/xml/objects/object_ani.xml index c69656043f..bb85f51a4a 100644 --- a/assets/xml/objects/object_ani.xml +++ b/assets/xml/objects/object_ani.xml @@ -2,7 +2,7 @@ - + @@ -35,8 +35,8 @@ - - + + diff --git a/assets/xml/objects/object_aob.xml b/assets/xml/objects/object_aob.xml index e6202d0cf9..61b28914bd 100644 --- a/assets/xml/objects/object_aob.xml +++ b/assets/xml/objects/object_aob.xml @@ -20,7 +20,7 @@ - + diff --git a/assets/xml/objects/object_bird.xml b/assets/xml/objects/object_bird.xml index 167a5022dc..c0b5cac3e4 100644 --- a/assets/xml/objects/object_bird.xml +++ b/assets/xml/objects/object_bird.xml @@ -8,7 +8,7 @@ - + diff --git a/assets/xml/objects/object_blkobj.xml b/assets/xml/objects/object_blkobj.xml index a073077b82..9527292838 100644 --- a/assets/xml/objects/object_blkobj.xml +++ b/assets/xml/objects/object_blkobj.xml @@ -6,7 +6,7 @@ - + diff --git a/assets/xml/objects/object_box.xml b/assets/xml/objects/object_box.xml index efcec619b5..34162fc94f 100644 --- a/assets/xml/objects/object_box.xml +++ b/assets/xml/objects/object_box.xml @@ -12,7 +12,7 @@ - + diff --git a/assets/xml/objects/object_bv.xml b/assets/xml/objects/object_bv.xml index 83ff039f53..b6ef9e45f9 100644 --- a/assets/xml/objects/object_bv.xml +++ b/assets/xml/objects/object_bv.xml @@ -9,7 +9,7 @@ - + @@ -48,7 +48,7 @@ - + diff --git a/assets/xml/objects/object_crow.xml b/assets/xml/objects/object_crow.xml index 77337c6445..5304246a00 100644 --- a/assets/xml/objects/object_crow.xml +++ b/assets/xml/objects/object_crow.xml @@ -1,7 +1,7 @@ - + diff --git a/assets/xml/objects/object_ddan_objects.xml b/assets/xml/objects/object_ddan_objects.xml index 3fc563b96f..b7df6ed847 100644 --- a/assets/xml/objects/object_ddan_objects.xml +++ b/assets/xml/objects/object_ddan_objects.xml @@ -11,12 +11,12 @@ - + - + diff --git a/assets/xml/objects/object_dekunuts.xml b/assets/xml/objects/object_dekunuts.xml index 5fceef4165..4a4508ee0b 100644 --- a/assets/xml/objects/object_dekunuts.xml +++ b/assets/xml/objects/object_dekunuts.xml @@ -2,7 +2,7 @@ - + diff --git a/assets/xml/objects/object_dnk.xml b/assets/xml/objects/object_dnk.xml index b1e79464b8..1efec46aad 100644 --- a/assets/xml/objects/object_dnk.xml +++ b/assets/xml/objects/object_dnk.xml @@ -2,7 +2,7 @@ - + diff --git a/assets/xml/objects/object_dns.xml b/assets/xml/objects/object_dns.xml index 086c4bd11c..e66a639874 100644 --- a/assets/xml/objects/object_dns.xml +++ b/assets/xml/objects/object_dns.xml @@ -16,7 +16,7 @@ - + diff --git a/assets/xml/objects/object_ds.xml b/assets/xml/objects/object_ds.xml index 0413a9e2e8..b2fb1a5c26 100644 --- a/assets/xml/objects/object_ds.xml +++ b/assets/xml/objects/object_ds.xml @@ -31,7 +31,7 @@ - + diff --git a/assets/xml/objects/object_dy_obj.xml b/assets/xml/objects/object_dy_obj.xml index 4d141d5464..9d7dae3e0a 100644 --- a/assets/xml/objects/object_dy_obj.xml +++ b/assets/xml/objects/object_dy_obj.xml @@ -98,7 +98,7 @@ - + @@ -116,6 +116,6 @@ - + diff --git a/assets/xml/objects/object_ec.xml b/assets/xml/objects/object_ec.xml index 7ec83e284d..fdeccef4c5 100644 --- a/assets/xml/objects/object_ec.xml +++ b/assets/xml/objects/object_ec.xml @@ -2,7 +2,7 @@ - + diff --git a/assets/xml/objects/object_ei.xml b/assets/xml/objects/object_ei.xml index e4132491f4..cabad17ff8 100644 --- a/assets/xml/objects/object_ei.xml +++ b/assets/xml/objects/object_ei.xml @@ -45,7 +45,7 @@ - + diff --git a/assets/xml/objects/object_fd.xml b/assets/xml/objects/object_fd.xml index 1b96e9f22e..d915b38c2f 100644 --- a/assets/xml/objects/object_fd.xml +++ b/assets/xml/objects/object_fd.xml @@ -47,7 +47,7 @@ - + diff --git a/assets/xml/objects/object_fd2.xml b/assets/xml/objects/object_fd2.xml index 8689098b9b..b3fbdcb216 100644 --- a/assets/xml/objects/object_fd2.xml +++ b/assets/xml/objects/object_fd2.xml @@ -24,7 +24,7 @@ - + diff --git a/assets/xml/objects/object_fhg.xml b/assets/xml/objects/object_fhg.xml index f3a4a55cae..eb07d8eb34 100644 --- a/assets/xml/objects/object_fhg.xml +++ b/assets/xml/objects/object_fhg.xml @@ -16,10 +16,10 @@ - + - + diff --git a/assets/xml/objects/object_fu.xml b/assets/xml/objects/object_fu.xml index 82c449e3de..3947e438c0 100644 --- a/assets/xml/objects/object_fu.xml +++ b/assets/xml/objects/object_fu.xml @@ -27,13 +27,13 @@ - + - + diff --git a/assets/xml/objects/object_fw.xml b/assets/xml/objects/object_fw.xml index e71f83092f..51462a3166 100644 --- a/assets/xml/objects/object_fw.xml +++ b/assets/xml/objects/object_fw.xml @@ -91,7 +91,7 @@ - + diff --git a/assets/xml/objects/object_ge1.xml b/assets/xml/objects/object_ge1.xml index 79e0768b81..c3c3e0db39 100644 --- a/assets/xml/objects/object_ge1.xml +++ b/assets/xml/objects/object_ge1.xml @@ -63,7 +63,7 @@ - + diff --git a/assets/xml/objects/object_gla.xml b/assets/xml/objects/object_gla.xml index 499a3720d1..ca4d9225da 100644 --- a/assets/xml/objects/object_gla.xml +++ b/assets/xml/objects/object_gla.xml @@ -70,7 +70,7 @@ - + diff --git a/assets/xml/objects/object_gnd.xml b/assets/xml/objects/object_gnd.xml index dfbe023154..53d2bbde4c 100644 --- a/assets/xml/objects/object_gnd.xml +++ b/assets/xml/objects/object_gnd.xml @@ -1,9 +1,9 @@ - + - + @@ -18,16 +18,16 @@ - + - + - + @@ -40,27 +40,27 @@ - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + @@ -69,7 +69,7 @@ - + diff --git a/assets/xml/objects/object_gt.xml b/assets/xml/objects/object_gt.xml index 1d79d4e39e..dd48318d1d 100644 --- a/assets/xml/objects/object_gt.xml +++ b/assets/xml/objects/object_gt.xml @@ -12,15 +12,15 @@ - + - + - + @@ -33,6 +33,6 @@ - + diff --git a/assets/xml/objects/object_hintnuts.xml b/assets/xml/objects/object_hintnuts.xml index f419f7546a..f7da2e8f5c 100644 --- a/assets/xml/objects/object_hintnuts.xml +++ b/assets/xml/objects/object_hintnuts.xml @@ -2,7 +2,7 @@ - + diff --git a/assets/xml/objects/object_in.xml b/assets/xml/objects/object_in.xml index 84c1140475..155b9c9ad1 100644 --- a/assets/xml/objects/object_in.xml +++ b/assets/xml/objects/object_in.xml @@ -119,7 +119,7 @@ - + diff --git a/assets/xml/objects/object_jj.xml b/assets/xml/objects/object_jj.xml index 62bae8cb91..96ff7dc02a 100644 --- a/assets/xml/objects/object_jj.xml +++ b/assets/xml/objects/object_jj.xml @@ -3,7 +3,7 @@ - + @@ -24,7 +24,7 @@ - + @@ -72,6 +72,6 @@ - + diff --git a/assets/xml/objects/object_km1.xml b/assets/xml/objects/object_km1.xml index 0a918a798e..4d17119251 100644 --- a/assets/xml/objects/object_km1.xml +++ b/assets/xml/objects/object_km1.xml @@ -1,7 +1,7 @@ - + @@ -17,9 +17,9 @@ - + - + @@ -29,7 +29,7 @@ - + diff --git a/assets/xml/objects/object_kw1.xml b/assets/xml/objects/object_kw1.xml index eab561b1fb..534c223b29 100644 --- a/assets/xml/objects/object_kw1.xml +++ b/assets/xml/objects/object_kw1.xml @@ -1,7 +1,7 @@ - + @@ -26,14 +26,14 @@ - + - + - + diff --git a/assets/xml/objects/object_kz.xml b/assets/xml/objects/object_kz.xml index 20aeec4d92..303988c60d 100644 --- a/assets/xml/objects/object_kz.xml +++ b/assets/xml/objects/object_kz.xml @@ -14,7 +14,7 @@ - + diff --git a/assets/xml/objects/object_link_boy.xml b/assets/xml/objects/object_link_boy.xml index 2f3cd943ca..cd5ac2900e 100644 --- a/assets/xml/objects/object_link_boy.xml +++ b/assets/xml/objects/object_link_boy.xml @@ -4,11 +4,11 @@ - + - + @@ -17,11 +17,11 @@ - + - + @@ -41,7 +41,7 @@ - + @@ -54,13 +54,13 @@ - + - + @@ -70,7 +70,7 @@ - + @@ -128,7 +128,7 @@ - + @@ -141,7 +141,7 @@ - + @@ -150,14 +150,14 @@ - + - + @@ -185,7 +185,7 @@ - + @@ -198,7 +198,7 @@ - + @@ -214,12 +214,12 @@ - + - + @@ -229,16 +229,16 @@ - + - + - + diff --git a/assets/xml/objects/object_link_child.xml b/assets/xml/objects/object_link_child.xml index 1fd6f846bc..3d4c48fdc0 100644 --- a/assets/xml/objects/object_link_child.xml +++ b/assets/xml/objects/object_link_child.xml @@ -2,10 +2,10 @@ - - - - + + + + @@ -22,7 +22,7 @@ - + @@ -42,7 +42,7 @@ - + @@ -65,12 +65,12 @@ - + - + @@ -109,7 +109,7 @@ - + @@ -119,7 +119,7 @@ - + @@ -148,13 +148,13 @@ - + - + @@ -174,14 +174,14 @@ - + - + @@ -191,7 +191,7 @@ - + @@ -202,7 +202,7 @@ - + @@ -222,5 +222,5 @@ - + diff --git a/assets/xml/objects/object_ma1.xml b/assets/xml/objects/object_ma1.xml index 63eeb38950..466670e18a 100644 --- a/assets/xml/objects/object_ma1.xml +++ b/assets/xml/objects/object_ma1.xml @@ -1,7 +1,7 @@ - + diff --git a/assets/xml/objects/object_ma2.xml b/assets/xml/objects/object_ma2.xml index ce5910fb80..0b6eabff70 100644 --- a/assets/xml/objects/object_ma2.xml +++ b/assets/xml/objects/object_ma2.xml @@ -21,7 +21,7 @@ - + diff --git a/assets/xml/objects/object_mizu_objects.xml b/assets/xml/objects/object_mizu_objects.xml index 1abd73bc0b..f25c29d6c3 100644 --- a/assets/xml/objects/object_mizu_objects.xml +++ b/assets/xml/objects/object_mizu_objects.xml @@ -10,7 +10,7 @@ - + @@ -25,17 +25,17 @@ - + - + - + - + diff --git a/assets/xml/objects/object_mo.xml b/assets/xml/objects/object_mo.xml index a0e8ded406..df4b5c640a 100644 --- a/assets/xml/objects/object_mo.xml +++ b/assets/xml/objects/object_mo.xml @@ -2,7 +2,7 @@ - + @@ -63,12 +63,12 @@ - + - + diff --git a/assets/xml/objects/object_ms.xml b/assets/xml/objects/object_ms.xml index a87d0e6b36..66923df8ae 100644 --- a/assets/xml/objects/object_ms.xml +++ b/assets/xml/objects/object_ms.xml @@ -2,7 +2,7 @@ - + diff --git a/assets/xml/objects/object_oF1d_map.xml b/assets/xml/objects/object_oF1d_map.xml index c4f3a41f82..079189319c 100644 --- a/assets/xml/objects/object_oF1d_map.xml +++ b/assets/xml/objects/object_oF1d_map.xml @@ -1,5 +1,5 @@ - + @@ -12,13 +12,13 @@ - + - + @@ -30,6 +30,6 @@ - + diff --git a/assets/xml/objects/object_owl.xml b/assets/xml/objects/object_owl.xml index fdc64b3aa9..e6fa5ca371 100644 --- a/assets/xml/objects/object_owl.xml +++ b/assets/xml/objects/object_owl.xml @@ -53,11 +53,11 @@ - - - - + + + + diff --git a/assets/xml/objects/object_po_sisters.xml b/assets/xml/objects/object_po_sisters.xml index e0c9f0834b..7752843444 100644 --- a/assets/xml/objects/object_po_sisters.xml +++ b/assets/xml/objects/object_po_sisters.xml @@ -18,11 +18,11 @@ - - - - + + + + - + diff --git a/assets/xml/objects/object_ru1.xml b/assets/xml/objects/object_ru1.xml index 3d413619ff..482949c903 100644 --- a/assets/xml/objects/object_ru1.xml +++ b/assets/xml/objects/object_ru1.xml @@ -38,10 +38,10 @@ - + - + @@ -60,9 +60,9 @@ - + - + diff --git a/assets/xml/objects/object_ru2.xml b/assets/xml/objects/object_ru2.xml index 2a8d70af3e..d6cea22915 100644 --- a/assets/xml/objects/object_ru2.xml +++ b/assets/xml/objects/object_ru2.xml @@ -49,7 +49,7 @@ - + @@ -58,7 +58,7 @@ - + diff --git a/assets/xml/objects/object_sa.xml b/assets/xml/objects/object_sa.xml index a19446453b..8a63840409 100644 --- a/assets/xml/objects/object_sa.xml +++ b/assets/xml/objects/object_sa.xml @@ -1,7 +1,7 @@ - + @@ -72,7 +72,7 @@ - + diff --git a/assets/xml/objects/object_sd.xml b/assets/xml/objects/object_sd.xml index c72efeae10..c872472e71 100644 --- a/assets/xml/objects/object_sd.xml +++ b/assets/xml/objects/object_sd.xml @@ -52,7 +52,7 @@ - + diff --git a/assets/xml/objects/object_skj.xml b/assets/xml/objects/object_skj.xml index 3abdd610f8..9d9c1c3a0b 100644 --- a/assets/xml/objects/object_skj.xml +++ b/assets/xml/objects/object_skj.xml @@ -23,7 +23,7 @@ - + @@ -52,7 +52,7 @@ - + diff --git a/assets/xml/objects/object_spot00_break.xml b/assets/xml/objects/object_spot00_break.xml index d3be88315f..bee1361fab 100644 --- a/assets/xml/objects/object_spot00_break.xml +++ b/assets/xml/objects/object_spot00_break.xml @@ -7,7 +7,7 @@ - + diff --git a/assets/xml/objects/object_spot06_objects.xml b/assets/xml/objects/object_spot06_objects.xml index e3da63b0f0..5084fd244e 100644 --- a/assets/xml/objects/object_spot06_objects.xml +++ b/assets/xml/objects/object_spot06_objects.xml @@ -16,9 +16,9 @@ - + - + diff --git a/assets/xml/objects/object_spot08_obj.xml b/assets/xml/objects/object_spot08_obj.xml index 4d71f3473f..8d2aa760ce 100644 --- a/assets/xml/objects/object_spot08_obj.xml +++ b/assets/xml/objects/object_spot08_obj.xml @@ -15,13 +15,13 @@ - + - + diff --git a/assets/xml/objects/object_spot16_obj.xml b/assets/xml/objects/object_spot16_obj.xml index d39de812a9..b7a6ff4d54 100644 --- a/assets/xml/objects/object_spot16_obj.xml +++ b/assets/xml/objects/object_spot16_obj.xml @@ -6,6 +6,6 @@ - + diff --git a/assets/xml/objects/object_sst.xml b/assets/xml/objects/object_sst.xml index dc7ca242ca..378351b220 100644 --- a/assets/xml/objects/object_sst.xml +++ b/assets/xml/objects/object_sst.xml @@ -3,7 +3,7 @@ - + diff --git a/assets/xml/objects/object_wf.xml b/assets/xml/objects/object_wf.xml index ebfb708d2d..96ea841032 100644 --- a/assets/xml/objects/object_wf.xml +++ b/assets/xml/objects/object_wf.xml @@ -6,7 +6,7 @@ - + @@ -21,10 +21,10 @@ - + - + diff --git a/assets/xml/objects/object_zl1.xml b/assets/xml/objects/object_zl1.xml index c7082a3db7..1b83550605 100644 --- a/assets/xml/objects/object_zl1.xml +++ b/assets/xml/objects/object_zl1.xml @@ -96,7 +96,7 @@ - + diff --git a/assets/xml/objects/object_zl4.xml b/assets/xml/objects/object_zl4.xml index b43e5ba34e..e87a654656 100644 --- a/assets/xml/objects/object_zl4.xml +++ b/assets/xml/objects/object_zl4.xml @@ -43,7 +43,7 @@ - + diff --git a/assets/xml/overlays/ovl_Bg_Ganon_Otyuka.xml b/assets/xml/overlays/ovl_Bg_Ganon_Otyuka.xml index 871c97b409..6b9a9a7441 100644 --- a/assets/xml/overlays/ovl_Bg_Ganon_Otyuka.xml +++ b/assets/xml/overlays/ovl_Bg_Ganon_Otyuka.xml @@ -1,13 +1,13 @@ - + - + @@ -23,7 +23,7 @@ - + diff --git a/assets/xml/overlays/ovl_Bg_Jya_Cobra.xml b/assets/xml/overlays/ovl_Bg_Jya_Cobra.xml index 4e40918f87..874bb1ec67 100644 --- a/assets/xml/overlays/ovl_Bg_Jya_Cobra.xml +++ b/assets/xml/overlays/ovl_Bg_Jya_Cobra.xml @@ -5,6 +5,6 @@ - + diff --git a/assets/xml/overlays/ovl_Boss_Ganon.xml b/assets/xml/overlays/ovl_Boss_Ganon.xml index 49cd1b24a2..e84792fa37 100644 --- a/assets/xml/overlays/ovl_Boss_Ganon.xml +++ b/assets/xml/overlays/ovl_Boss_Ganon.xml @@ -12,7 +12,7 @@ - + diff --git a/assets/xml/overlays/ovl_En_Bili.xml b/assets/xml/overlays/ovl_En_Bili.xml index 483a2fcd46..35c3fa301e 100644 --- a/assets/xml/overlays/ovl_En_Bili.xml +++ b/assets/xml/overlays/ovl_En_Bili.xml @@ -2,6 +2,6 @@ - + diff --git a/assets/xml/overlays/ovl_End_Title.xml b/assets/xml/overlays/ovl_End_Title.xml index 82dceca252..841d45f6dd 100644 --- a/assets/xml/overlays/ovl_End_Title.xml +++ b/assets/xml/overlays/ovl_End_Title.xml @@ -6,12 +6,12 @@ - + - + diff --git a/assets/xml/scenes/dungeons/ddan.xml b/assets/xml/scenes/dungeons/ddan.xml index f6572b9f8e..197839bde2 100644 --- a/assets/xml/scenes/dungeons/ddan.xml +++ b/assets/xml/scenes/dungeons/ddan.xml @@ -12,7 +12,7 @@ - + diff --git a/assets/xml/scenes/overworld/souko.xml b/assets/xml/scenes/overworld/souko.xml index 508beb85d7..bc6336b360 100644 --- a/assets/xml/scenes/overworld/souko.xml +++ b/assets/xml/scenes/overworld/souko.xml @@ -1,7 +1,7 @@ - - + + diff --git a/docs/Documenting.md b/docs/Documenting.md index f8b3566499..03a12ebbd4 100644 --- a/docs/Documenting.md +++ b/docs/Documenting.md @@ -4,9 +4,9 @@ This project uses [Doxygen](https://www.doxygen.nl/index.html) to generate documentation pages from comments found in the source files. This guide focuses on writing compatible comments and ensuring consistency across the codebase. ```diff - Note - -As the codebase is constantly changing, only document what is complete, well-understood and not +As the codebase is constantly changing, only document what is complete, well-understood and not already covered by good naming. This is especially true for function parameters and return values. -Also note that there is no obligation to completing the documentation steps for functions you +Also note that there is no obligation to completing the documentation steps for functions you work on if you do not want to at the time. ``` To generate a doxygen manual for the project, ensure you have doxygen installed and then cd into the project root directory and run `doxygen Doxyfile`. @@ -97,4 +97,4 @@ For centered rendering on a separate line: /** * \f[ \textrm{Your LaTeX Here} \f] */ -``` \ No newline at end of file +``` diff --git a/docs/tutorial/beginning_decomp.md b/docs/tutorial/beginning_decomp.md index 9c5aa45f17..c9421ffd30 100644 --- a/docs/tutorial/beginning_decomp.md +++ b/docs/tutorial/beginning_decomp.md @@ -60,8 +60,8 @@ The above is a rough ordering for the beginner. As you become more experienced, Associated to each actor is a `.data` file, containing data that the actor uses. This ranges from spawn positions, to display lists, to even some cutscene data. Since the structure of the data is very inconsistent between actors, automatic importing has been very limited, so the vast majority must be done manually. -There are two ways of transfering the data into an actor: we can either -- import it all naively as words (`s32`s), which will still allow it to compile, and sort out the actual types later, or +There are two ways of transfering the data into an actor: we can either +- import it all naively as words (`s32`s), which will still allow it to compile, and sort out the actual types later, or - we can extern each piece of data as we come across it, and come back to it later when we have a better idea of what it is. We will concentrate on the second here; the other is covered in [the document about data](data.md). Thankfully this means we essentially don't have to do anything to the data yet. Nevertheless, it is often quite helpful to copy over at least some of the data and leave it commented out for later replacement. *Data must go in the same order as in the data file, and data is "all or nothing": you cannot only import some of it*. @@ -93,7 +93,7 @@ from the main directory of the repository. In this case, the C file is `src/over ![Copying the context](images/ctx.png) -Now, open the file containing the assembly for `EnJj_Init`. +Now, open the file containing the assembly for `EnJj_Init`. ![Copying the Init asm](images/init_asm.png) @@ -117,7 +117,7 @@ void EnJj_Init(EnJj *this, GlobalContext *globalCtx) { ActorShape_Init(&this->actor.shape, 0.0f, NULL, 0.0f); temp_v0 = this->actor.params; temp_a1 = this + 0x164; - [...] + [...] ``` Typically for all buth the simplest functions, there is a lot that needs fixing before we are anywhere near seeing how close we are to the original code. You will notice that mips2c creates a lot of temporary variables. Usually most of these will turn out to not be real, and we need to remove the right ones to get the code to match. @@ -217,7 +217,7 @@ void EnJj_Init(Actor *thisx, GlobalContext *globalCtx) { In the next sections, we shall sort out the various initialisation functions that occur in Init. There are several types, and one of the reasons we are using EnJj as the example is that it has several of the most common ones. A disadvantage of this actor is that it has an unusually complicated Init: we can see that it does three different things depending on the value of its params. ### Init chains - + Almost always, one of the first items in `Init` is a function that looks like ```C @@ -324,7 +324,7 @@ this->dyna.bgId = DynaPoly_SetBgActor(globalCtx, &globalCtx->colCtx.dyna, &this- Next, replace `(DynaPolyActor *) this` by `&this->dyna`. There's not a lot more we can do to the DynaPoly stuff right now, so just remove the casts to void and move on. ### Colliders - + The next common thing that actors have is colliders. Not every actor has these, but most do, even if they don't just use them for collision system purposes. The relevant functions in this actor are @@ -355,7 +355,7 @@ Collider_SetCylinder(globalCtx, &this->collider, &this->dyna.actor, &D_80A88CB4) (You may prefer to just comment out temps initially, to keep track of where they were.) -The last thing we need to deal with is the last variable of `Collider_SetCylinder`, which is again data. +The last thing we need to deal with is the last variable of `Collider_SetCylinder`, which is again data.