aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-10-05 15:00:41 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-10-05 15:00:41 +0200
commit523793d0fa64acbb9a04403a5c6054941a5296d0 (patch)
tree3486453b7e5674ee4b379d272761d4e902a11aa9
parent335263ef72338ae7d976b1eb8972e5ef10a0203b (diff)
cleanup + sync design with crepe `loek/audio` source branch
-rw-r--r--img/facade-audio.puml23
-rw-r--r--img/theme.ipuml17
-rw-r--r--latexmkrc2
-rw-r--r--projdoc.cls2
-rw-r--r--time.txt1
5 files changed, 29 insertions, 16 deletions
diff --git a/img/facade-audio.puml b/img/facade-audio.puml
index 6749915..60af60f 100644
--- a/img/facade-audio.puml
+++ b/img/facade-audio.puml
@@ -2,14 +2,11 @@
!include theme.ipuml
skinparam Linetype ortho
-
package crepe {
- package api {
- class Resource <<irrelevant>>
- }
+ class Asset <<irrelevant>>
class Sound {
- +Sound(resource)
+ +Sound(asset)
--
+pause()
+play()
@@ -20,7 +17,7 @@ package crepe {
-sample : SoLoud::Wav
-handle : SoLoud::handle
--
- -load(resource)
+ -load(asset)
}
class SoundContext <<Singleton>> {
@@ -31,6 +28,11 @@ package crepe {
--
-engine : SoLoud::Soloud
}
+
+ Sound .> SoundContext
+ SoundContext .> Sound
+
+ Sound .left> Asset
}
package SoLoud {
@@ -38,15 +40,10 @@ package SoLoud {
class Wav <<irrelevant>>
}
-' layout
-crepe -[hidden]down- SoLoud
-
crepe.Sound --> SoLoud.Wav
crepe.SoundContext --> SoLoud.Soloud
-crepe.Sound .> crepe.SoundContext
-crepe.SoundContext .> crepe.Sound
-
-crepe.Sound .> crepe.api.Resource
+' LAYOUT
+crepe -[hidden]down- SoLoud
@enduml
diff --git a/img/theme.ipuml b/img/theme.ipuml
index f716ddf..ae3b1c7 100644
--- a/img/theme.ipuml
+++ b/img/theme.ipuml
@@ -1,13 +1,26 @@
+' vim:ft=plantuml
+
!theme plain
skinparam ClassAttributeIconSize 0
skinparam ClassFontStyle bold
skinparam DefaultFontName Inter
-skinparam DefaultFontSize 14
+skinparam DefaultFontSize 10
skinparam MaxMessageSize 200
skinparam Nodesep 25
-skinparam Padding 2
+' skinparam Padding 0
skinparam Ranksep 50
skinparam RoundCorner 0
+skinparam PackageStyle rectangle
+skinparam PackageFontStyle italic
+
+hide class circle
+' class <<irrelevant>> for third-party classes
hide <<irrelevant>> stereotype
hide <<irrelevant>> members
+
+' rectangle <<group>>
+hide <<group>> stereotype
+skinparam Rectangle<<group>>BorderStyle dashed
+skinparam Rectangle<<group>>BorderColor gray
+
diff --git a/latexmkrc b/latexmkrc
index d2c3cdc..cdc2001 100644
--- a/latexmkrc
+++ b/latexmkrc
@@ -12,6 +12,8 @@ $clean_ext .= ' %R.ist %R.xdy bbl run.xml';
'plan',
'research',
'timerep',
+ 'design',
+ 'requirements',
);
push @file_not_found, '^Package .* No file `([^\\\']*)\\\'';
diff --git a/projdoc.cls b/projdoc.cls
index 8a2c05d..b369b18 100644
--- a/projdoc.cls
+++ b/projdoc.cls
@@ -330,7 +330,7 @@
% adjust scale for puml diagrams
\newcommand{\includepumldiag}[1]{%
\StrSubstitute{#1}{.puml}{.eps}[\filename]%
- \fitimg{\includegraphics[scale=0.6]{\filename}}%
+ \fitimg{\includegraphics[scale=0.75]{\filename}}%
}
% prevent page break between two paragraphs
diff --git a/time.txt b/time.txt
index 4494d0a..bdb122d 100644
--- a/time.txt
+++ b/time.txt
@@ -57,6 +57,7 @@ loek: 2024-10-01 30m implementation :: audio facade and API
loek: 2024-10-03 1h30m project meeting
loek: 2024-10-04 15m research :: read others' research
loek: 2024-10-04 1h15m project meeting
+loek: 2024-10-05 1h10m refacting :: unify unit tests + update code style
max: 2024-09-02 1h project kickoff
max: 2024-09-02 45m first project meeting