search

cabal-club / cabal-client

interface for writing peer-to-peer chat clients
GNU General Public License v3.0
95 stars 14 forks source link

JSDoc for `Client` and `CabalDetails` #19

Closed fenwick67 closed 4 years ago

fenwick67 commented 4 years ago

See #18

I wasn't sure about ChannelDetails since there wasn't any existing documentation on it, so I left it alone.

npm task doc will generate documentation again.

cblgh commented 4 years ago

@fenwick67 woah thank you!!

i'll leave a review in a minute

edit: you're right on leaving out channel details, that's purely an implementation detail at this point. (i mean comments inside it would be nice, but it would confuse the api documentation)

cblgh commented 4 years ago

wow that changes requested symbol looks really angry

image

fenwick67 commented 4 years ago

Cool, I'll look at each of these and see how hard it is to get them changed within jsdoc-to-markdown. At first glance I think at least some of this can be done with custom handlebars templates.

fenwick67 commented 4 years ago

Aaah I accidentally squashed too many commits. But there you go, that should resolve those issues.

cblgh commented 4 years ago

this is perfect! thank you a ton @fenwick67!!!

hackergrrl commented 4 years ago

I just realized I wasn't watching this repo.

Wow! @fenwick67! Thank you so much for the docs :heart: