This repository has been archived by the owner on Mar 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 723
Runtime api docs #2494
Merged
nklincoln
merged 8 commits into
hyperledger-archives:master
from
mbwhite:runtime-api-docs
Nov 1, 2017
Merged
Runtime api docs #2494
nklincoln
merged 8 commits into
hyperledger-archives:master
from
mbwhite:runtime-api-docs
Nov 1, 2017
Conversation
This file contains 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
mbwhite
force-pushed
the
runtime-api-docs
branch
from
October 30, 2017 09:18
b7ef762
to
ba49982
Compare
winslet
previously approved these changes
Oct 30, 2017
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix seems to be in for the overrunning lines which is great. LGTM from a design standpoint.
Updating the files atm |
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
mbwhite
force-pushed
the
runtime-api-docs
branch
from
October 31, 2017 14:29
930c8f6
to
f8ccf85
Compare
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
sstone1
approved these changes
Nov 1, 2017
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Main areas of change here
To make this understand the runtime api properly had to do some work to correct how it saw function statements as well as function delcarations.
This also meant that the
findcomment
logic had to be updated - and this was moved to work on line basis, rather that token position.1a) As part of this the javascrtip parser had to be updated to understand the difference between @Protected and @public. This means that the syntax of the apiref changelog.txt marks protected methods as ~ not +
Minor updates to the class template. noteably, that the heading for the methods does not have the parameters. The html id for the headings is autogenerated, and with the full prototype in it, it wasn't possible to correctly link from other parts of the docs.
Linkage from the other parts of the docs works but the link statements need to be of the form {@link module-class[#optionalfn] } For POC have modified some of these. But there are other issues for updating comments and API docs.
Added in a module/class index that lists the modules and short description.
Added links to these at the top of the pages.
That's it. oh and it fixes #2325