Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where to put CreateUnitWithoutShadow. #130

Open
lep opened this issue Jan 31, 2024 · 3 comments
Open

Where to put CreateUnitWithoutShadow. #130

lep opened this issue Jan 31, 2024 · 3 comments

Comments

@lep
Copy link
Owner

lep commented Jan 31, 2024

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
Copy link
Owner Author

lep commented Feb 26, 2024

Added it to CreateUnit. db83a86

@lep lep closed this as completed Feb 26, 2024
@Luashine
Copy link
Collaborator

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"?

@Luashine Luashine reopened this Mar 10, 2024
@lep
Copy link
Owner Author

lep commented Mar 10, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants