Skip to content

[Docs] Use XML documentation lists - #1948

Merged
Eideren merged 1 commit into
stride3d:masterfrom
fydar:documentation-comments
Oct 16, 2023
Merged

[Docs] Use XML documentation lists#1948
Eideren merged 1 commit into
stride3d:masterfrom
fydar:documentation-comments

Conversation

@fydar

@fydar fydar commented Oct 16, 2023

Copy link
Copy Markdown
Contributor

PR Details

Use proper XML documentation list syntax (<list type="bullet">) (documented here on MSDN for lists across the project.

Description

This makes the IDE experience better by properly formatting lists. Also moved some of the lists from <Summary> to <Remarks> where single-line summaries are preferred.

image

Related Issue

  • None

Motivation and Context

This makes the IDE experience better by properly formatting lists.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@VaclavElias

Copy link
Copy Markdown
Contributor

I like it. Looking forward to see more improvements. By the way here is a discussion on this subject, not sure if you reached it yet #1745

@fydar

fydar commented Oct 16, 2023

Copy link
Copy Markdown
Contributor Author

I like it. Looking forward to see more improvements. By the way here is a discussion on this subject, not sure if you reached it yet #1745

I hadn't read that yet, I hope this PR can be an example of some potential good practices we might want to adopt ❤️

@Eideren

Eideren commented Oct 16, 2023

Copy link
Copy Markdown
Collaborator

Doesn't look that great or intuitive to write, so I doubt people will adopt it that easily. Thanks anyway :)

@Eideren
Eideren merged commit e017fe1 into stride3d:master Oct 16, 2023
@fydar
fydar deleted the documentation-comments branch October 16, 2023 19:43
xen2 pushed a commit to xen2/stride that referenced this pull request Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants