mirror of https://github.com/zeldaret/tp.git
194 lines
4.2 KiB
C
194 lines
4.2 KiB
C
/*!
|
|
@mainpage About
|
|
@tableofcontents
|
|
|
|
@section intro Introduction
|
|
This site contains documentation for the Twilight Princess code base. It is a work in progress and will be updated as more code is decompiled and documented.
|
|
|
|
@section code Code
|
|
@subsection actors Actors
|
|
- @ref actors-doors "Doors"
|
|
- @ref actors-enemies "Enemies"
|
|
- @ref actors-items "Items"
|
|
- @ref actors-objects "Objects"
|
|
- @ref actors-npcs "NPCs"
|
|
- @ref actors-tags "Tags"
|
|
- @ref actors-unsorted "Unsorted"
|
|
|
|
@subsection dolphin Dolphin
|
|
|
|
@subsection dolzel Dolzel
|
|
|
|
@subsection framework Framework
|
|
|
|
@subsection jsystem JSystem
|
|
- @ref jsystem-j2d "J2D"
|
|
- @ref jsystem-j3d "J3D"
|
|
- @ref jsystem-jaudio "JAudio"
|
|
- @ref jsystem-jframework "JFramework"
|
|
- @ref jsystem-jgadget "JGadget"
|
|
- @ref jsystem-jkernel "JKernel"
|
|
- @ref jsystem-jmath "JMath"
|
|
- @ref jsystem-jmessage "JMessage"
|
|
- @ref jsystem-jparticle "JParticle"
|
|
- @ref jsystem-jstage "JStage"
|
|
- @ref jsystem-jstudio "JStudio"
|
|
- @ref jsystem-jsupport "JSupport"
|
|
- @ref jsystem-jutility "JUtility"
|
|
|
|
@subsection m_do m_Do
|
|
|
|
@subsection misc Misc
|
|
|
|
@subsection msl_c MSL_C
|
|
|
|
@subsection runtime Runtime.PPCEABI.H
|
|
|
|
@subsection ssystem SSystem
|
|
|
|
@subsection trk TRK_MINNOW_DOLPHIN
|
|
|
|
@subsection z2audiolib Z2AudioLib
|
|
|
|
@section more-info More Information
|
|
For more information, visit [the decomp website](https://zsrtp.link).
|
|
|
|
*/
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// Group Definitions - Add new groups here for now
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// Actors
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* @defgroup actors Actors
|
|
* @brief All actor classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-doors Doors
|
|
* @brief Doors are entities that block the player's path until certain conditions are met.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-enemies Enemies
|
|
* @brief Enemies are hostile entities that attack the player.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-items Items
|
|
* @brief Items are collectable objects that appear in the item wheel or pause menu.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-objects Objects
|
|
* @brief Objects are interactable entities the player can interact with.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-npcs NPCs
|
|
* @brief NPCs are non-playable characters that interact with the player.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup actors
|
|
* @defgroup actors-tags Tags
|
|
* @brief Tags are various different types of triggers (NPC prompts, loading zones, Midna pop ups, environment changes, etc.).
|
|
*/
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// JSystem
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* @defgroup jsystem JSystem
|
|
* @brief All JSystem classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-j2d J2D
|
|
* @brief All J2D classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-j3d J3D
|
|
* @brief All J3D classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jaudio JAudio
|
|
* @brief All JAudio classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jframework JFramework
|
|
* @brief All JFramework classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jgadget JGadget
|
|
* @brief All JGadget classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jkernel JKernel
|
|
* @brief All JKernel classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jmath JMath
|
|
* @brief All JMath classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jmessage JMessage
|
|
* @brief All JMessage classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jparticle JParticle
|
|
* @brief All JParticle classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jstage JStage
|
|
* @brief All JStage classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jstudio JStudio
|
|
* @brief All JStudio classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jsupport JSupport
|
|
* @brief All JSupport classes.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup jsystem
|
|
* @defgroup jsystem-jutility JUtility
|
|
* @brief All JUtility classes.
|
|
*/ |