Author: duncan
Date: Wed Nov 28 02:21:17 2007
New Revision: 10162
Log:
Clean up of docstrings for epytext
Modified:
branches/rel-1/freevo/src/config.py
branches/rel-1/freevo/src/directory.py
branches/rel-1/freevo/src/osd.py
branches/rel-1/freevo/src/skin/models.py
branches/rel-1/freevo/src/skin/widgets/textentry_screen.py
Modified: branches/rel-1/freevo/src/config.py
==============================================================================
--- branches/rel-1/freevo/src/config.py (original)
+++ branches/rel-1/freevo/src/config.py Wed Nov 28 02:21:17 2007
@@ -158,11 +158,11 @@
tuner_norm: NTSC, PAL, SECAM
tuner_chanlist: us-cable,
tuner_chan: If using input_type=tuner and tuner_type=external set this to
- what channel it needs to be to get the signal, usually 3 or
4.
+ what channel it needs to be to get the signal, usually 3 or 4.
record_group: VideoGroup that records for this tuner, default is to use
the same device for record and play
desc: A nice description for this VideoGroup.
group_type: Special variable to identify devices like dvb or ivtv. This
- can be left as default, 'normal', or set to 'ivtv', 'dvb',
'webcam', 'tvalsa'.
+ can be left as default, 'normal', or set to 'ivtv',
'dvb', 'webcam', 'tvalsa'.
cmd: Command for execute external prog after the channel
switched, such as 'sudo /usr/local/bin/setuptuner'
"""
@@ -508,9 +508,9 @@
RUNAPP = os.environ['RUNAPP']
_debug_('RUNAPP: %s' % (RUNAPP))
-_debug_('logdir: %s %s' % (OS_LOGDIR, FREEVO_LOGDIR), DINFO)
-_debug_('staticdir: %s %s' % (OS_STATICDIR, FREEVO_STATICDIR), DINFO)
-_debug_('cachedir: %s %s' % (OS_CACHEDIR, FREEVO_CACHEDIR), DINFO)
+_debug_('LOGDIR: %s %s' % (OS_LOGDIR, FREEVO_LOGDIR), DINFO)
+_debug_('STATICDIR: %s %s' % (OS_STATICDIR, FREEVO_STATICDIR), DINFO)
+_debug_('CACHEDIR: %s %s' % (OS_CACHEDIR, FREEVO_CACHEDIR), DINFO)
#
# Check that freevo_config.py is not found in the config file dirs
Modified: branches/rel-1/freevo/src/directory.py
==============================================================================
--- branches/rel-1/freevo/src/directory.py (original)
+++ branches/rel-1/freevo/src/directory.py Wed Nov 28 02:21:17 2007
@@ -232,7 +232,7 @@
def read_folder_fxd(self, fxd, node):
'''
- parse the xml file for directory settings
+ parse the xml file for directory settings::
<?xml version="1.0" ?>
<freevo>
Modified: branches/rel-1/freevo/src/osd.py
==============================================================================
--- branches/rel-1/freevo/src/osd.py (original)
+++ branches/rel-1/freevo/src/osd.py Wed Nov 28 02:21:17 2007
@@ -872,9 +872,12 @@
def __drawstringframed_line__(self, string, max_width, font, hard,
ellipses, word_splitter):
"""
- calculate _one_ line for drawstringframed. Returns a list:
- width used, string to draw, rest that didn't fit and True if this
- function stopped because of a \n.
+ calculate _one_ line for drawstringframed.
+ @returns a list
+ - width used
+ - string to draw
+ - rest that didn't fit
+ - True if this function stopped because of a \n.
"""
c = 0 # num of chars fitting
width = 0 # width needed
@@ -979,18 +982,18 @@
This is a wrapper to drawstringframedsoft() and -hard()
Parameters:
- - string: the string to be drawn, supports also '\n'. \t is not
supported
- by pygame, you need to replace it first
- - x,y: the posistion
- - width, height: the frame dimensions,
- height == -1 defaults to the font height size
- - fgcolor, bgcolor: the color for the foreground and background
- respectively. (Supports the alpha channel: 0xAARRGGBB)
- - font, ptsize: font and font point size
- - align_h: horizontal align. Can be left, center, right, justified
- - align_v: vertical align. Can be top, bottom, center or middle
- - mode: the way we should break lines/truncate. Can be 'hard'(based on
chars)
- or 'soft' (based on words)
+ - string: the string to be drawn, supports also '\n'. \t is not
supported
+ by pygame, you need to replace it first
+ - x,y: the posistion
+ - width, height: the frame dimensions,
+ height == -1 defaults to the font height size
+ - fgcolor, bgcolor: the color for the foreground and background
+ respectively. (Supports the alpha channel: 0xAARRGGBB)
+ - font, ptsize: font and font point size
+ - align_h: horizontal align. Can be left, center, right, justified
+ - align_v: vertical align. Can be top, bottom, center or middle
+ - mode: the way we should break lines/truncate. Can be
'hard'(based on chars)
+ or 'soft' (based on words)
font can also be a skin font object. If so, this functions also
supports
shadow and border. fgcolor and bgcolor will also be taken from the skin
Modified: branches/rel-1/freevo/src/skin/models.py
==============================================================================
--- branches/rel-1/freevo/src/skin/models.py (original)
+++ branches/rel-1/freevo/src/skin/models.py Wed Nov 28 02:21:17 2007
@@ -53,8 +53,9 @@
def __get_line__(self, string, max_width, font, word_splitter, hard):
"""
calculate _one_ line. Returns a list:
- string to draw, rest that didn't fit and True if this
- function stopped because of a \n.
+ - string to draw
+ - rest that didn't fit
+ - True if this function stopped because of a \n.
"""
c = 0 # num of chars fitting
width = 0 # width needed
Modified: branches/rel-1/freevo/src/skin/widgets/textentry_screen.py
==============================================================================
--- branches/rel-1/freevo/src/skin/widgets/textentry_screen.py (original)
+++ branches/rel-1/freevo/src/skin/widgets/textentry_screen.py Wed Nov 28
02:21:17 2007
@@ -43,14 +43,14 @@
"""
Used to display and control the
- actions - Tuple containing a name and an action function that will be
called
+ @param actions: Tuple containing a name and an action function that
will be called
with the menu widget and the contents of the text entry
field when
selected.
- title - The title to display at the top of the screen.
- text - Initial text for the text entry field.
- alpha - Whether to display the alphabet character board
- numeric - Whether to display the number character board.
- symbol - Whether to display the symbol character board.
+ @param title: The title to display at the top of the screen.
+ @param text: Initial text for the text entry field.
+ @param alpha: Whether to display the alphabet character board
+ @param numeric: Whether to display the number character board.
+ @param symbol: Whether to display the symbol character board.
"""
self.title = title
self.text_entry = TextEntry(text)
-------------------------------------------------------------------------
SF.Net email is sponsored by: The Future of Linux Business White Paper
from Novell. From the desktop to the data center, Linux is going
mainstream. Let it simplify your IT future.
http://altfarm.mediaplex.com/ad/ck/8857-50307-18918-4
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
