search

ThePix / QuestJS

A major re-write of Quest that is written in JavaScript and will run in the browser.
MIT License
66 stars 13 forks source link

JSDoc (not an issue) #48

Closed KVonGit closed 3 years ago

KVonGit commented 3 years ago

Hello.

Check out what I've done with JSDoc and jsdoc-to-markdown:

https://github.com/KVonGit/Item-Links-Library/wiki/Documentation

I still have lots of things to add to this, by the way.

I've created a new repo just for this library:

https://github.com/KVonGit/Item-Links-Library

The file itself: https://github.com/KVonGit/Item-Links-Library/blob/main/item_links.js

I saw you had @DOC and @UNDOC in your comments, wondered what the heck that was for, and here we are.

NOTE

Feel free to close this issue once you've read this. I started to close it as soon as I submitted this, but I wasn't sure you'd be notified of its existence that way.

KVonGit commented 3 years ago

Here's a link to the website created by JSDoc (it's easier to navigate):

http://media.textadventures.co.uk/games/xWsX6D9IyU6fRwyprp7HDA/index.html

ThePix commented 3 years ago

I actually wrote my own JSDoc-look-alike, to get it to do exactly what I wanted. https://github.com/ThePix/PixDocs

KVonGit commented 3 years ago

That one looks much easier to deal with. I'll have to check that out.

...as soon as Pertex finishes exterminating my current code. (He is keeping me quite busy at the moment. I have many instances of "thanks to Pertex" in the version changes file. Pertex is pretty damn cool.)