Skip to content

Commit

Permalink
updated documentation with class diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
janwilmans committed Mar 14, 2021
1 parent 212ede1 commit ca8a8e1
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 1 deletion.
1 change: 0 additions & 1 deletion DebugView++/MainFrame.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ using ATL::CString;
#include "DebugView++Lib/LineBuffer.h"
#include "DebugView++Lib/LogSources.h"
#include "DebugView++Lib/FileWriter.h"
#include "DebugView++Lib/CTimelineView.h"
#include "CLogViewTabItem2.h"
#include "FindDlg.h"
#include "RunDlg.h"
Expand Down
92 changes: 92 additions & 0 deletions doc/classdiagram.plantuml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
@startuml

class LogSource {
ILineBuffer
m_timer
}

class ProcessReader
{
PipeReader m_stdout
PipeReader m_stderr
}

class LogSources
{
AddMessage(const std::string& message);
}

class CMainFrame
{
LogSources m_logSources;
}

class CLogView
{
deque<LogLine> m_logLines
}

class CLogViewTabItem
{
std::shared_ptr<CLogView> m_pView;
}

class CLogViewTabItem2
{
std::shared_ptr<CLogView> m_pView;
CHorSplitterWindow m_split;
CMyPaneContainer m_top;
CMyPaneContainer m_bottom;
gdi::CTimelineView m_timelineView;
ViewPort m_viewPort;
}

CCustomTabItem <|-- CTabViewTabItem
CTabViewTabItem <|-- CLogViewTabItem
CTabViewTabItem <|--- CLogViewTabItem2

CTabbedFrameImpl <|-- CMainFrame
CMainFrame --> LogSources
CMainFrame -> CLogView
'CLogView -> CLogViewTabItem
CLogView -> CLogViewTabItem2
LogSources --> LogSource

CLogViewTabItem2 --> CTimelineView

class CTimelineView
{
+PaintScale()
+PaintCursors()
+PaintTimelines()
}

class TimelineDC
{
DrawTextOut()
DrawPolygon()
DrawTimeline()
DrawSolidFlag()
DrawFlag()
}

CTimelineView -> Line
Line -> Artifact
CTimelineView --> TimelineDC


LogSource <|--- Loopback
LogSource <|--- TestSource
LogSource <|--- PolledLogSource
LogSource <|--- SocketReader
LogSource <|-- DBWinReader
LogSource <|-- FileReader
LogSource <|-- BinaryFileReader

PolledLogSource <|-- PipeReader
PolledLogSource <|-- DbgviewReader
PolledLogSource <|-- ProcessReader

CListViewCtrl <|-- CLogView

@enduml
1 change: 1 addition & 0 deletions doc/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://plantuml-editor.kkeisuke.com/#

0 comments on commit ca8a8e1

Please sign in to comment.