You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2013/11/23 19:54:07 UTC
svn commit: r1544863 - in /maven/jxr/trunk:
maven-jxr-plugin/src/main/resources/
maven-jxr/src/main/java/org/apache/maven/jxr/
maven-jxr/src/main/resources/templates/
maven-jxr/src/test/java/org/apache/maven/jxr/
Author: michaelo
Date: Sat Nov 23 18:54:06 2013
New Revision: 1544863
URL: http://svn.apache.org/r1544863
Log:
[JXR-61] Include bottom text in all pages
- Apply same HTML structure to all bottoms
- Do not right align footer because other plugins don't align too
- Pass around the bottom text, though this is bad design. Unfortunately, a lot of params are passed around through methods instead settings them through setters once if they do not be different for every processed file. E.g, inputEncoding, outputEncoding, etc.
Modified:
maven/jxr/trunk/maven-jxr-plugin/src/main/resources/stylesheet.css
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
maven/jxr/trunk/maven-jxr/src/main/resources/templates/overview-summary.vm
maven/jxr/trunk/maven-jxr/src/main/resources/templates/package-summary.vm
maven/jxr/trunk/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java
Modified: maven/jxr/trunk/maven-jxr-plugin/src/main/resources/stylesheet.css
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/main/resources/stylesheet.css?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/main/resources/stylesheet.css (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/main/resources/stylesheet.css Sat Nov 23 18:54:06 2013
@@ -82,9 +82,7 @@ em.comment {
.string {
color: #009;
}
-div#footer {
- text-align:center;
-}
+
#overview {
padding:2px;
}
Modified: maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java (original)
+++ maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java Sat Nov 23 18:54:06 2013
@@ -92,9 +92,10 @@ public class JXR
*
* @param packageManager
* @param source
+ * @param bottom
* @throws IOException
*/
- public void processPath( PackageManager packageManager, String source )
+ public void processPath( PackageManager packageManager, String source, String bottom )
throws IOException
{
this.transformer = new JavaCodeTransform( packageManager );
@@ -130,7 +131,7 @@ public class JXR
if ( isJavaFile( src ) )
{
- transform( src, getDestination( source, src ) );
+ transform( src, getDestination( source, src ), bottom );
}
}
@@ -262,7 +263,7 @@ public class JXR
pkgmgr.process( path );
- processPath( pkgmgr, path );
+ processPath( pkgmgr, path, bottom );
}
// once we have all the source files xref'd, create the index pages
@@ -318,16 +319,18 @@ public class JXR
*
* @param source The java source file
* @param dest The directory to put the HTML into
+ * @param bottom The bottom footer text just as in the package pages
* @throws IOException Thrown if the transform can't happen for some reason.
*/
- private void transform( String source, String dest )
+ private void transform( String source, String dest, String bottom )
throws IOException
{
log.debug( source + " -> " + dest );
// get a relative link to the javadocs
String javadoc = javadocLinkDir != null ? getRelativeLink( dest, javadocLinkDir ) : null;
- transformer.transform( source, dest, locale, inputEncoding, outputEncoding, javadoc, this.revision );
+ transformer.transform( source, dest, locale, inputEncoding, outputEncoding, javadoc,
+ this.revision, bottom );
}
/**
Modified: maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java (original)
+++ maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java Sat Nov 23 18:54:06 2013
@@ -325,12 +325,13 @@ public class JavaCodeTransform
/**
* Gets the footer attribute of the JavaCodeTransform object
+ * @param bottom
*
* @return String
*/
- public final String getFooter()
+ public final String getFooter(String bottom)
{
- return "</pre>\n" + "<hr/>" + "<div id=\"footer\"></div>" + "</body>\n" + "</html>\n";
+ return "</pre>\n" + "<hr/>" + "<div id=\"footer\">"+ bottom + "</div>" + "</body>\n" + "</html>\n";
}
/**
@@ -343,10 +344,11 @@ public class JavaCodeTransform
* @param outputEncoding String
* @param javadocLinkDir String
* @param revision String
+ * @param bottom string
* @throws IOException
*/
public final void transform( Reader sourceReader, Writer destWriter, Locale locale, String inputEncoding,
- String outputEncoding, String javadocLinkDir, String revision )
+ String outputEncoding, String javadocLinkDir, String revision, String bottom )
throws IOException
{
this.locale = locale;
@@ -377,7 +379,7 @@ public class JavaCodeTransform
++linenumber;
}
- out.println( getFooter() );
+ out.println( getFooter(bottom) );
out.flush();
}
@@ -392,10 +394,11 @@ public class JavaCodeTransform
* @param outputEncoding String
* @param javadocLinkDir String
* @param revision String
+ * @param bottom TODO
* @throws IOException
*/
public final void transform( String sourcefile, String destfile, Locale locale, String inputEncoding,
- String outputEncoding, String javadocLinkDir, String revision )
+ String outputEncoding, String javadocLinkDir, String revision, String bottom )
throws IOException
{
this.setCurrentFilename( sourcefile );
@@ -427,7 +430,7 @@ public class JavaCodeTransform
fw = new FileWriter( destfile );
}
- transform( fr, fw, locale, inputEncoding, outputEncoding, javadocLinkDir, revision );
+ transform( fr, fw, locale, inputEncoding, outputEncoding, javadocLinkDir, revision, bottom );
}
catch ( RuntimeException e )
{
Modified: maven/jxr/trunk/maven-jxr/src/main/resources/templates/overview-summary.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/resources/templates/overview-summary.vm?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/main/resources/templates/overview-summary.vm (original)
+++ maven/jxr/trunk/maven-jxr/src/main/resources/templates/overview-summary.vm Sat Nov 23 18:54:06 2013
@@ -86,6 +86,8 @@ under the License.
## Navigation Bar -------- END --------
<hr />
- ${bottom}
+ <div id="footer">
+ ${bottom}
+ </div>
</body>
</html>
\ No newline at end of file
Modified: maven/jxr/trunk/maven-jxr/src/main/resources/templates/package-summary.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/resources/templates/package-summary.vm?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/main/resources/templates/package-summary.vm (original)
+++ maven/jxr/trunk/maven-jxr/src/main/resources/templates/package-summary.vm Sat Nov 23 18:54:06 2013
@@ -89,6 +89,8 @@ under the License.
</div>
## Navigation Bar -------- END --------
<hr />
- ${bottom}
+ <div id="footer">
+ ${bottom}
+ </div>
</body>
</html>
\ No newline at end of file
Modified: maven/jxr/trunk/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java?rev=1544863&r1=1544862&r2=1544863&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java (original)
+++ maven/jxr/trunk/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java Sat Nov 23 18:54:06 2013
@@ -64,7 +64,7 @@ public class JavaCodeTransformTest
multiline comment text
*/ codeTransform.transform( sourceFile.getAbsolutePath(), System.getProperty( "user.dir" ) // additional comment
- + "/target/JavaCodeTransformTest.html", Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "" );
+ + "/target/JavaCodeTransformTest.html", Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "", "" );
assertTrue( /**/ new File( System.getProperty( "user.dir" ), "/target/JavaCodeTransformTest.html" ).exists() );
}
@@ -78,7 +78,7 @@ public class JavaCodeTransformTest
assertTrue( sourceFile.exists() );
codeTransform.transform( sourceFile.getAbsolutePath(), System.getProperty( "user.dir" )
- + "/target/EmptyClass.html", Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "" );
+ + "/target/EmptyClass.html", Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "", "" );
assertTrue( new File( System.getProperty( "user.dir" ), "/target/EmptyClass.html" ).exists() );
}