paka icon indicating copy to clipboard operation
paka copied to clipboard

Add implementation documentation

Open ShawSumma opened this issue 4 years ago • 3 comments

dext currently has little doccumentation for its implementation. a nice first file to document would be the dynamic object implementation in source/lang/dynamic.d

ShawSumma avatar Oct 12 '20 03:10 ShawSumma

This looks like a promising software suite. Need an extra hand to write some documentation? I didn't see too many comments in the source, otherwise I would have started there.

e-dant avatar Jan 09 '22 10:01 e-dant

I would love a hand in documentation. Comments need to be written first and foremost. I try to keep the source as readable as possible, but i worry it is getting lost.

ShawSumma avatar Jan 09 '22 21:01 ShawSumma

I'm eager to begin using this repo for myself — It's fascinating — but I just don't know where to start.

My impression is that the best place to start is with a general overview of the language and the programming interface. IIRC there's a repo for the language used here; perhaps some of this can be taken from that repo.

Once comments are added and whatnot, wouldn't it be easier to run Doxygen over it?

e-dant avatar Jan 18 '22 21:01 e-dant