Merged
Conversation
Collaborator
Author
|
@ahoefling take a look at this and let me know what changes you would like made! |
SkyeHoefling
reviewed
Jan 6, 2022
Contributor
SkyeHoefling
left a comment
SkyeHoefling
left a comment
There was a problem hiding this comment.
This looks good to me, I have a few notes that I would like you to review. We don't need to add all of these changes, but take a look and we can go from there.
| /// </returns> | ||
| /// <exception cref="HeifException"> | ||
| /// If an error occurs during retrieving the embedded thumbnail, an exception will be | ||
| /// thrown which contains an error code explaining the problem. |
Contributor
There was a problem hiding this comment.
Can you use <see cref="" /> to link to the error code object
Collaborator
Author
There was a problem hiding this comment.
@ahoefling I THINK the code I have SHOULD work per MS. BUT I can change it if desired: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#exception
Contributor
There was a problem hiding this comment.
Oh 🤦♂️ I wasn't clear I what I wanted. The <exception> tag is correct and looks good to me. I want you to look at changing line 19 to something like this
Suggested change
| /// thrown which contains an error code explaining the problem. | |
| /// thrown which contains a <see cref="HeifException.Error" /> explaining the problem. |
| /// </returns> | ||
| /// <exception cref="HeifException"> | ||
| /// If an error occurs during retrieving the image, an exception will be | ||
| /// thrown which contains an error code explaining the problem. |
Contributor
There was a problem hiding this comment.
Can you use to link to the error code object
Changing wording to better reflect what the interface represents.
Updating documentation to have a see link
Benchmark ComparisonBenchmarking comparison between this Pull Request and the comitted values at benchmarks/results thumbnail
Welcome to .NET 5.0!
---------------------
SDK Version: 5.0.404
Telemetry
---------
The .NET tools collect usage data in order to help us improve your experience. It is collected by Microsoft and shared with the community. You can opt-out of telemetry by setting the DOTNET_CLI_TELEMETRY_OPTOUT environment variable to '1' or 'true' using your favorite shell.
Read more about .NET CLI Tools telemetry: https://aka.ms/dotnet-cli-telemetry
----------------
Installed an ASP.NET Core HTTPS development certificate.
To trust the certificate run 'dotnet dev-certs https --trust' (Windows and macOS only).
Learn about HTTPS: https://aka.ms/dotnet-https
----------------
Write your first app: https://aka.ms/dotnet-hello-world
Find out what's new: https://aka.ms/dotnet-whats-new
Explore documentation: https://aka.ms/dotnet-docs
Report issues and find source on GitHub: https://github.com/dotnet/core
Use 'dotnet --help' to see available commands or visit: https://aka.ms/dotnet-cli
--------------------------------------------------------------------------------------
No differences found between the benchmark results with threshold 10%.
primary No differences found between the benchmark results with threshold 10%.
Benchmark Resultsthumbnail
BenchmarkDotNet=v0.13.0, OS=Windows 10.0.17763.2366 (1809/October2018Update/Redstone5)
Intel Xeon Platinum 8272CL CPU 2.60GHz, 1 CPU, 2 logical and 2 physical cores
.NET SDK=5.0.404
[Host] : .NET 5.0.13 (5.0.1321.56516), X64 RyuJIT
Job-PTEBQM : .NET 5.0.13 (5.0.1321.56516), X64 RyuJIT
Runtime=.NET 5.0 InvocationCount=1 LaunchCount=1
UnrollFactor=1
primary
BenchmarkDotNet=v0.13.0, OS=Windows 10.0.17763.2366 (1809/October2018Update/Redstone5)
Intel Xeon CPU E5-2673 v4 2.30GHz, 1 CPU, 2 logical and 2 physical cores
.NET SDK=5.0.404
[Host] : .NET 5.0.13 (5.0.1321.56516), X64 RyuJIT
Job-MASDTQ : .NET 5.0.13 (5.0.1321.56516), X64 RyuJIT
Runtime=.NET 5.0 InvocationCount=1 LaunchCount=1
UnrollFactor=1
|
SkyeHoefling
approved these changes
Jan 6, 2022
Contributor
SkyeHoefling
left a comment
SkyeHoefling
left a comment
There was a problem hiding this comment.
Everything looks good to me, thanks for the contribution
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes: #22
Description
Adding XML Documentation to the APIs
Merge Checklist