search

lep / jassdoc

Document the WarCraft 3 API
52 stars 20 forks source link

Where to put `CreateUnitWithoutShadow`. #130

Open lep opened 7 months ago

lep commented 7 months ago

Looking at this thread i was looking for this function in jassdoc but i couldn't find it. Now next time i do want to find it in jassdoc, so i ask myself where such a function should be documented at? CreateUnit, CreateImage and DestroyImage seem like good candidates.

Now of course that's under the premise that it still works))

lep commented 6 months ago

Added it to CreateUnit. db83a86fdc507e52da2e9cf8b265eaf6da482325

Luashine commented 6 months ago

Sorry I didn't reply. How about a separate file where we could include those functions fully. Like CreateUnitWithoutShadow, or the downcasting, maybe even Memhack primitives (this could deserve its own). I find the comments you made there too short, because they had to fit into a foreign function's comment.

The web world has .well-known address, sounds too nerdy? "custom.j" is too generic imho. Maybe "community.j"?

lep commented 6 months ago

Another .j file is an interesting idea. But i don't know if it fits the scope of jassdoc. There are plenty of systems and snippets on hive and other sites and this cannot incorporate them all. I think i included the whole function instead of simply linking to it, because the linked function makes some assumptions which are not general (like using some globals, hiding the shadow by default, etc.) and i wanted to give some more insight. I think CreateUnit wasn't the worst spot because CreateUnit is overall very important in map making so it should probably accumulate much documentation. To be honest, i would also be fine just linking to it, but that of course has problems aswell.