Skip to content

Commit

Permalink
Add example diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
sindrehan committed Jan 21, 2025
1 parent 8c817b9 commit 3533e60
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/using-raw-protobuf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Using the Protobuf protocol directly

## Example diagram

``` mermaid
classDiagram
Person <|-- Student
Person <|-- Professor
Person : +String name
Person : +String phoneNumber
Person : +String emailAddress
Person: +purchaseParkingPass()
Address "1" <-- "0..1" Person:lives at
class Student{
+int studentNumber
+int averageMark
+isEligibleToEnrol()
+getSeminarsTaken()
}
class Professor{
+int salary
}
class Address{
+String street
+String city
+String state
+int postalCode
+String country
-validate()
+outputAsLabel()
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ nav:
- "Visualizing with Foxglove": "foxglove-bridge.md"
- "Forwarding positioning to NMEA": "nmea-publisher.md"
- "Updating from v1 to v2": "migrating-to-v2.md"
- "Using the Protobuf protocol directly": "using-raw-protobuf.md"
- "HTTP API": "http-api.html"
- Reference:
- blueye.sdk.battery: "reference/blueye/sdk/battery.md"
Expand Down

0 comments on commit 3533e60

Please sign in to comment.