Browse Source

added license and logging to indexgen

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@273982 13f79535-47bb-0310-9956-ffa450edef68
master
Erik Hatcher 22 years ago
parent
commit
af891549ea
2 changed files with 69 additions and 10 deletions
  1. +1
    -1
      proposal/xdocs/build.xml
  2. +68
    -9
      proposal/xdocs/src/org/apache/tools/ant/xdoclet/IndexGen.java

+ 1
- 1
proposal/xdocs/build.xml View File

@@ -465,7 +465,7 @@
classpath="${build.dir}/classes"
classname="org.apache.tools.ant.xdoclet.IndexGen"
/>
<indexgen rootdir="${build.dir}/docs/manual" destdir="${build.dir}/docs/manual"/>
<indexgen rootdir="${build.dir}/docs/manual"/>
</target>

<target name="docs-from-scratch" depends="clean,gen,docs,indexgen"/>


+ 68
- 9
proposal/xdocs/src/org/apache/tools/ant/xdoclet/IndexGen.java View File

@@ -1,3 +1,57 @@
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/

package org.apache.tools.ant.xdoclet;

import org.apache.tools.ant.Task;
@@ -7,21 +61,18 @@ import java.io.File;
import java.io.FileWriter;
import java.io.IOException;

/**
* Quick and dirty index.html generator for proposal/xdocs
*
* @author Erik Hatcher
*/
public class IndexGen extends Task {
private File destDir;
private File rootDir;

public void setDestDir(File destDir) {
this.destDir = destDir;
}


public void setRootDir(File rootDir) {
this.rootDir = rootDir;
}



public void execute() throws BuildException {
String[] categories = rootDir.list();

@@ -29,6 +80,9 @@ public class IndexGen extends Task {
sb.append("<html><head><title>xdocs index</title></head>");
sb.append("<body>");

int catCount = 0;
int taskCount = 0;

for (int i=0; i < categories.length; i++) {
String category = categories[i];
File catDir = new File(rootDir, category);
@@ -37,6 +91,8 @@ public class IndexGen extends Task {
continue;
}

catCount++;

sb.append("<h2>" + category + "</h2>");

sb.append("<ul>");
@@ -44,6 +100,7 @@ public class IndexGen extends Task {
String[] tasks = catDir.list();

for (int j=0; j < tasks.length; j++) {
taskCount++;
String task = tasks[j];
sb.append("<li>");
sb.append("<a href=\"" + category + "/" + task + "\">" + task + "</a>");
@@ -58,11 +115,13 @@ public class IndexGen extends Task {

FileWriter fw = null;
try {
fw = new FileWriter(new File(destDir,"index.html"));
fw = new FileWriter(new File(rootDir,"index.html"));
fw.write(sb.toString());
fw.close();
} catch (IOException e) {
throw new BuildException(e);
}

log("Index generated: " + catCount + " categories and " + taskCount + " tasks");
}
}

Loading…
Cancel
Save