This repository has been archived by the owner on Aug 23, 2023. It is now read-only.
Refactoring Javadoc and methods/variables names. #29
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
…his refactoring, the following modifications were performed: - Two inner classes were extracted from the class. - Some variable were renamed to follow programming patterns.
… refactoring, the following modifications were performed: - One inner class was extracted from the class. - Some variable and methods were renamed to follow programming patterns.
…thods were renamed according to programming patterns.
… javadoc of the methods were filled and improved.
…refactoring, the following modifications were performed: - The methods parameters were renamed. - The javadoc was completed with the documentation for the parameters.
…oring, the following modifications were performed: - The methods of the inner class Component were renamed. - The variable allMoeLogger was renamed to ALL_MOE_LOGGER, once it is a constant. - The javadoc was complemented.
…renamed to have a verb.
…umentation was updated and one comment for a video from youtube was removed.
…he parameter 'ui' was renamed to messenger and the documentation for this parameter was added to the javadoc.
…as added to the javadoc of the method reportTo and this same method had the parameter name changed.
…te inner class Sink.
…od parameters to more appropriate names.
…eters to more appropriate names.
…s and had their parameters renamed. Also, javadoc documentation was added to the class. Moving the inner class Task out of the Ui class.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Hello MOE team,
I performed a some changes in MOE project as a project for my course of Software Maintenance at Milwaukee School of Engineering. These changes were more related to adding and fixing Javadoc comments to the methods where it was missing/outdated. Also, I performed some refactoring in the code related to renaming methods and variables that was not with clear names. Beside that changes, I also extracted few inner classes from some classes. All these changes were performed using Netbeans IDE 8.1 refactoring tools. Therefore, I believe that no problems were created due to my refactoring activities.
I hope you accept my changes and they are useful for the project.
Thank you.