Skip to content

Commit 3b2a430

Browse files
BillWagnergewarrentdykstra
authored
Move xml doc section (#24705)
* move XML doc files Move content from all XML documentation files. All the tag reference was combined, but not no other edits were made. * Start work on new overview * rearrange * clean up recommended tags final draft of recommended tags * Put the examples together in a more cohesive manner * grammar check * Add text for any remaining issues. In this commit, I checked all open issues on the XML doc section and made sure they were addressed. Where they have not been, make updates to address them. * update final redirects Some were incorrectly going to samples instead of the description of each tag. * replace redirects Use the clean-repo tool to replace links that have been redirected. * use relative links Run the clean-repo tool to replace root links with relative links. * add redirect with anchor This is showing up in build warnings. * fix incorrect redirect Two redirects weren't formatted correctly. Fix those, and rerun clean-repo to get clean builds. * fix two include redirects * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Tom Dykstra <tdykstra@microsoft.com> * respond to feedback. * fix build warnings * one more build warning Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Tom Dykstra <tdykstra@microsoft.com>
1 parent 5e9660c commit 3b2a430

File tree

87 files changed

+1816
-3593
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+1816
-3593
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ ehthumbs_vista.db
4949
# Ionide folder, used in F# for VSCode
5050
.ionide/
5151
docs/core/extensions/snippets/workers/cloud-service/Properties/PublishProfiles/cloudworker.pubxml
52+
docs/csharp/language-reference/xmldoc/snippets/xmldoc/xmldoc.xml

‎.openpublishing.redirection.json‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,10 @@
943943
"source_path": "docs/csharp/csharp.md",
944944
"redirect_url": "/dotnet/csharp"
945945
},
946+
{
947+
"source_path": "docs/csharp/codedoc.md",
948+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
949+
},
946950
{
947951
"source_path": "docs/csharp/deconstruct.md",
948952
"redirect_url": "/dotnet/csharp/fundamentals/functional/deconstruct"
@@ -3240,6 +3244,110 @@
32403244
"source_path": "docs/csharp/programming-guide/unsafe-code-pointers/pointer-types.md",
32413245
"redirect_url": "/dotnet/csharp/language-reference/unsafe-code#pointer-types"
32423246
},
3247+
{
3248+
"source_path": "docs/csharp/programming-guide/xmldoc/code.md",
3249+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3250+
},
3251+
{
3252+
"source_path": "docs/csharp/programming-guide/xmldoc/code-inline.md",
3253+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3254+
},
3255+
{
3256+
"source_path": "docs/csharp/programming-guide/xmldoc/cref-attribute.md",
3257+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3258+
},
3259+
{
3260+
"source_path": "docs/csharp/programming-guide/xmldoc/delimiters-for-documentation-tags.md",
3261+
"redirect_url": "/dotnet/csharp/programming-guide/xmldoc"
3262+
},
3263+
{
3264+
"source_path": "docs/csharp/programming-guide/xmldoc/example.md",
3265+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3266+
},
3267+
{
3268+
"source_path": "docs/csharp/programming-guide/xmldoc/exception.md",
3269+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3270+
},
3271+
{
3272+
"source_path": "docs/csharp/programming-guide/xmldoc/how-to-use-the-xml-documentation-features.md",
3273+
"redirect_url": "/dotnet/csharp/programming-guide/xmldoc/index"
3274+
},
3275+
{
3276+
"source_path": "docs/csharp/programming-guide/xmldoc/include.md",
3277+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3278+
},
3279+
{
3280+
"source_path": "docs/csharp/programming-guide/xmldoc/index.md",
3281+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc"
3282+
},
3283+
{
3284+
"source_path": "docs/csharp/programming-guide/xmldoc/inheritdoc.md",
3285+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3286+
},
3287+
{
3288+
"source_path": "docs/csharp/programming-guide/xmldoc/list.md",
3289+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3290+
},
3291+
{
3292+
"source_path": "docs/csharp/programming-guide/xmldoc/para.md",
3293+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3294+
},
3295+
{
3296+
"source_path": "docs/csharp/programming-guide/xmldoc/param.md",
3297+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3298+
},
3299+
{
3300+
"source_path": "docs/csharp/programming-guide/xmldoc/paramref.md",
3301+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3302+
},
3303+
{
3304+
"source_path": "docs/csharp/programming-guide/xmldoc/permission.md",
3305+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/index"
3306+
},
3307+
{
3308+
"source_path": "docs/csharp/programming-guide/xmldoc/processing-the-xml-file.md",
3309+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc"
3310+
},
3311+
{
3312+
"source_path": "docs/csharp/programming-guide/xmldoc/processing-the-xml-file.md#id-strings",
3313+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc#id-strings"
3314+
},
3315+
{
3316+
"source_path": "docs/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments.md",
3317+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3318+
},
3319+
{
3320+
"source_path": "docs/csharp/programming-guide/xmldoc/remarks.md",
3321+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3322+
},
3323+
{
3324+
"source_path": "docs/csharp/programming-guide/xmldoc/returns.md",
3325+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3326+
},
3327+
{
3328+
"source_path": "docs/csharp/programming-guide/xmldoc/see.md",
3329+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3330+
},
3331+
{
3332+
"source_path": "docs/csharp/programming-guide/xmldoc/seealso.md",
3333+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3334+
},
3335+
{
3336+
"source_path": "docs/csharp/programming-guide/xmldoc/summary.md",
3337+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3338+
},
3339+
{
3340+
"source_path": "docs/csharp/programming-guide/xmldoc/typeparam.md",
3341+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3342+
},
3343+
{
3344+
"source_path": "docs/csharp/programming-guide/xmldoc/typeparamref.md",
3345+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3346+
},
3347+
{
3348+
"source_path": "docs/csharp/programming-guide/xmldoc/value.md",
3349+
"redirect_url": "/dotnet/csharp/language-reference/xmldoc/recommended-tags"
3350+
},
32433351
{
32443352
"source_path": "docs/csharp/programming-guide/xmldoc/xml-documentation-comments.md",
32453353
"redirect_url": "/dotnet/csharp/programming-guide/xmldoc"

‎docs/csharp/codedoc.md‎

Lines changed: 0 additions & 229 deletions
This file was deleted.

0 commit comments

Comments
 (0)