Author: duncan
Date: Tue Jan 1 07:33:47 2008
New Revision: 10253
Log:
Updated to docstrings for epydoc
Modified:
branches/rel-1/freevo/src/config.py
branches/rel-1/freevo/src/gui/AlertBox.py
branches/rel-1/freevo/src/gui/ConfirmBox.py
branches/rel-1/freevo/src/gui/InputBox.py
branches/rel-1/freevo/src/gui/Label.py
branches/rel-1/freevo/src/gui/PopupBox.py
branches/rel-1/freevo/src/tv/plugins/upsoon.py
branches/rel-1/freevo/src/tv/v4l2.py
branches/rel-1/freevo/src/tv/xmltv.py
Modified: branches/rel-1/freevo/src/config.py
==============================================================================
--- branches/rel-1/freevo/src/config.py (original)
+++ branches/rel-1/freevo/src/config.py Tue Jan 1 07:33:47 2008
@@ -149,24 +149,38 @@
class VideoGroup:
"""
- vdev: The video recording device, such as /dev/video0.
- vvbi: The video vbi device, such as /dev/vbi0.
- adev: The audio device, such as: None, /dev/dsp.
- input_type: tuner, webcam
- input_num: The number of this input according to V4L
- tuner_type: internal (on a v4l device), or external (cable or sat box)
- 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.
- irsend_trans: IR transmitter to use for multiple external tuners.
- 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 one of: 'normal', 'ivtv', 'dvb', 'tvalsa' or
'webcam'.
- cmd: Command for execute external prog after the channel
switched,
- such as 'sudo /usr/local/bin/setuptuner'
+ @ivar vdev:
+ The video recording device, such as /dev/video0.
+ @ivar vvbi:
+ The video vbi device, such as /dev/vbi0.
+ @ivar adev:
+ The audio device, such as: None, /dev/dsp.
+ @ivar input_type:
+ tuner, webcam
+ @ivar input_num:
+ The number of this input according to V4L
+ @ivar tuner_type:
+ internal (on a v4l device), or external (cable or sat box)
+ @ivar tuner_norm:
+ NTSC, PAL, SECAM
+ @ivar tuner_chanlist:
+ us-cable,
+ @ivar 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.
+ @ivar irsend_trans:
+ IR transmitter to use for multiple external tuners.
+ @ivar record_group:
+ VideoGroup that records for this tuner, default is to use the
+ same device for record and play
+ @ivar desc:
+ A nice description for this VideoGroup.
+ @ivar group_type:
+ Special variable to identify devices like dvb or ivtv. This
+ can be one of: 'normal', 'ivtv', 'dvb', 'tvalsa' or 'webcam'.
+ @ivar cmd:
+ Command for execute external prog after the channel switched,
+ such as 'sudo /usr/local/bin/setuptuner'
"""
def __init__(self, vdev=None, vvbi='/dev/vbi', adev=None, input_type=None,
Modified: branches/rel-1/freevo/src/gui/AlertBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/AlertBox.py (original)
+++ branches/rel-1/freevo/src/gui/AlertBox.py Tue Jan 1 07:33:47 2008
@@ -39,13 +39,20 @@
class AlertBox(PopupBox):
"""
- @ivar x: x coordinate. Integer
- @ivar y: y coordinate. Integer
- @ivar width: Integer
- @ivar height: Integer
- @ivar text: String to print.
- @ivar icon: icon
- @ivar text_prop: A dict of 4 elements composing text proprieties:
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties:
{ 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
Modified: branches/rel-1/freevo/src/gui/ConfirmBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/ConfirmBox.py (original)
+++ branches/rel-1/freevo/src/gui/ConfirmBox.py Tue Jan 1 07:33:47 2008
@@ -40,14 +40,21 @@
class ConfirmBox(PopupBox):
"""
- @ivar x: x coordinate. Integer
- @ivar y: y coordinate. Integer
- @ivar width: Integer
- @ivar height: Integer
- @ivar text: String to print.
- @ivar icon: icon
- @ivar text_prop: A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties:
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
Modified: branches/rel-1/freevo/src/gui/InputBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/InputBox.py (original)
+++ branches/rel-1/freevo/src/gui/InputBox.py Tue Jan 1 07:33:47 2008
@@ -40,15 +40,23 @@
class InputBox(PopupBox):
"""
- @ivar x: x coordinate. Integer
- @ivar y: y coordinate. Integer
- @ivar width: Integer
- @ivar height: Integer
- @ivar text: String to print.
- @ivar type: 'normal' or 'password'
- @ivar icon: icon
- @ivar text_prop: A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar type:
+ 'normal' or 'password'
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties:
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
Modified: branches/rel-1/freevo/src/gui/Label.py
==============================================================================
--- branches/rel-1/freevo/src/gui/Label.py (original)
+++ branches/rel-1/freevo/src/gui/Label.py Tue Jan 1 07:33:47 2008
@@ -34,10 +34,14 @@
class Label(GUIObject):
"""
- @ivar text: String, text to display
- @ivar align: Integer, h_align of text. Label.CENTER, Label.RIGHT, Label,
LEFT
- @ivar parent: GUIObject, Reference to object containing this label.
- @ivar text_prop: A dict of 4 elements composing text proprieties:
+ @ivar text:
+ String, text to display
+ @ivar align:
+ Integer, h_align of text. Label.CENTER, Label.RIGHT, Label, LEFT
+ @ivar parent:
+ GUIObject, Reference to object containing this label.
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties:
{ 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
Modified: branches/rel-1/freevo/src/gui/PopupBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/PopupBox.py (original)
+++ branches/rel-1/freevo/src/gui/PopupBox.py Tue Jan 1 07:33:47 2008
@@ -43,14 +43,21 @@
class PopupBox(Window):
"""
- @ivar x: x coordinate. Integer
- @ivar y: y coordinate. Integer
- @ivar width: Integer
- @ivar height: Integer
- @ivar text: String to print.
- @ivar icon: icon
- @ivar text_prop: A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties:
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
Modified: branches/rel-1/freevo/src/tv/plugins/upsoon.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/upsoon.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/upsoon.py Tue Jan 1 07:33:47 2008
@@ -53,12 +53,10 @@
plugin to monitor if a recording is about to start and shut down the
player if the video device is in use
- @requires: nothing
-
To activate this plugin, just put the following line at the end of your
- local_conf.py file::
+ local_conf.py file:
- plugin.activate('tv.upsoon')
+ | plugin.activate('tv.upsoon')
"""
__author__ = 'Duncan Webb'
__author_email__ = '[EMAIL PROTECTED]'
Modified: branches/rel-1/freevo/src/tv/v4l2.py
==============================================================================
--- branches/rel-1/freevo/src/tv/v4l2.py (original)
+++ branches/rel-1/freevo/src/tv/v4l2.py Tue Jan 1 07:33:47 2008
@@ -342,7 +342,7 @@
def enuminput(self, num):
"""
Enumerate a video device input
- @param num is the input number
+ @param num: is the input number
"""
val = struct.pack(ENUMINPUT_ST, num, "", 0, 0, 0, 0, 0)
r = fcntl.ioctl(self.device, i32(ENUMINPUT_NO), val)
Modified: branches/rel-1/freevo/src/tv/xmltv.py
==============================================================================
--- branches/rel-1/freevo/src/tv/xmltv.py (original)
+++ branches/rel-1/freevo/src/tv/xmltv.py Tue Jan 1 07:33:47 2008
@@ -295,7 +295,7 @@
"""
A class for generating XMLTV data
- @note All strings passed to this class must be Unicode, except for
dictionary keys
+ @note: All strings passed to this class must be Unicode, except for
dictionary keys
"""
def __init__(self, encoding="utf-8", date=None,
source_info_url=None, source_info_name=None,
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
