First attempt at adding in-code documentation #806
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Background, font, globalinit, script, shader, sound, sprite.
- start documenting UndertaleCode - document some gms2 stuff of UndertaleRoom. - document texturepageItem - document some missing IScriptInterface methods and rename some of them. - document some missing UndertaleData properties and mehotds.
- document more in data - finish timeline - finish texturegroupinfo - finish string - finish sound - finish script - almost finish embeddedTexture - finish embeddedAudio - add a bit more in code - slight tweaks to background and animationcurve.
|
I've fixed the big issues, so it's ready for review now. |
VladiStep
requested changes
Mar 28, 2022
ngyikp
added a commit
to chicory-pizza/objCustomDog
that referenced
this pull request
Jul 31, 2022
Many breaking changes in latest bleeding-edge caused by UnderminersTeam/UndertaleModTool#806
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the first batch / attempt of adding in-code documentation.
The following has been annotated so far:
(except for a few GMS2 specific things)In addition, I also did the following changed to IScriptingInterface:
Make_New_FiletoMakeNewFile. This may break a few Scripts, I will check later if any are broken.SendAUMIMessageright into the scripting Interface.AreFilesIdenticalright into the scripting interface.IncProgress()AddProgressPandIncProgressPtoIncrementProgress,AddProgressParallelandIncrementProgressParallelrespectively. This likely breaks a few scripts, but I do not know which ones right now.SyncBinding(bool enable = false);toDisableAllBindings()StartUpdaterandStopUpdatertoStartProgressBarUpdaterandStopProgressBarUpdaterrespectively. This likely breaks a few scripts, but I do not know which ones right now.RemovePromptChooseDirectory, as it's not used in the implementations.In addition, I also added a lot of TODOs, which mostly indicate things that should still be documented before I put this PR out of Draft, but also some other structural changes that should be done.
Lastly, I also enabled it, so every public field which is undocumented shows up as a warning now.
Not related to the codebase, but somewhat to this PR. I put up a quick basic doxygen HTML render of the current documentation here, which may or may not help with reviewing:
https://miepee.github.io/UMTDoc/annotated.html