Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

Runtime api docs #2494

Merged
merged 8 commits into from
Nov 1, 2017
Merged

Conversation

mbwhite
Copy link
Contributor

@mbwhite mbwhite commented Oct 30, 2017

Main areas of change here

  1. javascriptparser.js
    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 +

  1. 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.

  2. 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.

  3. Added in a module/class index that lists the modules and short description.
    Added links to these at the top of the pages.

  4. That's it. oh and it fixes #2325

winslet
winslet previously approved these changes Oct 30, 2017
Copy link
Contributor

@winslet winslet left a 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.

@mbwhite
Copy link
Contributor Author

mbwhite commented Oct 30, 2017

@sstone1 @EdProsser What I didn't spot was that now links are working, in the sense of creating hyperlinks. there are lots of places in the jsdoc where the format of links isn't quite right... What are your views on fixing as part of this or doing it in a separate PR?

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>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
Copy link
Contributor

@sstone1 sstone1 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@nklincoln nklincoln merged commit 81afd3a into hyperledger-archives:master Nov 1, 2017
@mbwhite mbwhite deleted the runtime-api-docs branch November 3, 2017 15:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

composer runtime API documentation is missing as of 2017/Oct/10th
4 participants