manoelcampos
commented
8 years ago - The complete documentation of all 12 CloudSim packages was updated in order to improve clarity and to avoid confusion and ambiguity. It was performed a meticulous reading of the existing documentation to make the documentation a reflection of the code. Several times when the existing documentation wasn't effective in explaining the goal of a given class, method, attribute or parameter, the code was studied in order to provide a clear and comprehensive documentation.
- Sometimes the documentation of classes, methods and attributes were not precise or lacked important details that could be understood only after reading the code. The documentation was improved in order to avoid these problems.
- In several classes, the documentation of attributes and parameters just included the names of the parameters/attributes themselves, without actually explaining their goals. The documentation was updated to try explaining the exact goal of these elements. Usually, documentation of parameters related to existing attributes weren't updated.
- Redundant documentation was removed in order to avoid updating one and forgetting to update the other, what happens for sub classes that copy the exact documentation from the super class.
- A complete overview of performed changes can be seen in the log of all 15 commits in this pull request. I think that such changes are strong contributions to the project and can help several users to better understand how the simulator works.
- Several @todo annotations were included throughout the project's code, pointing possible bugs, strange identifier names, suspicious code, tips in order to improve the code and a lot of things to be performed in the second phase of the planned contribution.