nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Sequence diagram class not destroyed #2252

Open nus-se-script opened 2 months ago

nus-se-script commented 2 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Some of the sequence diagram have classes which are not destroyed after no longer in use / in the end, which is using symbol "x".

image.png


[original: nus-cs2113-AY2324S2/pe-interim#2050] [original labels: severity.Low type.DocumentationBug]

tannerlie commented 2 months ago

Team's Response

Screenshot 2024-04-20 at 6.38.27 PM.png It is stated that "you can use the object deletion notation to indicate the point at which the object becomes ready to be garbage-collected" meaning that it is not compulsory to indicate when the class will no longer be referenced. Even more so for a language like Java which does not support a delete operation. Regardless, the classes here are of a common class that was not created solely for this use case but were instead created elsewhere to be referenced by many classes in different use cases, hence it would not be destroyed as it would still be used by other Classes until the game ends.

Duplicate status (if any):

--