Mega Documentation PR#124
Conversation
… with RecipeViewerSettings#isEnabled()
that's equal to the implemented RecipeViewerSettings documentation & does not modify the behavior already specified by documentation, as it's redundant to document those.
|
@brachy84 could i get a little help with my todo comments trying to understand the code & docs? |
|
Oh sorry, i completely missed this pr |
|
|
||
| public static boolean isInside(int x, int y, int w, int h, int px, int py) { | ||
| // why does this even need a static object for a simple check? | ||
| // if at all, instances may use a shared & stateless static method |
| } | ||
|
|
||
| //TODO: explain for what SHARED is actually used for, as it has no warnings about side effects caused by | ||
| // the function above for example. |
There was a problem hiding this comment.
Originally its supposed to be a way to use an area for calculating stuff without having to create an instance. Kind of unecessary.
|
dw, the PR was in draft so far, i'm still not done, but some help along the way is appreciated trying to decipher the mix of english & german writing style ^^ |
…bout other existing code. Example: IInterpolation linear = (a, b, x) -> (a + (b - a) * x);
| } | ||
|
|
||
| /** | ||
| * Only enabled recipe viewer in synced GUIs |
There was a problem hiding this comment.
Maybe this should say what the default state actually does.
It enables recipe viewer when its not a client only screen.
There was a problem hiding this comment.
Ah, I removed documentation in that class, because it was the same as in the interface it's implementing.
But if there is a crucial detail here that's different than the expected behavior depending on implementation, then I'll re-add the documentation.
| import java.util.List; | ||
| import java.util.function.Predicate; | ||
|
|
||
| //TODO: have to come back to this |
There was a problem hiding this comment.
This is an internal class and should never be used outside this mod.
Apart from explaining why things are written the way they are in comments this shouldn't need any docs.
There was a problem hiding this comment.
I agree, but such documentation might be helpful regardless, in case MUI(2) gets another rewrite, gets optimized, or other process that would benefit from documentation. even if its just someone learning from it
|
@Dream-Master if you update my branch, please use the rebase way if possible in the future :) |
3 participants
lots of documentation, will be updated, please review once in a while :)