yui / yuidoc

0
@@ -1,5 +1,10 @@
0
 ChangeLog
0
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0
 
0
+Next
0
+    * added multi-language support
0
+    * improved international character support
0
+    * added known issues and workarounds
0
+
0
 1.0.0b1
0
     * Initial release

0
@@ -25,6 +25,20 @@ Unix (including cygwin):
0
 
0
     easy_install pygments
0
     easy_install Cheetah
0
+
0
+    *****************************************************************************
0
+    *****************************************************************************
0
+    ***
0
+    *** NOTE: recent versions of Cheetah are sometimes throwing errors when
0
+    *** encountering international characters.  Until this is resolved, you must
0
+    *** use Cheetah 2.1.0 or below if you are experiencing a unicode error
0
+    *** when parsing your files.
0
+    ***
0
+    *** easy_install http://downloads.sourceforge.net/sourceforge/cheetahtemplate/Cheetah-2.1.0.tar.gz?use_mirror=superb-west
0
+    ***
0
+    *****************************************************************************
0
+    *****************************************************************************
0
+
0
     easy_install simplejson
0
 
0
 

0
@@ -0,0 +1,36 @@
0
+**************************************************************************
0
+Unicode Errors:
0
+
0
+Recent versions of Cheetah are sometimes throwing errors when
0
+encountering international characters.  Until this is resolved, you must
0
+use Cheetah 2.1.0 or below if you are experiencing unicode errors
0
+when parsing your files.
0
+
0
+easy_install http://downloads.sourceforge.net/sourceforge/cheetahtemplate/Cheetah-2.1.0.tar.gz?use_mirror=superb-west
0
+
0
+**************************************************************************
0
+Mapping Files to Modules:
0
+
0
+Because a single @module is supported for a set of files, the parser expects that all files in 
0
+the input directory belong to the same module.  If multiple modules exist either in the source
0
+directory or in any subdirectory, files may get mapped to modules incorrectly.
0
+
0
+For example:
0
+
0
+sourcedir/
0
+    module1.js
0
+    module2.js
0
+
0
+sourcedir/
0
+    module1/
0
+        foo.js
0
+    module2/
0
+        bar.js
0
+
0
+$ yuidoc.py sourcedir
0
+
0
+The workaround is to use the second pattern and pass the source directory for each module to yuidoc
0
+
0
+$ yuidoc.py module1 module2
0
+
0
+**************************************************************************

0
@@ -33,6 +33,9 @@ CHANGES
0
 INSTALL
0
     Installation instructions
0
 
0
+KNOWN_ISSUES
0
+    Known issues and workarounds.
0
+
0
 TAGS
0
     Supported tags
0
 

0
@@ -105,6 +105,8 @@ class DocGenerator(object):
0
     def write(self, filename, data):
0
         out = open(os.path.join(self.outpath, filename), "w")
0
         out.writelines(str(data))
0
+        # out.writelines(unicode(data))
0
+        # out.writelines(unicode(data, 'utf-8', 'xmlcharrefreplace'))
0
         out.close()
0
 
0
     def process(self):
0
@@ -147,7 +149,7 @@ class DocGenerator(object):
0
         def transferToTemplate(prop, dict, template, valOverride=''):
0
             val = ""
0
             if prop in dict:
0
-                val = unicode(dict[prop])
0
+                val = dict[prop]
0
 
0
                 if valOverride:
0
                     val = valOverride
0
@@ -157,7 +159,7 @@ class DocGenerator(object):
0
         def transferToDict(prop, dict1, dict2, default="", skipOverrideIfNoMatch=False):
0
             val = "" 
0
             if prop in dict1:
0
-                val = unicode(dict1[prop])
0
+                val = dict1[prop]
0
                 if not val: 
0
                     val = default
0
             else:
0
@@ -332,7 +334,7 @@ class DocGenerator(object):
0
             # class API view
0
             #for i in classes:
0
             for i in m[CLASS_LIST]:
0
-                self.classname = unicode(i)
0
+                self.classname = i
0
                 c = classes[i]
0
                 if shouldShowClass(c):
0
                     log.info("Generating API page for " + i)
0
@@ -525,7 +527,7 @@ class DocGenerator(object):
0
                     # get inherited data
0
                     inherited = t.inherited = {PROPERTIES:{}, METHODS:{}, EVENTS:{}, CONFIGS:{}, SUPERCLASS: {} }
0
                     if EXTENDS in c:
0
-                        supercname = t.extends = unicode(c[EXTENDS])
0
+                        supercname = t.extends = c[EXTENDS]
0
                         if supercname in classes:
0
                             superc = classes[supercname]
0
                             getPropsFromSuperclass(superc, classes, inherited)
0
@@ -601,7 +603,7 @@ class DocGenerator(object):
0
             # class source view
0
             for i in m[FILE_LIST]:
0
                 log.info("Generating source view for " + i)
0
-                self.filename = unicode(i)
0
+                self.filename = i
0
                 assignGlobalProperties(t)
0
                 self.write("%s.html" %(self.filename), t)
0
 

0
@@ -42,7 +42,7 @@ class DocParser(object):
0
             f=open(os.path.join(path, file))
0
             #adding a return to the beginning of the line allows for:
0
             #  #!/usr/bin/foo
0
-            #  MOVED to the fil marker
0
+            #  MOVED to the file marker
0
             # fileStr = StringIO("\n%s" % f.read()).getvalue()
0
             fileStr = StringIO("%s" % f.read()).getvalue()
0
             log.info("parsing " + file)
0
@@ -313,9 +313,9 @@ class DocParser(object):
0
 
0
                         if match:
0
                             if match.group(4):
0
-                                type, description = "", unicode(match.group(4) + match.group(5), 'utf-8', 'xmlcharrefreplace')
0
+                                type, description = "", match.group(4) + match.group(5)
0
                             else:
0
-                                type, description = unicode(match.group(2), 'utf-8', 'xmlcharrefreplace'), unicode((match.group(1) + match.group(3)).strip(), 'utf-8', 'xmlcharrefreplace')
0
+                                type, description = match.group(2), (match.group(1) + match.group(3)).strip()
0
 
0
                         else:
0
                             type, description = "", ""
0
@@ -356,9 +356,9 @@ class DocParser(object):
0
 
0
                     if match:
0
                         if match.group(4):
0
-                            type, description = "", unicode(match.group(4) + match.group(5), 'utf-8', 'xmlcharrefreplace')
0
+                            type, description = "", match.group(4) + match.group(5)
0
                         else:
0
-                            type, description = unicode(match.group(2), 'utf-8', 'xmlcharrefreplace'), unicode((match.group(1) + match.group(3)).strip(), 'utf-8', 'xmlcharrefreplace')
0
+                            type, description = match.group(2), (match.group(1) + match.group(3)).strip()
0
                     else:
0
                         type, description = "", ""
0
 
0
@@ -436,8 +436,8 @@ it was empty" % token
0
                 # for the block
0
                 if token and DESCRIPTION not in tokenMap:
0
 
0
-                    token = unicode(token, 'utf-8', 'xmlcharrefreplace')
0
-                    # token.encode('utf-8', 'xmlcharrefreplace')
0
+                    # token = unicode(token, 'utf-8', 'xmlcharrefreplace')
0
+                    ############################ token.encode('utf-8', 'xmlcharrefreplace')
0
                     tokenMap[DESCRIPTION] = [token]
0
                 else: pass # I don't think this can happen any longer
0
 
0
@@ -541,7 +541,7 @@ it was empty" % token
0
 
0
             return target, tokenMap
0
 
0
-        print "DAV: %s" % tokenMap
0
+        # print "DAV: %s" % tokenMap
0
         if FILE_MARKER in tokenMap:
0
             if not FILE_MAP in self.data: self.data[FILE_MAP] = {}
0
             self.currentFile = desc

0
@@ -26,5 +26,5 @@ version="localtest"
0
 
0
 ##############################################################################
0
 
0
-$yuidoc_home/bin/yuidoc.py $parser_in -p $parser_out -o $generator_out -t $template -v $version -s $*
0
+python $yuidoc_home/bin/yuidoc.py $parser_in -p $parser_out -o $generator_out -t $template -v $version -s $*
0