-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[AB3: Tracing Code] Add more headers to section instructions #42
Open
UdhayaShan1
wants to merge
23
commits into
se-edu:master
Choose a base branch
from
UdhayaShan1:tracing-code-add-headers
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
cb71de9
Edit LogicSequenceDiagram puml to show exact arguments
UdhayaShan1 6d49bce
Fix LogicSequenceDiagram by showing creation of parser
UdhayaShan1 16abf00
Add new edit sequence puml with MainWindow and model for future use
UdhayaShan1 ec55e13
Update tracingcode.md with h3 css style added
UdhayaShan1 005583c
Merge branch 'master' into tracing-code-add-headers
UdhayaShan1 464e91a
Edit arguments
UdhayaShan1 5ad51a5
Fix EditSequenceDiagramWithMainWindow png and remove html anchor
UdhayaShan1 9212c14
Edit LogicSequence puml to show execution and add annotated images
UdhayaShan1 a65f636
Add a logic sequence diagram only with mainwindow and logicmanager
UdhayaShan1 9f8f897
Add remaining headers and diagrams
UdhayaShan1 2990596
Update image
UdhayaShan1 4cfab7b
Merge branch 'master' into tracing-code-add-headers
UdhayaShan1 8fb8f61
Remove redundant lines and custom css
UdhayaShan1 5fc1be6
Updated tracing code high level sequence diagram description
UdhayaShan1 da6ae49
Removed MainWindow from puml to not overlap components
UdhayaShan1 3327fde
Misc change
UdhayaShan1 122ca7d
Add double quotes for puml method call arguments
UdhayaShan1 42c96b5
Add label content and change label names to "T<no>" in bold
UdhayaShan1 66cca5e
Making spacing consistent
UdhayaShan1 451b0fe
Update label content to be clearer
UdhayaShan1 e5e4331
Remove unnecessary spacing and fix typos
UdhayaShan1 e7db74d
Merge branch 'master' into tracing-code-add-headers
UdhayaShan1 ba92d2f
Added deletion to puml and misc change
UdhayaShan1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 80 additions & 0 deletions
80
tutorials/images/tracing/EditSequenceDiagramWithMainWindow.puml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
@startuml | ||
!include ../style.puml | ||
skinparam ArrowFontStyle plain | ||
|
||
box Ui MODEL_COLOR_T5 | ||
participant "m:MainWindow" as MainWindow LOGIC_COLOR_T5 | ||
|
||
box Logic LOGIC_COLOR_T1 | ||
participant ":LogicManager" as LogicManager LOGIC_COLOR | ||
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR | ||
participant ":EditCommandParser" as EditCommandParser LOGIC_COLOR | ||
participant "d:EditCommand" as EditCommand LOGIC_COLOR | ||
participant "r:CommandResult" as CommandResult LOGIC_COLOR | ||
end box | ||
|
||
box Model MODEL_COLOR_T1 | ||
participant "m:Model" as Model MODEL_COLOR | ||
end box | ||
|
||
|
||
|
||
--> MainWindow | ||
activate MainWindow | ||
MainWindow -> LogicManager : execute("edit 1 n/Alice Yeoh") | ||
activate LogicManager | ||
|
||
LogicManager -> AddressBookParser : parseCommand("edit 1 n/Alice Yeoh") | ||
activate AddressBookParser | ||
|
||
create EditCommandParser | ||
AddressBookParser -> EditCommandParser | ||
activate EditCommandParser | ||
|
||
EditCommandParser --> AddressBookParser | ||
deactivate EditCommandParser | ||
|
||
AddressBookParser -> EditCommandParser : parse("1 n/Alice Yeoh") | ||
activate EditCommandParser | ||
|
||
create EditCommand | ||
EditCommandParser -> EditCommand | ||
activate EditCommand | ||
|
||
EditCommand --> EditCommandParser : | ||
deactivate EditCommand | ||
|
||
EditCommandParser --> AddressBookParser : d | ||
deactivate EditCommandParser | ||
'Hidden arrow to position the destroy marker below the end of the activation bar. | ||
EditCommandParser -[hidden]-> AddressBookParser | ||
destroy EditCommandParser | ||
|
||
AddressBookParser --> LogicManager : d | ||
deactivate AddressBookParser | ||
|
||
LogicManager -> EditCommand : execute(m) | ||
activate EditCommand | ||
|
||
EditCommand -> Model : ... | ||
activate Model | ||
|
||
Model --> EditCommand | ||
deactivate Model | ||
|
||
create CommandResult | ||
EditCommand -> CommandResult | ||
activate CommandResult | ||
|
||
CommandResult --> EditCommand | ||
deactivate CommandResult | ||
|
||
EditCommand --> LogicManager : r | ||
deactivate EditCommand | ||
|
||
LogicManager --> MainWindow | ||
deactivate LogicManager | ||
|
||
[<-- MainWindow | ||
deactivate MainWindow | ||
@enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions
39
tutorials/images/tracing/LogicSequenceDiagramImproved.puml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
@startuml | ||
!include ../style.puml | ||
skinparam ArrowFontStyle plain | ||
|
||
Participant ":LogicManager" as logic LOGIC_COLOR | ||
Participant ":AddressBookParser" as abp LOGIC_COLOR | ||
Participant ":EditCommandParser" as ecp LOGIC_COLOR | ||
Participant "command:EditCommand" as ec LOGIC_COLOR | ||
|
||
-> logic : execute("edit 1 n/Alice Yeoh") | ||
activate logic | ||
logic -> abp ++: parseCommand("edit 1 n/Alice Yeoh") | ||
create ecp | ||
abp -> ecp | ||
activate ecp | ||
ecp --> abp | ||
deactivate ecp | ||
abp -> ecp ++: parse("1 n/Alice Yeoh") | ||
create ec | ||
ecp -> ec ++: 1, editPersonDescriptor | ||
ec --> ecp -- | ||
ecp --> abp --: command | ||
ecp -[hidden]-> abp --: command | ||
destroy ecp | ||
|
||
|
||
abp --> logic --: command | ||
|
||
logic -> ec : execute | ||
activate ec | ||
ec --> logic : commandResult | ||
deactivate ec | ||
ec -[hidden]-> logic : commandResult | ||
destroy ec | ||
|
||
<-- logic :commandResult | ||
deactivate logic | ||
|
||
@enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions
16
tutorials/images/tracing/LogicSequenceDiagramOnlyWithMainWindow.puml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
@startuml | ||
!include ../style.puml | ||
skinparam ArrowFontStyle plain | ||
|
||
Participant ":MainWindow" as main LOGIC_COLOR | ||
Participant ":LogicManager" as logic LOGIC_COLOR | ||
|
||
main -> logic : execute("edit 1 n/Alice Yeoh") | ||
activate logic | ||
|
||
logic -> : ... | ||
logic <-- : commandResult | ||
logic --> main --: commandResult | ||
deactivate logic | ||
|
||
@enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check other places as well.