Add JSdoc comments for api wrapped functions #36
Merged
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
maneetgoyal
requested changes
Aug 31, 2021
src/api.ts
Outdated
Comment on lines
322
to
333
| * CheckINCHI | ||
| * Description: Check if the string represents valid InChI/standard InChI | ||
| * Input: takes two argument | ||
| * input - source InChI string , | ||
| * strict (optional) - if false, just briefly check for proper layout (prefix, version, etc.) | ||
| * Output: Returns code -1 , 0 , 1 , 2 , 3 , 4 | ||
| * -1: InChI is valid and non-standard | ||
| * 0: InChI is valid and standard | ||
| * 1: InChI has invalid prefix | ||
| * 2: InChI has invalid version number (not equal to 1) | ||
| * 3: InChI has invalid layout | ||
| * 4: Checking InChI through InChI2InChI either failed or produced a result which does not match the source InChI string |
There was a problem hiding this comment.
Study my last few commits and update accordingly.
Upon hovering over the function name, nicely formatted text should appear.
Example:
maneetgoyal
requested changes
Aug 31, 2021
src/api.ts
Outdated
| * - 4: Checking InChI through InChI2InChI either failed or produced a result which does not match the source InChI string | ||
| * @example | ||
| * ```ts | ||
| * const status = CheckINCHI("InChI=1S/C3H5NO/c1-2-5-3-4-1/h3H,1-2H2/p+1",false); |
There was a problem hiding this comment.
Suggested change
| * const status = CheckINCHI("InChI=1S/C3H5NO/c1-2-5-3-4-1/h3H,1-2H2/p+1",false); | |
| * const status = CheckINCHI("InChI=1S/C3H5NO/c1-2-5-3-4-1/h3H,1-2H2/p+1", false); |
src/api.ts
Outdated
| * ```ts | ||
| * const status = CheckINCHI("InChI=1S/C3H5NO/c1-2-5-3-4-1/h3H,1-2H2/p+1",false); | ||
| * console.log(status); | ||
| * //0 |
There was a problem hiding this comment.
Suggested change
| * //0 | |
| * // 0 |
src/api.ts
Outdated
| * ```ts | ||
| * const length = GetStringLength("VNWKTOKETHGBQD-UHFFFAOYSA-N"); | ||
| * console.log(length); | ||
| * //27 |
There was a problem hiding this comment.
Suggested change
| * //27 | |
| * // 27 |
src/api.ts
Outdated
Comment on lines
383
to
393
| * ```ts | ||
| * const output = GetStructFromINCHI("InChI=1S/C2H6O/c1-2-3/h3H,2H2,1H3"); | ||
| * console.log(output.status); | ||
| * //0 | ||
| * console.log(output.data.atom.x); | ||
| * //0 | ||
| * console.log(output.data.atom.y); | ||
| * //0 | ||
| * console.log(output.data.atom.z); | ||
| * //0 | ||
| * ``` |
There was a problem hiding this comment.
Handle spacing properly. (Same as previous comments)
src/api.ts
Outdated
Comment on lines
367
to
379
| * @param {object} options (optional) An object containing chosen options as key and their values as true | ||
| * @returns output is an object containing status and data | ||
| * - status - The returned code | ||
| * - data - data contains structure created from input (Inchi) string | ||
| * -- atom - Array of atom objects which contains various data like atom co-ordinates (x,y,z) , neighbor, bondType , bondStereo, elName, numBonds, numIsoh, isotopicMass, radical, charge | ||
| * -- stereo0D - array of num_stereo0D 0D stereo elements or NULL | ||
| * -- numAtoms - number of atoms in the structure | ||
| * -- numStereo0D - number of 0D stereo elements | ||
| * -- szMessage - A string containing Error/warning ASCIIZ message | ||
| * -- szLog - log-file ASCIIZ string, contains a human-readable list of recognized options and possibly an Error/warn message | ||
| * -- warningFlags - A 2d Array conataining warnings , [x][y]: | ||
| * -- x=0 => Reconnected if present in InChI otherwise Disconnected/Normal | ||
| * -- x=1 => Disconnected layer if Reconn. layer is present |
There was a problem hiding this comment.
Please post a snapshot of how it looks upon hover.
maneetgoyal
requested changes
Aug 31, 2021
src/api.ts
Outdated
Comment on lines
368
to
379
| * @returns output is an object containing status and data | ||
| * - status - The returned code | ||
| * - data - data contains structure created from input (Inchi) string | ||
| * -- atom - Array of atom objects which contains various data like atom co-ordinates (x,y,z) , neighbor, bondType , bondStereo, elName, numBonds, numIsoh, isotopicMass, radical, charge | ||
| * -- stereo0D - array of num_stereo0D 0D stereo elements or NULL | ||
| * -- numAtoms - number of atoms in the structure | ||
| * -- numStereo0D - number of 0D stereo elements | ||
| * -- szMessage - A string containing Error/warning ASCIIZ message | ||
| * -- szLog - log-file ASCIIZ string, contains a human-readable list of recognized options and possibly an Error/warn message | ||
| * -- warningFlags - A 2d Array conataining warnings , [x][y]: | ||
| * -- x=0 => Reconnected if present in InChI otherwise Disconnected/Normal | ||
| * -- x=1 => Disconnected layer if Reconn. layer is present |
There was a problem hiding this comment.
You can completely remove this comment. JSDoc style comment are processed by the TypeDoc library. TypeDoc is already aware of the various type definition so it'll auto-hyperlink the output type.
Focus more on function description and example usage. Rest should be auto-handled by TypeDoc.
maneetgoyal
approved these changes
Aug 31, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.