Applied the suggested changes for #6728. #8281
Open
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
MonoGame 3.8 Release
Update master
Fix Missing Android Package
Fix cake script for 3.8.1 auto release
3.8.1 HOTFIX
|
This seems fine to me, but requesting a second review since it's a workaround. @itsBuggingMe would you mind rebasing your PR to resolve the merge conflict? |
* Point to that Patreon page. * Use Patreon tag
I needed to take some extra steps for this documentation to work. Documenting for future users' benefit.
… prevent large quantities of Warning CA1416 when targeting an API earlier than 31 on Android
Accounts for new sdl nomenclature in sdl version checks
* The [ that was inside the url was removed. * In minimal installations of Ubuntu curl is not installed, which is used internally in the script.
… height of the property grid. (MonoGame#8015)
After reading the docs, it appears that the default value on the actual `EnvironmentMapEffect` side is intended to be 1. Making the writer default to the same value seems like a good choice. I also tweaked the comment because the way it is written, something in the documentation is interpreting that as a numbered list when it is just the end of a sentence.
… point. (MonoGame#8007) * Fixes a bug in the `CalculateNormals` method that chooses the wrong normals for each point. * Removes a stray using directive that shouldn't have gotten in there.
…onoGame#8192) * Update requirements.md platforms link and contributing.md tests link * Update REQUIREMENTS.md
…ntation (MonoGame#8216) * Added documentation for GetTypeReader(Type) * Further clarify GetTypeReader() * Update documentation for PrepareType(string) * Update the documentation for AddTypeCreator(string, Func<ContentTypeReader>) * Adds documentation for ClearTypeCreators() * Added documentation for ContentTypeReaderManager
…MonoGame#8215) * Add documentation for CanDeserializeIntoExistingObject property * Add documentation for TargetType property * Add documentation for TypeVersion property * Add empty summary for protected Constructor * Add empty summary for protected Initialize * Add empty summary for protected Read * Add empty summary for protected Constructor * Add inheritdoc for Read method override * Add inheritdoc for Read method override * Add documentation for ContentTypeReader * Add documentation for ContentTypeReader<T> * Should be empty summary, not inheritdoc
…entation (MonoGame#8214) * Fixed various spelling errors * Update wording of constructor * Add documentation for AllowNull property * Updated documentation for CollectionItemName property * Adds documentation for ElementName property * Add documentation for FlattenContent * Updates documentation for HasCollectionItemName property * Add documentation for Optional property * Add documentation for SharedResource property * Added documentation for Clone() * Add documentation for ContentSerializerAttribute
…ation (MonoGame#8213) * Updated documentation for GetGraphicsDevice(ContentReader) * Add documentation for ContentReaderExtensions
…noGame#8212) * Added documentation for ContentManger property * Added documentation for AssetName property * Added documentation for ReadExternalReference<T> * Improve wording and include exceptions * Include exceptions that can be caused by underlying read. * Add documentation for ReadMatrix() * Added documentation for ReadObject<T> * Added documentation for ReadObject<T>(ContentTypeReader) * Added documentation for ReadObject<T>(T) * Added documentation for ReadObject<T>(ContentTypeReader, T) * Add documentation for ReadQuaternion * Include text "as an instance of the specified type" * Added documentation for ReadRawObject<T>() * Added documentation for ReadRawObject<T>(ContentTypeReader) * Added documentation for ReadRawObject<T>(T) * Added documentation for ReadRawObject<T>(ContentREader, T) * Added documentation for ReadSharedResource<T>(Action<T>) * Added documentation for ReadVector2() * Added documentation for ReadVector3() * Added documentation for ReadVector4() * Added documentation for ReadColor() * Added documentation for ContentReader
…noGame#8211) * Fix spelling of identifiers. * Removed unnecessary comments Information about finalizer implementation and correctly using Dispose pattern is well documented in MSDN articles and doesn't need to be documented in code. * Added empty <summary /> for finalizer * Update documentation for constructor * Added constructor overload documentation Used <inheritdoc /> since it's the same information however when doing this and defining the documentation for the rootDirectory param, the XML warning is still thrown for the serviceProvider param. By providing an empty param tag for servcieProvider, it will correctly inherit the already written one in the previous constructor and remove the XML documentation warning. * Add <inheritdoc /> for Dispose * Removed unnecessary comments Callling GC.SupressFinalize(this) inside Dispose the common recommended pattern and is well documented already on MSDN pages. * Add documentation for Dispose(bool) * Added documentation for LoadLocalized<T> * Correct spelling of separating. * Add documentation for Load<T> * Empty summary tag for protected OpenStream * Empty summary tag for protected ReadAsset * Empty summary tag for protected LoadAssets * Empty summary for protected ReloadGraphicsAssets * Empty summary for protected ReloadAsset<T> * Added documentation for Unload() * Grammar correction * Remove extra space * Add documentation for UnloadAsset * Added documentation for UnloadAssets * Added documentation for RootDirectory * Added documentation for ServiceProvider * Added documentation for ContentManager * Remove repeated statement
…#8209) * Add XML documentation to Exception classes * Add XML docs for NoSuitableGraphicsDeviceException
…sses (MonoGame#8181) * Add XML documentation for type converters * Update based on new contributing guidelines.
…space Members (MonoGame#8179) * Add missing XML documentation for Bgr565 * Add missing XML documentation for Bgra4444 * Add missing XML documentation for Bgra5551 * Add missing XML documentation for HalfSingle * Add missing XML documentation for HalfVector2 * Add missing XML documentation for IPackedVector * Add missing XML documentation for Short2 * Add missing XML documentation for Rgba64 * Add missing XML documentation for Rgba1010102 * Add missing XML documentation for Rg32 * Add missing XML documentation for NormalizedShort4 * Add missing XML documentation for NormalizedShort2 * Add missing XML documentation for NormalizedByte4 * Add missing XML documentation for NormalizedByte2 * Ensure XML documentation is consistant across all PackedVector members (MonoGame#1) * Update based on new contributing guidelines
…es (MonoGame#8186) * Add missing XML docs for various custom vertices types * Refining the docs for custom vertex formats
…onoGame#8177) * Add missing XML documentation for AudioEngine * Add missing XML documentation for Cue * Add missing XML documentation for SoundBank * Add missing XML documentation for WaveBank * Add missing XML documentation for MicrophoneState * Update docs for Cue.IsPrepared member * Refining the docs for Audio namespace
…onoGame#8229) * Add class level documentation * Add documentation for DepthBufferEnable property * Add documentation for DepthBufferWriteEnabled property * Add exception documentation for DepthBufferEnable property * Add documentation for CounterClockwiseStencilDepthBufferFail property * Add default value documentation for DepthBufferEnable * Add default value documentation for DepthBufferWriteEnable property * Add documentation for CounterClockwiseStencilFail property * Add documentation for CounterClockwiseStencilFunction property * Add documentation for CounterClockwiseStencilPass property * Add documentation for DepthBufferFunction property * Added documentation for ReferenceStencil property * Added documentation for StencilDepthBufferFail property. * Adds documentation for StencilEnable property. * Add documentation for StencilFail property. * Add documentation for StencilFunction property. * Add documentation for StencilMask property. * Add documentation for StencilPass property. * Add documentation for StencilWriteMask property. * Add documentation for TwoSidedStencilMode property. * Added documentation for DepthStencilState constructor. * Add documentation for Default member * Added remark for Default member. * Add documentation for DepthRead member * Add documentation for None member. * Add inheritdoc for protected Dispose method
…onoGame#8230) * Added documentation for DirectionalLight constructor * Add documentation for DiffuseColor property. * Add documentation for Direction property. * Add documentation for SpecularColor property. * Add documentation for Enabled property. * Add documentation for DirectionalLight class.
* Add documentation for DisplayMode class * Add documentation for Format property. * Add documentation for Height property. * Add documentation for Width property. * Add documentation for AspectRatio property. * Add documentation for TitleSafeArea property * Add documentation for != operator * Add documentation to the == operator * Add inheritdoc to Equals override method * Adds inheritdoc to GetHashCode override method. * Adds inhertitdoc to ToString override method.
…e#8236) * Add documentation for class. * Add documentation for this[] property. * Add inheritdoc for GetEnumerator
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.
Just added the suggested changes for #6728.