Add doc comments to docfx.json related config files. #8969
Merged
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
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #8969 +/- ##
==========================================
+ Coverage 76.88% 76.92% +0.03%
==========================================
Files 605 605
Lines 25074 25054 -20
==========================================
- Hits 19279 19272 -7
+ Misses 5795 5782 -13
☔ View full report in Codecov by Sentry. |
yufeih
reviewed
Jul 16, 2023
Co-authored-by: Yufei Huang <[email protected]>
…nto add-doc-comments
|
I've fixed commented issues with following commits.
It seems there are some unused code exists. |
yufeih
approved these changes
Jul 16, 2023
|
Add commit (2a40b8c) |
yufeih
added
the
new-feature
p-kostov
pushed a commit
to ErpNetDocs/docfx
that referenced
this pull request
Jun 28, 2024
* Add doc comments * Add warning suppression for obsolete * Add warning suppression for obsolete * Update src/Docfx.App/Config/BuildJsonConfig.cs Co-authored-by: Yufei Huang <[email protected]> * Add obsolete attributes that is mentioned in review comments. and fix some comment. * Update DocumentBuilderWrapper.cs * fix .gitignore file for docfx init --------- Co-authored-by: Yufei Huang <[email protected]>
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 PR add doc comments that are related to
docfx.jsonconfigs.and adding some obsolete attributes.
Purpose of this PR
Preparation to create JSON schema document for
docfx.jsonfrom C# code and doc comments. (#8968)Add Obsolete attribute
This PR add `[Obsolete] property to following properties
dest(As commented on Behaviors when specifying `dest` and `output` options simultaneously #8967).outputproperty is added recently.destusage should be deprecated)versions(It's seems remaining for compatibility purpose)Documentation comments
Almost doc comments are taken from following contents.
Some properties are not documented. and no working example found.
So I've added doc comment these property.
** List of undocumented
buildsection properties**pairingxrefTagstagParametersversions