r10357 - /branches/bieri_gui/gui_bieri/analyses/auto_model_free.py -- January 26, 2010 - 11:23

Author: bugman
Date: Tue Jan 26 11:23:10 2010
New Revision: 10357

URL: http://svn.gna.org/viewcvs/relax?rev=10357&view=rev
Log:
Added epydoc documentation to the build_main_box() docstring.


Modified:
    branches/bieri_gui/gui_bieri/analyses/auto_model_free.py

Modified: branches/bieri_gui/gui_bieri/analyses/auto_model_free.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/gui_bieri/analyses/auto_model_free.py?rev=10357&r1=10356&r2=10357&view=diff
==============================================================================
--- branches/bieri_gui/gui_bieri/analyses/auto_model_free.py (original)
+++ branches/bieri_gui/gui_bieri/analyses/auto_model_free.py Tue Jan 26 
11:23:10 2010
@@ -378,7 +378,11 @@
 
 
     def build_main_box(self):
-        """Construct the highest level box to pack into the automatic 
model-free analysis frame."""
+        """Construct the highest level box to pack into the automatic 
model-free analysis frame.
+
+        @return:    The main box element containing all model-free GUI 
elements to pack directly into the automatic model-free analysis frame.
+        @rtype:     wx.BoxSizer instance
+        """
 
         # Use a horizontal packing of elements.
         box = wx.BoxSizer(wx.HORIZONTAL)