Author: duncan
Date: Tue Oct 23 00:44:42 2007
New Revision: 10033
Log:
Tidied up/corrected doc strings
Modified:
branches/rel-1/freevo/src/plugin.py
branches/rel-1/freevo/src/tv/xmltv.py
Modified: branches/rel-1/freevo/src/plugin.py
==============================================================================
--- branches/rel-1/freevo/src/plugin.py (original)
+++ branches/rel-1/freevo/src/plugin.py Tue Oct 23 00:44:42 2007
@@ -416,8 +416,8 @@
def register_callback(name, *args):
"""
- register a callback to the callback handler 'name'. The format of
- *args depends on the callback
+ register a callback to the callback handler 'name'.
+ @note The format of args depends on the callback
"""
global __callbacks__
if not __callbacks__.has_key(name):
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 Oct 23 00:44:42 2007
@@ -295,35 +295,30 @@
"""
A class for generating XMLTV data
- **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,
generator_info_url=None, generator_info_name=None):
"""
- Arguments:
-
- 'encoding' -- The text encoding that will be used.
- *Defaults to 'utf-8'*
+ @param encoding -- The text encoding that will be used. Defaults to
'utf-8'
- 'date' -- The date this data was generated. *Optional*
+ @param date The date this data was generated. Optional
- 'source_info_url' -- A URL for information about the source of the
- data. *Optional*
+ @param source_info_url A URL for information about the source of the
data.
+ Optional
- 'source_info_name' -- A human readable description of
- 'source_info_url'. *Optional*
+ @param source_info_name A human readable description of
source_info_url.
+ Optional
- 'generator_info_url' -- A URL for information about the program
- that is generating the XMLTV document.
- *Optional*
+ @param generator_info_url A URL for information about the program that
+ is generating the XMLTV document. Optional
- 'generator_info_name' -- A human readable description of
- 'generator_info_url'. *Optional*
+ @param generator_info_name A human readable description of
+ generator_info_url. Optional
"""
- if DEBUG >= 0: print "in Writer:__init__"
+ _debug_('in Writer:__init__()', 2)
self.encoding = encoding
self.data = {'date': date,
'source_info_url': source_info_url,
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
