Skip to content

Fix for missing BC docs + dead property#10361

Merged
keveleigh merged 3 commits into
microsoft:releases/2.7.3from
Zee2:bc_docs_fix
Dec 14, 2021
Merged

Fix for missing BC docs + dead property#10361
keveleigh merged 3 commits into
microsoft:releases/2.7.3from
Zee2:bc_docs_fix

Conversation

@Zee2

@Zee2 Zee2 commented Dec 8, 2021

Copy link
Copy Markdown
Contributor

Overview

As part of fixing some missing BC doccomments, I discovered that the public BoundsCorners property was actually dead code and was never referenced by anything. This fixes the doccomments and removes this dead property.

Changes

Verification

All BoundsControl tests pass.

@Zee2 Zee2 added this to the MRTK 2.7.3 milestone Dec 8, 2021
@Zee2 Zee2 self-assigned this Dec 8, 2021
@Zee2 Zee2 changed the base branch from main to releases/2.7.3 December 8, 2021 19:36
@Zee2

Zee2 commented Dec 8, 2021

Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

Comment thread Assets/MRTK/SDK/Features/UX/Scripts/BoundsControl/BoundsControl.cs
@Zee2

Zee2 commented Dec 8, 2021

Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@MaxWang-MS

Copy link
Copy Markdown
Contributor

This is definitely a nit, but I was just looking at the docs page linked in the issue and noticed there are some other public functions missing comments. Could you add /// <inheritdoc /> to those so that the comments properly show up on the docs as well?

@keveleigh keveleigh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, pending Max's nit :)

@Zee2

Zee2 commented Dec 14, 2021

Copy link
Copy Markdown
Contributor Author

/azp run

@Zee2

Zee2 commented Dec 14, 2021

Copy link
Copy Markdown
Contributor Author

@keveleigh @MaxWang-MS should be fixed.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@keveleigh keveleigh merged commit b878636 into microsoft:releases/2.7.3 Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BoundsControl missing documentation of some properties

4 participants