annotate src/main/groovy/org/ssdt_ohio/gradle/tasks/UserDocTemplateInfo.groovy @ 14:9de72de14ab3

USASR-1307: customize CSS and override class template
author Dave Smith <smith@nwoca.org>
date Tue, 10 Dec 2013 23:24:56 +0000
parents
children b3282a66cc05
rev   line source
14
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
1 /*
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
2 * Copyright (c) 2013. Ohio Department of Education. - All Rights Reserved.
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
3 * Unauthorized copying of this file, in any medium, is strictly prohibited.
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
4 * Written by State Software Development Team (http://ssdt.oecn.k12.oh.us/)
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
5 */
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
6
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
7 package org.ssdt_ohio.gradle.tasks
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
8
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
9
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
10 class UserDocTemplateInfo {
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
11
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
12 private static final String USERDOC_BASEDIR = "org/ssdt_ohio/gradle/userdoc/templates/";
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
13
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
14 private static final String TEMPLATE_BASEDIR = "org/codehaus/groovy/tools/groovydoc/gstringTemplates/";
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
15 private static final String DOCGEN_BASEDIR = "org/codehaus/groovy/tools/";
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
16 public static final String[] DEFAULT_DOC_TEMPLATES = [ // top level templates
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
17 TEMPLATE_BASEDIR + "topLevel/index.html",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
18 TEMPLATE_BASEDIR + "topLevel/overview-frame.html", // needs all package names
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
19 TEMPLATE_BASEDIR + "topLevel/allclasses-frame.html", // needs all packages / class names
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
20 TEMPLATE_BASEDIR + "topLevel/overview-summary.html", // needs all packages
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
21 TEMPLATE_BASEDIR + "topLevel/help-doc.html",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
22 TEMPLATE_BASEDIR + "topLevel/index-all.html",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
23 TEMPLATE_BASEDIR + "topLevel/deprecated-list.html",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
24 USERDOC_BASEDIR + "stylesheet.css", // copy default one, may override later
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
25 TEMPLATE_BASEDIR + "topLevel/inherit.gif",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
26 DOCGEN_BASEDIR + "groovy.ico",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
27 ]
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
28
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
29 public static final String[] DEFAULT_PACKAGE_TEMPLATES = [ // package level templates
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
30 TEMPLATE_BASEDIR + "packageLevel/package-frame.html",
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
31 TEMPLATE_BASEDIR + "packageLevel/package-summary.html"
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
32 ]
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
33
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
34 public static final String[] DEFAULT_CLASS_TEMPLATES = [ // class level templates
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
35 USERDOC_BASEDIR + "classDocName.html"
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
36 ]
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
37
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
38
9de72de14ab3 USASR-1307: customize CSS and override class template
Dave Smith <smith@nwoca.org>
parents:
diff changeset
39 }