Code Documentation about os.js HOT 12 CLOSED

@RyanRiffle As you can see above I have started on the documentation. Just thought I would give you a heads' up if you were going to check out the VFS (some minor changes also, but for the better)

from os.js.

Awesome Thanks! I will check it out.

from os.js.

@RyanRiffle I have created a simple parser for the code documentation. Not anywhere near finished, but it's a good start. What do you think ? :)

http://andersevenrud.github.io/OS.js-v2/documentation/

from os.js.

@andersevenrud Honestly it is a major relief just to have the function declarations easy to find, even if they do not have a description. It's looking good. I still need to try and help some with that. I'll look tomorrow, its bed time for me.

from os.js.

@RyanRiffle Yeah. It really does make a huge difference!

I just uploaded the latest generation of docs, so check it out tomorrow. It looks a bit better now and texts should be a lot clearer 😄

Same here, man. Way past my bedtime, hehe.

from os.js.

I'm looking forward to this being flushed out because I just went to fix a minor typographical error and couldn't even find the element it's in (or the bug itself) in source.

The error, by the way, is on the GUITest > DnD screen where it says "Drag and drop [an] element"

from os.js.

@MrSchism What do you mean?

GUITest is an application and can be found in src/packages.

from os.js.

@MrSchism Also, "GUITest" is an external package in https://github.com/andersevenrud/OS.js-v2-expermiments

from os.js.

Noted and fixed in a PR. (os-js/OS.js-experimental#1)

from os.js.

Closing the issue because most of this is now mostly automated and taken care of (Except maybe the servers, but they use the same HTTP methods and that is all documented)

from os.js.

Reopened because I'm rewriting documentation into JSDoc and completely ditching the custom system

from os.js.

Seeing now that all the old documentation has been converted 100%; I'm closing this issue again. It went a lot faster than first estimated. Any more updates will be made silently by commits :)

from os.js.