Skip to content
This repository was archived by the owner on Aug 23, 2020. It is now read-only.

Added javadoc to API #1140

Merged
merged 7 commits into from
Nov 15, 2018
Merged

Added javadoc to API #1140

merged 7 commits into from
Nov 15, 2018

Conversation

kwek20
Copy link
Contributor

@kwek20 kwek20 commented Nov 11, 2018

Description

Updates all javadoc in the API.java class.
.md Doclet will not function properly until changes have been done on the doclet side.
This will be done after #1114

Fixes #1115

Type of fix

  • Documentation Fix

Checklist:

Please delete items that are not relevant.

  • My code follows the style guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

@jakubcech jakubcech self-requested a review November 12, 2018 10:27
@@ -13,6 +13,7 @@
import com.iota.iri.hash.SpongeFactory;
import com.iota.iri.model.Hash;
import com.iota.iri.model.HashFactory;
import com.iota.iri.model.persistables.Transaction;
Copy link
Contributor

Choose a reason for hiding this comment

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

This is because {@link} somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@GalRogozinski Yea i reference it in getTrytes, to look for a class like it in an api/library. Not really needed i guess, but seemed usefull as a reference for what the developer should look for.

@kwek20 kwek20 mentioned this pull request Nov 12, 2018
4 tasks
@alon-e alon-e added C-API Component - API C-Docs labels Nov 12, 2018
Copy link
Contributor

@alon-e alon-e left a comment

Choose a reason for hiding this comment

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

great effort! 💯
there are a lot of comments b/c there are a lot of additions.

@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@iotaledger iotaledger deleted a comment Nov 13, 2018
@kwek20
Copy link
Contributor Author

kwek20 commented Nov 13, 2018

@GalRogozinski @alon-e @jakubcech
Feedback is processed. Please respond on the still unresolved conversations :)

@jakubcech jakubcech merged commit 0088a31 into iotaledger:dev Nov 15, 2018
DyrellC pushed a commit to DyrellC/iri that referenced this pull request Nov 17, 2018
* Added javadoc to API

* Removed final, changed HashSet to Set and merged if statement

* Processed feedback, replaced all single word <code> to <tt>

* Left over changes

* Updated API with feedback

* Updated invalidSubtangleStatus
@GalRogozinski GalRogozinski mentioned this pull request Dec 22, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
C-API Component - API C-Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Service API code documentation
4 participants