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

Adds xml comment documentation #122

Merged
merged 4 commits into from
Oct 2, 2019
Merged

Conversation

CodeTherapist
Copy link
Contributor

No description provided.

@CodeTherapist
Copy link
Contributor Author

CodeTherapist commented Sep 3, 2019

@aseigler: Let me know, whether this goes in the right direction - then I would continue. Any help or suggestions would be appreciated.

Closes #121

@aseigler
Copy link
Collaborator

aseigler commented Sep 4, 2019

@aseigler: Let me know, whether this goes in the right direction - then I would continue. Any help or suggestions would be appreciated.
Closes #121

Love it!

@abergs
Copy link
Collaborator

abergs commented Sep 22, 2019

@CodeTherapist I like this. Are you finishing up any changes or should we go ahead and mark this as ready and add more documentation iteratively?

* Moves types into separeted files but preserve namespace (no breaking change).
* Renmes Configuration.cs to Fido2Configration.cs to match type name.
* XML docs for IMetadataService as well.
@CodeTherapist CodeTherapist marked this pull request as ready for review September 25, 2019 11:45
@CodeTherapist
Copy link
Contributor Author

CodeTherapist commented Sep 25, 2019

I noticed the following things, while documenting:

I would like to be complete and thoroughly as possible. Let me know what I should do with the above mentioned types, properties etc. Any help is as always appreciated.

@CodeTherapist CodeTherapist changed the title WIP: Adds xml comment documentation Adds xml comment documentation Sep 26, 2019
@aseigler
Copy link
Collaborator

Most of the things you could not find are in:
https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-service-v2.0-rd-20180702.pdf

The MetadataStatement.Hash is what is described here: https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-service-v2.0-rd-20180702.html#metadata-toc-object-processing-rules, step 6, sub-step 4. It is the computed hash value of the metadata statement that we compare to what we found in the TOC. It is likely that this will be refactored out at some point, this was really included just to get the service functional and passing the conformance tests.

Thanks for your help!

@CodeTherapist
Copy link
Contributor Author

CodeTherapist commented Sep 30, 2019

@aseigler Thanks for the help. Looks like I was using the previous version of that document - that is why I didn't find all of the properties... 🙄

Even when it's likely to be refactored (the hash property), as long as it's there I will document it. I could add under remarks that this will maybe moved away. Later versions could mark the property as obsolete etc.

I will finish this and resolve the conflicts.

@aseigler aseigler merged commit a87081c into passwordless-lib:master Oct 2, 2019
@aseigler
Copy link
Collaborator

aseigler commented Oct 2, 2019

Thank you!

@abergs abergs added the documentation Documentation, comments, guides, info etc. label May 28, 2020
@abergs abergs mentioned this pull request May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, comments, guides, info etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants