Skip to content

Commit

Permalink
Reference AudioUtils modes in XML docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LeeTwentyThree committed Jul 4, 2023
1 parent b5f5a01 commit 91f07d2
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions Nautilus/Handlers/CustomSoundHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ public static class CustomSoundHandler
/// <param name="id">The Id of your custom sound which is used when checking which sounds to play.</param>
/// <param name="filePath">The file path on disk of the sound file to load.</param>
/// <param name="busPath">The bus path to play the sound on.</param>
/// <param name="mode">The audio MODE of the sound.</param>
/// <param name="mode">The audio MODE of the sound.
/// Standard values of this property can be found in the <see cref="AudioUtils"/> class (i.e. <see cref="AudioUtils.StandardSoundModes_3D"/>).</param>
/// <returns>the <see cref="Sound"/> loaded</returns>
public static Sound RegisterCustomSound(string id, string filePath, string busPath, MODE mode = MODE.DEFAULT)
{
Expand All @@ -33,7 +34,8 @@ public static Sound RegisterCustomSound(string id, string filePath, string busPa
/// <param name="id">The Id of your custom sound which is used when checking which sounds to play.</param>
/// <param name="filePath">The file path on disk of the sound file to load.</param>
/// <param name="bus">The bus to play the sound on.</param>
/// <param name="mode">The audio MODE of the sound.</param>
/// <param name="mode">The audio MODE of the sound.
/// Standard values of this property can be found in the <see cref="AudioUtils"/> class (i.e. <see cref="AudioUtils.StandardSoundModes_3D"/>).</param>
/// <returns>the <see cref="Sound"/> loaded</returns>
public static Sound RegisterCustomSound(string id, string filePath, Bus bus, MODE mode = MODE.DEFAULT)
{
Expand All @@ -53,7 +55,8 @@ public static Sound RegisterCustomSound(string id, string filePath, Bus bus, MOD
/// <param name="id">The Id of your custom sound which is used when checking which sounds to play.</param>
/// <param name="audio">The AudioClip to register.</param>
/// <param name="busPath">The bus path to play the sound on.</param>
/// <param name="mode">The audio MODE of the sound.</param>
/// <param name="mode">The audio MODE of the sound.
/// Standard values of this property can be found in the <see cref="AudioUtils"/> class (i.e. <see cref="AudioUtils.StandardSoundModes_3D"/>).</param>
/// <returns>the <see cref="Sound"/> loaded</returns>
public static Sound RegisterCustomSound(string id, AudioClip audio, string busPath, MODE mode = MODE.DEFAULT)
{
Expand All @@ -67,7 +70,8 @@ public static Sound RegisterCustomSound(string id, AudioClip audio, string busPa
/// <param name="id">The Id of your custom sound which is used when checking which sounds to play.</param>
/// <param name="audio">The AudioClip to register.</param>
/// <param name="bus">The bus to play the sound on.</param>
/// <param name="mode">The audio MODE of the sound.</param>
/// <param name="mode">The audio MODE of the sound.
/// Standard values of this property can be found in the <see cref="AudioUtils"/> class (i.e. <see cref="AudioUtils.StandardSoundModes_3D"/>).</param>
/// <returns>the <see cref="Sound"/> loaded</returns>
public static Sound RegisterCustomSound(string id, AudioClip audio, Bus bus, MODE mode = MODE.DEFAULT)
{
Expand Down

0 comments on commit 91f07d2

Please sign in to comment.