From d33e9a2bc07ccd983a1321b254cc27ca6be989a3 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Tue, 8 Jul 2014 17:01:18 -0300 Subject: Add file docstrings. --- src/leap/bitmask/backend/backend_proxy.py | 4 ++++ src/leap/bitmask/backend/leapsignaler.py | 5 ++++- src/leap/bitmask/backend/signaler.py | 4 ++++ src/leap/bitmask/backend/signaler_qt.py | 4 ++++ src/leap/bitmask/backend/utils.py | 3 +++ src/leap/bitmask/backend_app.py | 3 +++ src/leap/bitmask/frontend_app.py | 3 +++ 7 files changed, 25 insertions(+), 1 deletion(-) diff --git a/src/leap/bitmask/backend/backend_proxy.py b/src/leap/bitmask/backend/backend_proxy.py index 3c8e5d0f..39ed322e 100644 --- a/src/leap/bitmask/backend/backend_proxy.py +++ b/src/leap/bitmask/backend/backend_proxy.py @@ -14,6 +14,10 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +The BackendProxy handles calls from the GUI and forwards (through ZMQ) +to the backend. +""" import functools import Queue import threading diff --git a/src/leap/bitmask/backend/leapsignaler.py b/src/leap/bitmask/backend/leapsignaler.py index 7912fc20..a36e6fdc 100644 --- a/src/leap/bitmask/backend/leapsignaler.py +++ b/src/leap/bitmask/backend/leapsignaler.py @@ -14,6 +14,9 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Signaling server, used to define the API signals. +""" from PySide import QtCore from leap.bitmask.backend.signaler_qt import SignalerQt @@ -21,7 +24,7 @@ from leap.bitmask.backend.signaler_qt import SignalerQt class LeapSignaler(SignalerQt): """ - Signaling server subclass, used to defines the API signals. + Signaling server subclass, used to define the API signals. """ backend_bad_call = QtCore.Signal(object) diff --git a/src/leap/bitmask/backend/signaler.py b/src/leap/bitmask/backend/signaler.py index f8753771..6a0ec88a 100644 --- a/src/leap/bitmask/backend/signaler.py +++ b/src/leap/bitmask/backend/signaler.py @@ -14,6 +14,10 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Signaler client. +Receives signals from the backend and sends to the signaling server. +""" import Queue import threading import time diff --git a/src/leap/bitmask/backend/signaler_qt.py b/src/leap/bitmask/backend/signaler_qt.py index dabd6662..ce9c24f5 100644 --- a/src/leap/bitmask/backend/signaler_qt.py +++ b/src/leap/bitmask/backend/signaler_qt.py @@ -14,6 +14,10 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Signaling server. +Receives signals from the signaling client and emit Qt signals for the GUI. +""" import threading import time diff --git a/src/leap/bitmask/backend/utils.py b/src/leap/bitmask/backend/utils.py index 5d600689..b71fab9e 100644 --- a/src/leap/bitmask/backend/utils.py +++ b/src/leap/bitmask/backend/utils.py @@ -14,6 +14,9 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Backend utilities to handle ZMQ certificates. +""" import os import shutil diff --git a/src/leap/bitmask/backend_app.py b/src/leap/bitmask/backend_app.py index b6d00f2d..5c0e4803 100644 --- a/src/leap/bitmask/backend_app.py +++ b/src/leap/bitmask/backend_app.py @@ -14,6 +14,9 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Start point for the Backend. +""" import logging import multiprocessing import signal diff --git a/src/leap/bitmask/frontend_app.py b/src/leap/bitmask/frontend_app.py index 5dc42287..95d36538 100644 --- a/src/leap/bitmask/frontend_app.py +++ b/src/leap/bitmask/frontend_app.py @@ -14,6 +14,9 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Start point for the Frontend. +""" import multiprocessing import signal import sys -- cgit v1.2.3