Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add XML documentation for publishing library to .Net API Reference #210

Merged
merged 46 commits into from
Oct 1, 2019

Conversation

cheenamalhotra
Copy link
Member

@cheenamalhotra cheenamalhotra commented Sep 23, 2019

Lots of hardwork coming in!

Contributors:
@JRahnama @v-kaywon @cheenamalhotra

Changes with this PR:

  • Adds common XML doc snippets to be extracted for XML documentation
  • Adds Samples to repository included in documentation
  • Updated both NetFx and NetCore drivers with documentation includes.
  • GitIgnore update to exclude nuget.exe
  • build.proj now defaults to BuildAllConfigurations target. Addresses Release Nuget package generation #197
  • Added include tags in 'ref' classes for Visual Studio Intellisense support.

Additional Changes in this PR:

  • Microsoft.Data.SqlTypes.SqlFileStream added in NetFx.
  • Existing tests run against the newly added SqlFileStream class.

As of now, this PR brings documentation over from System.Data.SqlClient.
Work to be continued to enhance missing docs in future PRs.

cheenamalhotra and others added 24 commits September 10, 2019 23:35
# Conflicts:
#	build.proj
* add more code samples from api reference

* add documentation xml files

* add include tags for SqlConnectionColumnEncryptionSetting.xml and SqlConnectionStringBuilder.xml

* add include tags for SqlCredential.xml

* add include tags for SqlDataAdapter.xml

* add includes for SqlDataReader.xml

* add include tags for SqlDependency.xml

* add include tags for SqlEnclaveAttestationParameters.xml

* add include tags for SqlEnclaveSession.xml

* add include tags for SqlError.xml

* add include tags for SqlErrorCollection.xml and SqlException.xml

* add include tags for SqlInfoMessageEventArgs.xml and SqlInfoMessageEventHandler.xml

* add inclue tags for SqlNotification xmls

* add newline at the end of each xml file

* add include tags for SqlParameter and SqlParameterCollection.xml

* add more include tags

* change snippet tag location to before using MDS

* add SqlConnection documentation

* replace using SDS with MDS in samples
* documentation files updated

* Documentation updated

* Documentation's sample files formatted.

* Resolved issues.

* move sample class to correct location
# Conflicts:
#	src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlAuthenticationParameters.cs
#	src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlAuthenticationParameters.cs
@cheenamalhotra cheenamalhotra added the 📍 Push to Commit Feed This label will be added to PRs whose NuGet Package will be available from CI Public Feed. label Sep 30, 2019
@cheenamalhotra cheenamalhotra mentioned this pull request Sep 30, 2019
@cheenamalhotra cheenamalhotra merged commit d6f2e29 into master Oct 1, 2019
@cheenamalhotra
Copy link
Member Author

NuGet Package from Commits Feed:
Microsoft.Data.SqlClient 1.1.0-build.19274.1-d6f2e29

@cheenamalhotra cheenamalhotra deleted the docs branch October 18, 2019 04:40
yukiwongky pushed a commit to yukiwongky/SqlClient that referenced this pull request Nov 5, 2019
…ence (dotnet#210)

Contributors:
@JRahnama @v-kaywon @cheenamalhotra 

Changes with this PR:
- Adds common XML doc snippets to be extracted for XML documentation
- Adds Samples to repository included in documentation
- Updated both NetFx and NetCore drivers with documentation includes.
- GitIgnore update to exclude `nuget.exe`
- build.proj now defaults to `BuildAllConfigurations` target. Addresses dotnet#197
- Added include tags in 'ref' classes for Visual Studio Intellisense support.

Additional Changes in this PR:
- `Microsoft.Data.SqlTypes.SqlFileStream` added in NetFx.
- Existing tests run against the newly added SqlFileStream class.

As of now, this PR brings documentation over from System.Data.SqlClient.
Work to be continued to enhance missing docs in future PRs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📍 Push to Commit Feed This label will be added to PRs whose NuGet Package will be available from CI Public Feed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants