1119 specify method return type in class diagram

[jgreywolf]

📑 Summary

Updated ClassRenderer to check for [] to indicate return type for method. Small refactor to split out logic for determining method display text and style. Updated documentation

Resolves #1119

📏 Design Decisions

Still using existence of ) to determine if member is a method, but using regex to parse out method text into discrete elements (visibility, method name, parameters, classifier and return type)

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added unit/e2e tests (if appropriate)
• 🔖 targeted develop branch

[klemmchr]

I don't know if the bracket syntax is really helping to keep the syntax plain. I think I would prefer to write a normal UML syntax and have a regex classify whether this member is a field or a method. If we use brackets, we could end up with broken diagrams.

[jgreywolf]

I don't know if the bracket syntax is really helping to keep the syntax plain. I think I would prefer to write a normal UML syntax and have a regex classify whether this member is a field or a method. If we use brackets, we could end up with broken diagrams.

I suppose if we just stick with a regular UML syntax, then really we dont need to do anything at all, yes? As long as the user understands this and defines their methods accordingly. Explicitly add : RETURNTYPE to the end of their method statement (or some other format), since we just display whatever is typed in at that point...

Or to go with regex, we could just have it that the pattern is like:

[**VISIBILITY**]methodName([**PARAMETER**])[**CLARIFIER**] [**RETURNTYPE**]

which would display as something like: +methodName(int id) : int(assuming [CLARIFIER] set to static)

[jgreywolf]

After some consideration and playing around, I decided to go ahead and go with the idea of parsing out the text via regex. If for some reason the regex match function fails it will "fallback" to existing functionality of displaying the method as it was typed in.

[jgreywolf]

Force pushed new version due to some oddities in merge from develop.