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.

Sign up for GitHub

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

Jump to bottom

docs: Inline Code Documentations #119

Merged
merged 16 commits into from
Dec 19, 2023
Merged

docs: Inline Code Documentations #119

merged 16 commits into from
Dec 19, 2023

Conversation

hamada147
Copy link
Contributor

@hamada147 hamada147 commented Dec 13, 2023 •
edited by jira bot
Loading

Overview

  • Wrote a lot of documentation to improve the overall docs
  • Improved Custom Exceptions to show errors
  • Added missing @JvmStatic
  • Added missing @JvmOverloads

Fixes:

Checklist

My PR contains...

  • No code changes (changes to documentation, CI, metadata, etc.)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes
  • are not breaking changes
  • If yes to above: I have updated the documentation accordingly

Documentation

  • My changes do not require a change to the project documentation
  • My changes require a change to the project documentation
  • If yes to above: I have updated the documentation accordingly

Tests

  • My changes can not or do not need to be tested
  • My changes can and should be tested by unit and/or integration tests
  • If yes to above: I have added tests to cover my changes
  • If yes to above: I have taken care to cover edge cases in my tests

@hamada147 hamada147 added the documentation Improvements or additions to documentation label Dec 13, 2023
@hamada147 hamada147 self-assigned this Dec 13, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 13, 2023 •
edited
Loading

Unit Test Results

66 tests  ±0   62 ✔️ ±0   2s ⏱️ ±0s
19 suites ±0     4 💤 ±0 
19 files   ±0     0 ❌ ±0 

Results for commit cff6c5e. ± Comparison against base commit 2b17b1b.

♻️ This comment has been updated with latest results.

@hamada147
docs: Inline Code Documentations
0077e5a 
- Wrote a lot of documentation to improve docs overall
- Improved Custom Exceptions to show errors
- Added missing @JvmStatic
- Added missing @jvmoverloads

Signed-off-by: Ahmed Moussa <[email protected]>
@atala-dev
Copy link
Contributor

atala-dev commented Dec 13, 2023 •
edited
Loading

Code Coverage

File Coverage [31.03%]
atala-prism-sdk/src/androidMain/kotlin/io/iohk/atala/prism/walletsdk/pluto/data/DbConnection.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/ApolloImpl.kt 57.14%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/config/ECConfig.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/helpers/ByteArrayExt.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/helpers/JVMBigIntegerExt.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Ed25519KeyPair.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Ed25519PrivateKey.kt 35.71%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Ed25519PublicKey.kt 38.46%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/JVMBigIntegerExt.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Secp256k1KeyPair.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Secp256k1PrivateKey.kt 50.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/Secp256k1PublicKey.kt 50.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/X25519KeyPair.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/X25519PrivateKey.kt 30.77%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/X25519PublicKey.kt 33.33%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/ec/KMMECCoordinate.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/apollo/utils/ec/KMMECPoint.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/CastorImpl.kt 38.71%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/did/DIDParser.kt 81.82%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/did/DIDUrlParser.kt 87.50%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/did/prismdid/LongFormPrismDID.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/did/prismdid/PrismDIDMethodId.kt 50.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/did/prismdid/PrismDIDPublicKey.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/resolvers/LongFormPrismDIDResolver.kt 50.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/resolvers/PeerDIDResolver.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/castor/shared/CastorShared.kt 41.63%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/logger/PrismLogger.kt 45.71%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/MercuryImpl.kt 29.81%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/forward/ForwardMessage.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/resolvers/DIDCommDIDResolver.kt 79.10%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/resolvers/DIDCommSecretsResolver.kt 15.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/resolvers/DIDCommWrapper.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/mercury/resolvers/DefaultSecretsResolverImpl.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pluto/CredentialRecovery.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pluto/PlutoImpl.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pluto/data/DbConnection.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/PolluxImpl.kt 44.88%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/AnonCredential.kt 40.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/AnoncredPayload.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/CredentialRequest.kt 15.38%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/CredentialRequestMeta.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/JWTCredential.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/JWTJsonPayload.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/KeyCorrectnessProof.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/pollux/models/W3CCredential.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/ConnectionManager.kt 27.59%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/PrismAgent.kt 54.23%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/PrismAgentError.kt 12.90%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/helpers/AttachmentDescriptorBuild.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/mediation/BasicMediatorHandler.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/ProtocolType.kt 91.67%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/connection/ConnectionAccept.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/connection/ConnectionRequest.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/connection/DIDCommConnectionRunner.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/CredentialPreview.kt 72.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/IssueCredential.kt 67.02%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/IssueCredentialProtocol.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/OfferCredential.kt 60.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/ProposeCredential.kt 66.67%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/issueCredential/RequestCredential.kt 60.98%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/mediation/MediationGrant.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/mediation/MediationKeysUpdateList.kt 79.55%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/mediation/MediationRequest.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/outOfBand/DIDCommInvitationRunner.kt 83.33%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/outOfBand/InvitationRunner.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/outOfBand/InvitationType.kt 66.67%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/outOfBand/OutOfBandParser.kt 100.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/outOfBand/PrismOnboardingInvitation.kt 33.33%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/pickup/PickupDelivery.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/pickup/PickupReceived.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/pickup/PickupRequest.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/pickup/PickupRunner.kt 93.33%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/prismOnboarding/PrismOnboardingInvitation.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/proofOfPresentation/Presentation.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/proofOfPresentation/ProposePresentation.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/protocols/proofOfPresentation/RequestPresentation.kt 0.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/shared/KeyValue.kt 75.00%
atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/shared/PrismShared.kt 0.00%
Total Project Coverage 26.10%

@petevielhaber
Update atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/wall…
a5eeca5 
…etsdk/prismagent/protocols/outOfBand/PrismOnboardingInvitation.kt
@petevielhaber
Update atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/wall…
4c1873f 
…etsdk/prismagent/protocols/prismOnboarding/PrismOnboardingInvitation.kt
@petevielhaber
Update atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/wall…
7d197b3 
…etsdk/prismagent/protocols/prismOnboarding/PrismOnboardingInvitation.kt
petevielhaber
petevielhaber requested changes Dec 13, 2023
View reviewed changes
Copy link
Contributor

@petevielhaber petevielhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Need an admonition instead of note; added suggestion for review.

hamada147 and others added 2 commits December 14, 2023 14:17
@hamada147 @petevielhaber
Update atala-prism-sdk/src/commonMain/kotlin/io/iohk/atala/prism/wall…
bd85072 
…etsdk/domain/models/VerifiableCredential.kt

Co-authored-by: Pete Vielhaber <[email protected]>
@hamada147
Merge branch 'main' into inline-docs
cff6c5e 
Signed-off-by: Ahmed Moussa <[email protected]>
@hamada147 hamada147 merged commit 55dafc2 into main Dec 19, 2023
4 checks passed
@hamada147 hamada147 deleted the inline-docs branch December 19, 2023 08:58
hamada147 added a commit that referenced this pull request May 15, 2024
@hamada147 @petevielhaber
docs: Inline Code Documentations (#119)
e1a7938 
Signed-off-by: Ahmed Moussa <[email protected]>
Co-authored-by: Pete Vielhaber <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petevielhaber petevielhaber petevielhaber approved these changes

@elribonazo elribonazo Awaiting requested review from elribonazo

@curtis-h curtis-h Awaiting requested review from curtis-h

@goncalo-frade-iohk goncalo-frade-iohk Awaiting requested review from goncalo-frade-iohk

@cristianIOHK cristianIOHK Awaiting requested review from cristianIOHK

Assignees

@hamada147 hamada147

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hamada147 @atala-dev @petevielhaber