Fix inappropriate usages of xml tags in Az.Accounts #18117
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
BethanyZhou
changed the title
BethanyZhou
commented
May 12, 2022
| @@ -117,7 +117,7 @@ public void OnModuleLoad(string resourceId, string moduleName, PipelineChangeDel | |||
| /// <param name="exception">The <see cref="System.Exception" /> that is being thrown (if available)</param> | |||
| public async Task EventListener(string id, CancellationToken cancellationToken, GetEventData getEventData, SignalDelegate signal, InvocationInfo invocationInfo, string parameterSetName, string correlationId, string processRecordId, System.Exception exception) | |||
| { | |||
| /// Drain the queue of ADAL events whenever an event is fired | |||
| // Drain the queue of ADAL events whenever an event is fired | |||
There was a problem hiding this comment.
/// is a xml tag, here should be a comment
| /// <returns>A <see cref="System.String[]"/> containing the valid options for the completer.</returns> | ||
| /// <param name="resourceTypes">An <see cref="System.String"/>[] containing resource (or resource types) being completed </param > | ||
| /// <param name="parentResourceParameterNames"> An <see cref="System.String"/>[] containing list of parent resource parameter names (if applicable)</param > | ||
| /// <returns>A <see cref="System.String"/>[] containing the valid options for the completer.</returns> |
There was a problem hiding this comment.
can't find type System.String[]
| /// <remarks> | ||
| /// In PowerShell, we add on the EventDataConverter to support sending events between modules. | ||
| /// Obviously, this code would need to be duplcated on both modules. | ||
| /// This is preferable to sharing a common library, as versioning makes that problematic. | ||
| /// </remarks> | ||
| [TypeConverter(typeof(EventDataConverter))] |
There was a problem hiding this comment.
Tag should above attribute
| /// <para>invocationInfo: The <see cref="System.Management.Automation.InvocationInfo" /> from the cmdlet</para> | ||
| /// <para>correlationId: The <see cref="string" /> containing the correlation id for the cmdlet</para> | ||
| /// <para>name: The <see cref="string" /> parameter name being asked for</para> | ||
| /// </example> | ||
| public GetParameterDelegate GetParameterValue; | ||
|
|
There was a problem hiding this comment.
There are no parameters called resourceId,moduleName, etc. Move them to example block
4 tasks
wyunchi-ms
approved these changes
May 16, 2022
8 tasks
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.
Description
To resolve Azure/autorest.powershell#843
Checklist
CONTRIBUTING.mdChangeLog.mdfile(s) has been updated:ChangeLog.mdfile can be found atsrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md## Upcoming Releaseheader -- no new version header should be added