Andras/BoundlessFlowCampus2K
4
7
Fork 0
Code Issues 90 Pull requests 7 Projects Releases Packages Wiki Activity Actions

894-tempservice-class-diagram #956

Closed
a23timgu wants to merge 4 commits from 894-tempservice-class-diagram into team_1_week_6
pull from: 894-tempservice-class-diagram
merge into: Andras:team_1_week_6
Conversation 2 Commits 4 Files changed 10 +93
a23timgu commented 2026-05-13 14:25:50 +00:00
Collaborator
Copy link

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.
Next up is seeing if this process can be improved and standardized
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.
a24hamrh approved these changes 2026-05-15 08:48:25 +00:00
a24hamrh left a comment
Collaborator
Copy link

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.
c24danli commented 2026-05-18 10:42:58 +00:00
Collaborator
Copy link

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.

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.
c24danli closed this pull request 2026-05-18 10:43:51 +00:00

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
Reviewers
No reviewers
a24hamrh
Labels
Clear labels   
_CRITICAL_

Only use this label for critical tasks that are project-scope,and must be addressed ASAP.

  
API

   
app

   
backEnd

   
Blocked, waiting for further changes

   
bug

Something is not working

  
cleanup

Issues to cleanup the codebase (restructure folders, remove deprecated or smelly code)

  
close

Issue to close

  
design

   
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
feature request

   
frontEnd

   
help wanted

Need some help

  
invalid

Something is wrong

  
low priority

   
needs input

Issue needs input from product owner or customer

  
needs review

issue is in need of review

  
project documentation

   
question

More information is needed

  
research

   
reviewed

This Issue has been reviewed

  
script

   
security

use this for security-related issues

  
SQL

  
style

   
testing

   
topLevel

Reserved for top-level, project-wide issues.

  
wontfix

This won't be fixed

No labels
_CRITICAL_
API
app
backEnd
Blocked, waiting for further changes
bug
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
help wanted
invalid
low priority
needs input
needs review
project documentation
question
research
reviewed
script
security
SQL
style
testing
topLevel
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K!956
No description provided.