Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xml style comments for PhoneNumberUtil #102

Merged
merged 1 commit into from
May 10, 2019
Merged

xml style comments for PhoneNumberUtil #102

merged 1 commit into from
May 10, 2019

Conversation

mcdon-ron
Copy link
Contributor

Changed some javadoc style comments to c# xml style comments for PhoneNumberUtil, and set project to generate xml help file. The comments should now show up in intellisense. There's an issue with enabling XML documentation file in the project options where it set's an absolute file path. The recommendation form https://developercommunity.visualstudio.com/content/problem/319886/default-xml-documentation-file-path-is-absolute.html was to set GenerateDocumentationFile to true in the project.

…eNumberUtil, and set project to generate xml help file. The comments should now show up in intellisense. There's an issue with enabling XML documentation file in the project options where it set's an absolute file path. The recommendation form https://developercommunity.visualstudio.com/content/problem/319886/default-xml-documentation-file-path-is-absolute.html was to set GenerateDocumentationFile to true in the project.
@codecov-io
Copy link

Codecov Report

Merging #102 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #102   +/-   ##
=======================================
  Coverage   92.59%   92.59%           
=======================================
  Files          26       26           
  Lines        3201     3201           
=======================================
  Hits         2964     2964           
  Misses        237      237
Impacted Files Coverage Δ
csharp/PhoneNumbers/PhoneNumberUtil.cs 90.62% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2dfd5cd...6f9af87. Read the comment docs.

@twcclegg
Copy link
Owner

Thanks! Is this something you did by hand or were do you have a tool that does it? A step to addressing #60

@twcclegg twcclegg merged commit 055eeba into twcclegg:master May 10, 2019
@mcdon-ron
Copy link
Contributor Author

I did it by hand. I don't know of a tool to automate conversion of the comments :(.

@mcdon-ron mcdon-ron deleted the PhoneNumberUtil-xml-comments branch May 13, 2019 18:33
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