Feature Request: Generate documentation in jsdoc format about tsync HOT 3 CLOSED

hey @vicero, this sounds like a good idea -- would love a PR. Here are some notes which may help:

• Here's where we write comments above the interface x line: https://github.com/Wulf/tsync/blob/main/src/main.rs#L221-L226
• Here's where we write comments above the individual fields lines: https://github.com/Wulf/tsync/blob/main/src/main.rs#L233-L238
• feel free to refactor :-)

Your example inspired these two suggestions:

• if there is only 1 comment for a field / interface, we should use a one-liner /** ..comment.. */
• if there is more than 1 comment for a field / interface, we should use a multi-line jsdoc:

  /**
  * comment 1
  * comment 2
  * ...comment N
  */
  

And regarding spaces / tabs for comments:

• we don't use modules or namespaces for the output, so you can always assume no indentation for interface lines, and 2-space indentation for field lines. Feel free to change the way we do spacing -- the suggestion for using 2-spaces for field line comments comes from here.

Oh and about testing, here's a note from the README:
Use ./test/test_all.sh to run tests. After running the test, there should be no unexpected changes to files in ./test (use git status and git diff to see if there were any changes).

from tsync.

@vicero thanks for the PR, just published 1.3.0 which should have your changes!

from tsync.

@vicero thanks for the PR, just published 1.3.0 which should have your changes!

@Wulf Thank you so much!

from tsync.