Class diagrams are missing information on fields and methods

[malcolmang]

The few class diagrams present in the Developer Guide do not contain any information on what methods and fields are contained within the class.

In general, the only information on what methods are in a class are when they are called in a sequence diagram. An overview for certain components or important classes may make it easier to understand as a developer rather than guessing at what field or methods are present in a class.

Example:

[nus-se-bot]

Team's Response

Greetings malcolmang,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) After consultations with the professor, a conscious design choice was made to remove the redundant classes from the class diagram as clutters up the diagram and does not provide any value to the UserInterface Component section.

Regards, xzynos

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: It is hard to tell what each class can do (what private/public methods do they contain? what fields?) if we just rely on sequence diagrams. As a developer, it is hard to jump in and contribute to the program if we are not given more information on the classes and what methods/fields are present. I understand the Developer Guide contains many sequence diagrams to show off implementation of logic flow, but there really isn't much in the way of describing the structure of the program and its classes, especially with relation to what fields/methods they can contain.

---