From 0e4d6664d4f867e0337e313384a9ee12ee2c6267 Mon Sep 17 00:00:00 2001 From: Stefan Sauer Date: Fri, 30 Sep 2016 22:31:24 +0200 Subject: [PATCH] debug-viewer: add a few doc strings --- debug-viewer/GstDebugViewer/Data.py | 4 ++++ debug-viewer/GstDebugViewer/Plugins/__init__.py | 14 ++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/debug-viewer/GstDebugViewer/Data.py b/debug-viewer/GstDebugViewer/Data.py index f491b36716..e246d24ef5 100644 --- a/debug-viewer/GstDebugViewer/Data.py +++ b/debug-viewer/GstDebugViewer/Data.py @@ -268,6 +268,10 @@ class SortHelper (object): class LineCache (Producer): + """ + offsets: file position for each line + levels: the debug level for each line + """ _lines_per_iteration = 50000 diff --git a/debug-viewer/GstDebugViewer/Plugins/__init__.py b/debug-viewer/GstDebugViewer/Plugins/__init__.py index 3e3379791d..847a1a8a25 100644 --- a/debug-viewer/GstDebugViewer/Plugins/__init__.py +++ b/debug-viewer/GstDebugViewer/Plugins/__init__.py @@ -59,18 +59,32 @@ class FeatureBase (object): pass def handle_attach_window(self, window): + """ + window: GstDebugViewer.GUI.window.Window + """ pass def handle_attach_log_file(self, window, log_file): + """ + window: GstDebugViewer.GUI.window.Window + log_file: GstDebugViewer.Data.LogFile + """ pass def handle_detach_log_file(self, window, log_file): + """ + window: GstDebugViewer.GUI.window.Window + log_file: GstDebugViewer.Data.LogFile + """ pass def handle_detach_window(self, window): + """ + window: GstDebugViewer.GUI.window.Window + """ pass