chore: add comments documenting public API

[abhishekgite446]

Addressing Issue 76

Adding comment using JSDoc for the function runFromCommandLine and replacing undocumented comments in etc/fiddle-core.api.md using yarn docs

[abhishekgite446]

Hi @dsanders11, apologies that I had to close my previous commit due to a git issue. Opening this new PR to address Issue 76. I have only update the description for the function runFromCommandLine for now, can you please have a look ?

[dsanders11]

It seems unnecessary to bump the version of @microsoft/api-extractor? The changes to etc/fiddle-core.api.md are also not included in these changes (which causes the workflow failure). Also, the comment shouldn't mention runFromCommandLine, and doesn't currently pass lint.

[abhishekgite446]

Thanks for having a look @dsanders11. I guess pushed the changes in a rush. Thanks a lot for spotting everything, I have addressed all the issues you have raised previously. Can you please have a look when you get time :)

[abhishekgite446]

Just so that you are aware, the only reason I bumped the version for @microsoft/api-extractor because I saw the following message when I executed yarn docs. Nevertheless the version bump was not required in the first place.

[abhishekgite446]

@dsanders11 when you get time can you please have a look :)

[dsanders11]

The changes in yarn.lock are leftover from the previous package.json change and need to be dropped from this PR.

[abhishekgite446]

@dsanders11 as suggested made all changes. Please have a look at your convenience.

[dsanders11]

Let's avoid starting the comments with wordings like "Represents", "Overrides", "This method", "This object" and "This function". I'd say avoid the usage of "represents" all together, similarly with "it" and "this" when possible.

For getter methods (like those in src/versions.ts) drop the starting "Gets", document it like it's a variable, rather than a method.

[abhishekgite446]

@dsanders11 as suggested I have amended the comments, please have a look at your convenience 👍