From 6d9340ebbb5b942b0996053b0479827c1cf81b5a Mon Sep 17 00:00:00 2001 From: necoro <> Date: Sat, 7 Jul 2007 08:50:33 +0000 Subject: some more documentation --- portato/plugin.py | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'portato/plugin.py') diff --git a/portato/plugin.py b/portato/plugin.py index 8a54c11..abdf86c 100644 --- a/portato/plugin.py +++ b/portato/plugin.py @@ -10,6 +10,8 @@ # # Written by René 'Necoro' Neumann +"""A module containing the management of the plugin system.""" + import os, os.path from xml.dom.minidom import parse @@ -505,11 +507,19 @@ class PluginQueue: __plugins = None def load_plugins(frontend): + """Loads the plugins for a given frontend. + @param frontend: The frontend. See L{constants.FRONTENDS} for the correct list of values. + @type frontend: string""" + global __plugins if __plugins is None or __plugins.frontend != frontend: __plugins = PluginQueue(frontend) def get_plugin_queue(): + """Returns the actual L{PluginQueue}. If it is C{None}, they are not being loaded yet. + + @returns: the actual L{PluginQueue} or C{None} + @rtype: PluginQueue""" return __plugins def hook(hook, *args, **kwargs): -- cgit v1.2.3