Author: duncan
Date: Sun Dec 16 12:44:35 2007
New Revision: 10212

Log:
Corrected epytext strings


Modified:
   branches/rel-1/freevo/src/audio/__init__.py
   branches/rel-1/freevo/src/audio/plugins/album_tree.py
   branches/rel-1/freevo/src/directory.py
   branches/rel-1/freevo/src/image/__init__.py
   branches/rel-1/freevo/src/playlist.py
   branches/rel-1/freevo/src/plugins/idlebar/system.py
   branches/rel-1/freevo/src/tv/epg_types.py
   branches/rel-1/freevo/src/video/encodingclient.py
   branches/rel-1/freevo/src/video/fxdhandler.py
   branches/rel-1/freevo/src/video/plugins/moviecovers.py

Modified: branches/rel-1/freevo/src/audio/__init__.py
==============================================================================
--- branches/rel-1/freevo/src/audio/__init__.py (original)
+++ branches/rel-1/freevo/src/audio/__init__.py Sun Dec 16 12:44:35 2007
@@ -134,21 +134,21 @@
         """
         parse audio specific stuff from fxd files::
 
-        <?xml version="1.0" ?>
-        <freevo>
-          <audio title="Smoothjazz">
-            <cover-img>foo.jpg</cover-img>
-            <mplayer_options></mplayer_options>
-            <player>xine</player>
-            <playlist/>
-            <reconnect/>
-            <url>http://64.236.34.141:80/stream/1005</url>
-            <info>
-              <genre>JAZZ</genre>
-              <description>A nice description</description>
-            </info>
-          </audio>
-        </freevo>
+            <?xml version="1.0" ?>
+            <freevo>
+                <audio title="Smoothjazz">
+                    <cover-img>foo.jpg</cover-img>
+                    <mplayer_options></mplayer_options>
+                    <player>xine</player>
+                    <playlist/>
+                    <reconnect/>
+                    <url>http://64.236.34.141:80/stream/1005</url>
+                    <info>
+                        <genre>JAZZ</genre>
+                        <description>A nice description</description>
+                    </info>
+                </audio>
+            </freevo>
 
         Everything except title and url is optional. If <player> is set, this 
player
         will be used (possible xine or mplayer). The tag <playlist/> signals 
that this

Modified: branches/rel-1/freevo/src/audio/plugins/album_tree.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/album_tree.py       (original)
+++ branches/rel-1/freevo/src/audio/plugins/album_tree.py       Sun Dec 16 
12:44:35 2007
@@ -107,7 +107,7 @@
     @requires: pysqlite.
 
     Pre Installation
-    ----------------
+    ================
 
     The sqlite-meta-database should be available.
 
@@ -123,7 +123,7 @@
         - The meta database should be available now.
 
     Configuration
-    -------------
+    =============
 
     Edit your local_config.py and add this:
 
@@ -169,7 +169,7 @@
     | })
 
     Post Installation
-    -----------------
+    =================
 
     New plugins are not immediately visible on the freevo webserver.
 

Modified: branches/rel-1/freevo/src/directory.py
==============================================================================
--- branches/rel-1/freevo/src/directory.py      (original)
+++ branches/rel-1/freevo/src/directory.py      Sun Dec 16 12:44:35 2007
@@ -231,19 +231,19 @@
 
 
     def read_folder_fxd(self, fxd, node):
-        '''
+        """
         parse the xml file for directory settings::
 
-        <?xml version="1.0" ?>
-        <freevo>
-          <folder title="Incoming TV Shows" cover-img="foo.jpg">
-            <setvar name="directory_autoplay_single_item" val="0"/>
-            <info>
-              <content>Episodes for current tv shows not seen yet</content>
-            </info>
-          </folder>
-        </freevo>
-        '''
+            <?xml version="1.0" ?>
+            <freevo>
+                <folder title="Incoming TV Shows" cover-img="foo.jpg">
+                    <setvar name="directory_autoplay_single_item" val="0"/>
+                    <info>
+                        <content>Episodes for current tv shows not seen 
yet</content>
+                    </info>
+                </folder>
+            </freevo>
+        """
         if node.name == 'skin':
             self.skin_fxd = self.folder_fxd
             return

Modified: branches/rel-1/freevo/src/image/__init__.py
==============================================================================
--- branches/rel-1/freevo/src/image/__init__.py (original)
+++ branches/rel-1/freevo/src/image/__init__.py Sun Dec 16 12:44:35 2007
@@ -103,23 +103,23 @@
         """
         parse image specific stuff from fxd files::
 
-        <?xml version="1.0" ?>
-        <freevo>
-          <slideshow title="foo" random="1|0" repeat="1|0">
-            <cover-img>foo.jpg</cover-img>
-            <background-music random="1|0">
-              <directory recursive="1|0">path</directory>
-              <file>filename</file>
-            </background-music>
-            <files>
-              <directory recursive="1|0" duration="10">path</directory>
-              <file duration="0">filename</file>
-            </files>
-            <info>
-              <description>A nice description</description>
-            </info>
-          </slideshow>
-        </freevo>
+            <?xml version="1.0" ?>
+            <freevo>
+                <slideshow title="foo" random="1|0" repeat="1|0">
+                    <cover-img>foo.jpg</cover-img>
+                    <background-music random="1|0">
+                        <directory recursive="1|0">path</directory>
+                        <file>filename</file>
+                    </background-music>
+                    <files>
+                        <directory recursive="1|0" 
duration="10">path</directory>
+                        <file duration="0">filename</file>
+                    </files>
+                    <info>
+                        <description>A nice description</description>
+                    </info>
+                </slideshow>
+            </freevo>
         """
         items    = []
         dirname  = os.path.dirname(fxd.getattr(None, 'filename', ''))

Modified: branches/rel-1/freevo/src/playlist.py
==============================================================================
--- branches/rel-1/freevo/src/playlist.py       (original)
+++ branches/rel-1/freevo/src/playlist.py       Sun Dec 16 12:44:35 2007
@@ -153,7 +153,7 @@
 
         File line format::
 
-        FileName: "image file name"; Caption: "caption text"; Delay: "sec"
+            FileName: "image file name"; Caption: "caption text"; Delay: "sec"
 
         The caption and delay are optional.
 
@@ -526,19 +526,19 @@
         """
         parse audio specific stuff from fxd files::
 
-        <?xml version="1.0" ?>
-        <freevo>
-          <playlist title="foo" random="1|0" repeat="1|0">
-            <cover-img>foo.jpg</cover-img>
-            <files>
-              <directory recursive="1|0">path</directory>
-              <file>filename</file>
-            </files>
-            <info>
-              <description>A nice description</description>
-            </info>
-          </playlist>
-        </freevo>
+            <?xml version="1.0" ?>
+            <freevo>
+                <playlist title="foo" random="1|0" repeat="1|0">
+                    <cover-img>foo.jpg</cover-img>
+                    <files>
+                        <directory recursive="1|0">path</directory>
+                        <file>filename</file>
+                    </files>
+                    <info>
+                        <description>A nice description</description>
+                    </info>
+                </playlist>
+            </freevo>
         """
         children = fxd.get_children(node, 'files')
         dirname  = os.path.dirname(fxd.getattr(None, 'filename', ''))

Modified: branches/rel-1/freevo/src/plugins/idlebar/system.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/idlebar/system.py (original)
+++ branches/rel-1/freevo/src/plugins/idlebar/system.py Sun Dec 16 12:44:35 2007
@@ -49,12 +49,12 @@
     in megabytes (calculated approx. as MemFree+Cached?)
 
     Activate with
-       plugin.activate('idlebar.system.procstats',level=20) for defaults or
-       plugin.activate('idlebar.system.procstats',level=20,args=(Mem,Cpu,Prec))
-      where
-       Mem:  Draw memfree  (default=1, -1 to disable)
-       Cpu:  Draw cpuusage (default=1, -1 to disable)
-       Prec: Precision used when drawing cpu usage (default=1)
+    | plugin.activate('idlebar.system.procstats',level=20) for defaults or
+    | plugin.activate('idlebar.system.procstats',level=20,args=(Mem,Cpu,Prec))
+    where
+        - Mem:  Draw memfree  (default=1, -1 to disable)
+        - Cpu:  Draw cpuusage (default=1, -1 to disable)
+        - Prec: Precision used when drawing cpu usage (default=1)
     """
     def __init__(self,Mem=1,Cpu=1,Prec=1):
         IdleBarPlugin.__init__(self)
@@ -164,11 +164,9 @@
     Displays sensor temperature information (cpu,case) and memory-stats.
 
     Activate with:
-       plugin.activate('idlebar.system.sensors', level=40,
-              args=('cpusensor', 'casesensor', 'meminfo'))
-       plugin.activate('idlebar.system.sensors', level=40,
-              args=(('cpusensor','compute expression'),
-                    ('casesensor','compute_expression'), 'meminfo'))
+    | plugin.activate('idlebar.system.sensors', level=40, args=('cpusensor', 
'casesensor', 'meminfo'))
+    | plugin.activate('idlebar.system.sensors', level=40, 
args=(('cpusensor','compute expression'),
+    |     ('casesensor','compute_expression'), 'meminfo'))
 
     cpu and case sensor are the corresponding lm_sensors : this should be
     temp1, temp2 or temp3. defaults to temp3 for cpu and temp2 for case

Modified: branches/rel-1/freevo/src/tv/epg_types.py
==============================================================================
--- branches/rel-1/freevo/src/tv/epg_types.py   (original)
+++ branches/rel-1/freevo/src/tv/epg_types.py   Sun Dec 16 12:44:35 2007
@@ -166,7 +166,7 @@
     id = ''
     displayname = ''
     tunerid = ''
-    logo = ''   # URL or file   Not used yet
+    logo = ''   # URL or file, Not used yet
     programs = None
     times = None
 

Modified: branches/rel-1/freevo/src/video/encodingclient.py
==============================================================================
--- branches/rel-1/freevo/src/video/encodingclient.py   (original)
+++ branches/rel-1/freevo/src/video/encodingclient.py   Sun Dec 16 12:44:35 2007
@@ -105,16 +105,17 @@
 def initEncodeJob(source, output, friendlyname="", title=None):
     """Initialize the encodingjob.
 
+    This function returns an idnr (integer) if successful
+
+    This call can take some time (10 seconds on average) before returning, 
because the
+    encodingserver analyzes the video during this call.
+
     @param source: is the source video you want to have encoded
     @param output: is the name of the resulting encoded file you want
     @param friendlyname: is a "friendly name" to assign to this encoding job
     @param title: is obligatory if you have a dvd/dvd-on-disc, in wich case 
you need
         to specify a title (integer)
-
-    This function returns an idnr (integer) if successful
-
-    This call can take some time (10 seconds on average) before returning, 
because the
-    encodingserver analyzes the video during this call."""
+    """
 
     _debug_('initEncodeJob(%s, %s, %s, %s)' % (source, output, friendlyname, 
title), DINFO)
     if not (source or output):
@@ -298,8 +299,6 @@
     """Get the progress & pass information of the job currently encoding.
 
     This call returns False if no job is currently encoding (fx the queue is 
not active).
-    @returns: When the queue is active, this call returns a tuple of 4 values:
-        (friendlyname, status, perc, timerem)
 
     friendlyname is the friendlyname you assigned to the encoding job
     status is the current status of the encoding job, represented by an integer
@@ -311,6 +310,9 @@
 
     perc is the percentage completed of the current pass, timerem is the 
estimated
     time remaining of the current pass, formatted as a human-readable string.
+
+    @returns: When the queue is active, this call returns a tuple of 4 values:
+        (friendlyname, status, perc, timerem)
     """
 
     try:

Modified: branches/rel-1/freevo/src/video/fxdhandler.py
==============================================================================
--- branches/rel-1/freevo/src/video/fxdhandler.py       (original)
+++ branches/rel-1/freevo/src/video/fxdhandler.py       Sun Dec 16 12:44:35 2007
@@ -37,20 +37,20 @@
     """
     Callback for VideoItem <movie>::
 
-    <movie title>
-        <cover-img>file</cover-img>
-        <video mplayer-options>
-            <dvd|vcd|file id name media_id mplayer-options>file</>+
-        <variants>
-            <variant>
-                <part ref mplayer-options>
-                    <subtitle media_id>file</subtitle>
-                    <audio media_id>file</audio>
-                </part>+
-            </variant>+
-        </variants>
-        <info/>
-    </movie>
+        <movie title>
+            <cover-img>file</cover-img>
+            <video mplayer-options>
+                <dvd|vcd|file id name media_id mplayer-options>file</>+
+            <variants>
+                <variant>
+                    <part ref mplayer-options>
+                        <subtitle media_id>file</subtitle>
+                        <audio media_id>file</audio>
+                    </part>+
+                </variant>+
+            </variants>
+            <info/>
+        </movie>
     """
 
     files = []

Modified: branches/rel-1/freevo/src/video/plugins/moviecovers.py
==============================================================================
--- branches/rel-1/freevo/src/video/plugins/moviecovers.py      (original)
+++ branches/rel-1/freevo/src/video/plugins/moviecovers.py      Sun Dec 16 
12:44:35 2007
@@ -111,8 +111,9 @@
 
     def searchMoviecovers(self, name):
         """name (string), returns id list
+
         Search for name and returns an id list with tuples:
-            (id , name, year, type)"""
+        (id , name, year, type)"""
         # Clean internal variables
         self.initmyself()
         self.moviecovers_id_list = []

-------------------------------------------------------------------------
SF.Net email is sponsored by:
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services
for just about anything Open Source.
http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog

Reply via email to