Facets XML (#311) #312
Merged
Facets XML (#311) #312
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
This was referenced Nov 17, 2022
Closed
nikcio
force-pushed
the
chore/facets-xml
branch
from
5ab8b4d to
50697ed
Compare
|
#322 Should help with showing all the api xml documentation added in this pr on the docs site. |
nikcio
force-pushed
the
chore/facets-xml
branch
3 times, most recently
from
22222ab to
8bdbed5
Compare
|
@Shazwazza I've updated this PR so it's now again ready to be merged. I also fixed 2 things that were missed in #311 :
|
Merged
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.
This adds XML documentation to the facets feature as well as other places in the project. This means that this PR is a super set of #311 and should be merged after the facets feature.
To see the changes in this PR before merging #311 see this commit
What changed
<GenerateDocumentationFile>True</GenerateDocumentationFile>to project filesApproach
<inheritdoc />to constructors without XML information. Constructor XML information is rarely needed so adding<inheritdoc />removes the XML warning.Remaining XML warnings
Some classes have not had XML added due to not knowing what the class / method is used to do.
GenericDirectoryFactoryFileSystemDirectoryFactoryIApplicationIdentifierIApplicationIdentifier.GetApplicationUniqueIdentifier()IApplicationRootIApplicationRoot.ApplicationRoot