Audio Docs #2457
Merged
Audio Docs #2457
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// <summary> | ||
| /// Returns the name of this AudioCategoty | ||
| /// </summary> | ||
| /// <returns>Friendly name of the AudioCategoty</returns> |
| /// <param name="emitter">The emitter to calculate.</param> | ||
| /// <remarks> | ||
| /// <para>This must be called before Play().</para> | ||
| /// <para>Calling this method automatically converts the sound to monoaural and sets the speaker mix for any sound played by this cue to a value calculated with the listener's and emitter's positions. Any stereo information in the sound will be discarded.</para> |
There was a problem hiding this comment.
Not as wide, but still pretty wide
| @@ -116,16 +140,22 @@ public void Play() | |||
| PlatformPlay(); | |||
| } | |||
|
|
|||
| /// <summary>Resumes playback for a SoundEffectInstance.</summary> | |||
| /// <remarks>Only has effect on an SoundEffectInstance in a paused state.</remarks> | |||
There was a problem hiding this comment.
"on an", Maybe instead "Only has an effect on a ..."
|
English review complete :) |
|
@tomspilman - Finished making the changes that @danzel suggested. Thanks again, Dave! |
tomspilman
added a commit
that referenced
this pull request
May 2, 2014
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First run at some documentation for classes in the Microsoft.Xna.Framework.Audio namespace.
I also took care of replacing the old licenses while I was at it.
A contribution to #2378