search

lep / jassdoc

Document the WarCraft 3 API
52 stars 20 forks source link

Update with all documentation notes by Lucan #43

Closed Luashine closed 2 years ago

Luashine commented 2 years ago

Transferred all explanations from the well known document: "Blz native Documentation (new natives and more)" https://docs.google.com/document/d/1AjAScGNEgT8puu5rn0rdeTr2TWxSz3BIlWdcfDCUoLA/ by Lycan#7531@Discord, the permission was granted

Otherwise minor changes and adaptations where descriptions existed

I have not run the the build, please (do it for me) verify that everything's alright. Please review the changes and feedback. Finishing this the only other centralized place of documentation will be moyack's jassdoc (and of course small pieces on forums of thehelper/thehive)

I'd also like to open a discussion about style, new keywords to reduce the copy-paste burden etc... in Issues or in the Hive's topic? Discussing over at the Hive won't be a bad idea, we'd keep bumping the thread with every response :)

lep commented 2 years ago

Big thanks. I added a bunch of comments. But that's mostly style and/or technicalities. The important part is the content which you've provided a lot of. Re discussion: i don't care if we do it here or on hive.

Luashine commented 2 years ago

Thanks this was exactly what I wanted. My excuse is: 1. not knowing exactly when to use what :) 2. to develop a feeling for what a unified formatting style should be later on, since I just wanted to put all of his notes in one place for now.

I dont think to have missed anything, github collapsed 10 of your comments and I had to go over everything once again when I noticed...

Luashine commented 2 years ago

Ready to merge from me :ok_hand: