rxbag: document plugin API

tools/rxbag/src/rxbag/__init__.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # Software License Agreement (BSD License)
 #
 # Copyright (c) 2009, Willow Garage, Inc.
@@ -30,10 +29,8 @@
 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-#
-# Revision $Id$
 
-# Import rxbag main to be used by the $ROS_ROOT/bin/rxbag
+# rxbag_main used by $ROS_ROOT/bin/rxbag
 from rxbag_main import rxbag_main
 
 import bag_helper

tools/rxbag/src/rxbag/plugins.py

@@ -29,8 +29,10 @@
 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-#
-# Revision $Id$
+
+"""
+Loads plugins.
+"""
 
 PKG = 'rxbag'
 import roslib; roslib.load_manifest(PKG)
@@ -42,6 +44,12 @@ import traceback
 import roslib.rospack
 
 def load_plugins():
+    """
+    Finds all rxbag plugins.
+    
+    @return: a list of plugins
+    @rtype:  list of functions which return tuples of (MessageView, TimelineRenderer, list of: message type or '*')
+    """
     plugins = []
 
     to_check = roslib.rospack.rospack_depends_on_1('rxbag')