yui / yuidoc

YUI Javascript Documentation Tool — Read more

This URL has Read+Write access

left nav module links corrected to used the cleansed module name [fixes 
#2173322].

apm (author)

Mon Jul 06 13:18:45 -0700 2009

commit f95e78e3aea4d374165da84e8cf34004be9034a7
tree 8426d3e8f5d5e1e9ecd0f0e5b1b0dfc817294170
parent c4382388aed6188dffc6e4e5d67bbfb198a6cec6

M	bin/yuidoc_generate.py	5 •••••
M	template/main.tmpl	3 •••
M	test/lang.sh	3 •••
M	test/lang/cs/test.cs	2 ••
M	test/lang/java/test.java	2 ••
M	test/lang/perl/test.pl	2 ••
M	test/lang/php/test.php	2 ••
M	test/lang/ruby/test.rb	2 ••

bin/yuidoc_generate.py

0
@@ -89,6 +89,10 @@ class DocGenerator(object):
0
         self.modules = d[MODULES]
0
         self.modulenames = self.modules.keys()
0
         self.modulenames.sort(lambda x,y: cmp(x.lower(), y.lower()))
0
+        self.cleansedmodulenames = {} 
0
+
0
+        for mod in self.modulenames:
0
+            self.cleansedmodulenames[mod] = self.cleanseStr(mod)
0
 
0
         self.cleansedmodulename = self.cleanseStr(self.modulename)
0
     
0
@@ -127,6 +131,7 @@ class DocGenerator(object):
0
             template.version      = self.version
0
             template.modules      = self.modules
0
             template.modulenames  = self.modulenames
0
+            template.cleansedmodulenames  = self.cleansedmodulenames
0
             template.modulename   = self.modulename
0
             template.moduletitle = self.moduletitle
0
             template.cleansedmodulename = self.cleansedmodulename

template/main.tmpl

0
@@ -583,7 +583,8 @@
0
                                 #if $moduledef == $modulename
0
                                     #set $css = "selected"
0
                                 #end if
0
-                                <li class="$css"><a href="module_${moduledef}.html" title="$moduledef">$moduledef</a></li>
0
+                                #set $cleansedname = $cleansedmodulenames[$moduledef]
0
+                                <li class="$css"><a href="${cleansedname}.html" title="$moduledef">$moduledef</a></li>
0
                             #end for
0
                         </ul>
0
                     </div>

test/lang.sh

0
@@ -20,7 +20,8 @@ yuidoc_home=..
0
 #          $src/node \
0
 #          $src/queue \
0
 #          $src/yui"
0
-#parser_in="$src"
0
+
0
+# parser_in="lang"
0
 parser_in="lang/java lang/python lang/perl lang/ruby"
0
  
0
 # The location to output the parser data.  This output is a file containing a

test/lang/cs/test.cs

0
@@ -1,7 +1,7 @@
0
 using System;
0
 /**
0
 * C# Module Description
0
-* @module csharp
0
+* @module lang.csharp
0
 */
0
 
0
 /**

test/lang/java/test.java

0
@@ -1,6 +1,6 @@
0
 /**
0
 * Test Java Module Description
0
-* @module javatest
0
+* @module lang.javatest
0
 */
0
 import java.util.*;
0

test/lang/perl/test.pl

0
@@ -2,7 +2,7 @@
0
 =begin
0
 /**
0
 * Test Perl File
0
-* @module perltest
0
+* @module lang.perltest
0
 */
0
 =cut
0
 use strict;

test/lang/php/test.php

0
@@ -1,7 +1,7 @@
0
 <?php
0
 /**
0
  * General Module description for PHPTest
0
- * @module phptest
0
+ * @module lang.phptest
0
  */
0
 
0

test/lang/ruby/test.rb

0
@@ -3,7 +3,7 @@
0
 =begin
0
 /**
0
 * Module Info for test Ruby File
0
-* @module rubytest
0
+* @module lang.rubytest
0
 */
0
 =end
0

Comments

Please log in to comment.