Andras/BoundlessFlowCampus2K

Fork 0

894-tempservice-class-diagram #956

Closed

a23timgu wants to merge 4 commits from 894-tempservice-class-diagram into team_1_week_6

a23timgu commented

2026-05-13 14:25:50 +00:00

Collaborator

Class diagram for tempService.

I have also researched a way to more-or-less automatically generate class diagrams straight from our .cs files, which is how this class diagram was made.

It requires two plugins (CSharp to PlantUML and PlantUML), then you simply run a command to generate diagrams, and then you make a small edit to one of the generated .puml files. This manual edit will most likely only need to be done once per service component.
(eg. once for readTempSensorMockup, once for tempService and once for generateMockup)

The PlantUML extension allows live-previewing as you're editing the .puml files and supports exporting the diagrams as .svg files.

With this method, the diagrams will be stored directly in the repo so there will be no need to look around the wiki or issues to find them when needed.

I will write full instructions for how to use this on the wiki in a separate issue, but I will refer to the PlantUML website for the PlantUML documentation for now. They are very easy to understand.

Class diagram for tempService. I have also researched a way to more-or-less automatically generate class diagrams straight from our .cs files, which is how this class diagram was made. It requires two plugins (**CSharp to PlantUML** and **PlantUML**), then you simply run a command to generate diagrams, and then you make a small edit to one of the generated .puml files. This manual edit will most likely only need to be done once per service component. (eg. once for **readTempSensorMockup**, once for **tempService** and once for **generateMockup**) The PlantUML extension allows live-previewing as you're editing the .puml files and supports exporting the diagrams as .svg files. With this method, the diagrams will be stored directly in the repo so there will be no need to look around the wiki or issues to find them when needed. I will write full instructions for how to use this on the wiki in a separate issue, but I will refer to the [PlantUML website](https://plantuml.com/class-diagram) for the PlantUML documentation for now. They are _very_ easy to understand.

a23timgu added the

project documentation

Team 1

research

labels

2026-05-13 14:25:50 +00:00

a23timgu added 4 commits

2026-05-13 14:25:50 +00:00

Initial set up of folder structure for class diagram .puml source files bfb59ae84f

Next up is seeing if this process can be improved and standardized

Updated "include.puml" to now be a more-or-less complete diagram b1aa767a59

By using the "CSharp to PlantUML" extension to generate .puml files from our .cs files and then a small manual edit in include.puml (as seen in this commit), I have a finished UML class diagram created directly from our source files.

This include.puml can be exported as a .svg or .png by using the PlantUML extension. (See attached .svg for the result)

We might want to add the "out" folder to our .gitignore if the .svg files are too big or the folders get messy, though.

Just some more experimenting with PlantUML diagrams f570b8f874

Merge remote-tracking branch 'origin/team_1_week_6' into 894-tempservice-class-diagram 542cb00c10

a22erigr

2026-05-15 07:35:33 +00:00

added the
Under-review
label
requested review from a24hamrh

a24hamrh approved these changes

2026-05-15 08:48:25 +00:00

a24hamrh left a comment

Collaborator

Review on #956

Whats done

Tested on Windows 11 using Firefox

App starts
- Looked at include.svg diagrams.

Inspected following files:

include.svg include.pml
DatabaseQueries.puml
IdatabaseQueries.puml
TempEndpoints.puml
TempData.puml
TempResponse.puml
Program.puml
ITempService.puml
TempService.puml
All inspected fiels
- Indentation/code styling
  - Indentation is ok
- Naming convention
  - Naming convention is followed
- Comments
  - There is almost no comments.
- General code quality
  - The general code quality is good

Conclusion

The code looks fine and the app starts.
Include.svg looks good.

# Review on #956 ## Whats done ### Tested on Windows 11 using Firefox + App starts + Looked at include.svg diagrams. ### Inspected following files: + include.svg include.pml + DatabaseQueries.puml + IdatabaseQueries.puml + TempEndpoints.puml + TempData.puml + TempResponse.puml + Program.puml + ITempService.puml + TempService.puml + All inspected fiels + Indentation/code styling + Indentation is ok + Naming convention + Naming convention is followed + Comments + There is almost no comments. + General code quality + The general code quality is good ## Conclusion + The code looks fine and the app starts. + Include.svg looks good.

a24hamrh added

reviewed

and removed

Under-review

labels

2026-05-15 08:49:09 +00:00

a23timgu referenced this pull request

2026-05-15 19:01:53 +00:00

Wiki article on how to generate PlantUML Class Diagrams #979

c24danli commented

2026-05-18 10:42:58 +00:00

Collaborator

After talk with customer have decided to be conservative with witch models we need and will use. So this issue will not be merged. As an PR is made you will still get the contributions for the work and if we decide to expand the model coverage we can always go back to the PR and open it up again.