Skip to content

wuapi: IUpdate: setter and getter param and retval info, slight corrections - #2194

Open
Ondřej Hošek (RavuAlHemio) wants to merge 6 commits into
MicrosoftDocs:docsfrom
RavuAlHemio:wuapi-iupdate-params-retval
Open

Ondřej Hošek (RavuAlHemio) wants to merge 6 commits into
MicrosoftDocs:docsfrom
RavuAlHemio:wuapi-iupdate-params-retval

Conversation

@RavuAlHemio

Copy link
Copy Markdown
Contributor

I hope that the commit messages shed some light on my reasoning.

My primary concern was linking from a getter such as IUpdate::get_DownloadPriority to its enum type (DownloadPriority in this case), since I sorely missed these when navigating the Windows Update API docs, but I made a few more changes.

Link to the relevant data type if an article exists; for data types mostly
used in conjunction with VARIANT, link to VARIANT under "see also" instead.
Also link to SysFreeString for BSTR values.

The most direct benefit is the link to enum types like DeploymentAction or
DownloadPriority.
Since AcceptEula is an action that can only be taken in one direction, it
makes sense for it to be its own method instead of an EulaAccepted setter,
but the two should still be cross-linked.
@prmerger-automator

Copy link
Copy Markdown

Ondřej Hošek (@RavuAlHemio) : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

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.

LGTM — accurate technical correction. Approved.

@GrantMeStrength

Copy link
Copy Markdown
Contributor

Copilot /review

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.

Reviewed ✅ — Documentation improvement looks good.

@prmerger-automator

Copy link
Copy Markdown

Ondřej Hošek (@RavuAlHemio) : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. drew batchelor (@drewbatgit)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants