tool-suite-X
tool-suite-X copied to clipboard
Document Injected JavaScript
Document the Injected JavaScript interfaces for Tables and Survey.
From the 2019 convening: https://docs.google.com/document/d/1_4x9x3eHxo4qevBRlpmCC9L2bVlUkAQuAlidT8wJDzI/edit#heading=h.264josm5lg7
odkcommon has been documented. still need odkdata documented as well as the individual tables and survey special objects.
I think this might be done? There is at least progress here: https://docs.odk-x.org/injected-interfaces/?highlight=injected#odkdata-js and thereafter, although the survey and tables ones are a bit short, but not sure if there is more to add.
we have only fully documented 1 of the 4 injected objects.
Hi all, can I work on this?
@iamks you can work on this but this is a large issue. You need to look at the code and there are lots of functions to document. The comments that describe the function will give you a good place to start.
An example of one of the files is done: https://docs.odk-x.org/injected-interfaces/?highlight=injected#list-of-available-methods-in-odkcommon-js
Remaining JavaScript files that are "injected"/available in the ODK-X Webkit that need documentation are:
@iamks you can work on this but this is a large issue. You need to look at the code and there are lots of functions to document. The comments that describe the function will give you a good place to start.
An example of one of the files is done: https://docs.odk-x.org/injected-interfaces/?highlight=injected#list-of-available-methods-in-odkcommon-js
Remaining JavaScript files that are "injected"/available in the ODK-X Webkit that need documentation are:
Hi @wbrunette @elmps2018 am interested in this. Can I take it up please??
@permission-error you are welcome to work no the issue.