jdk-sandbox: comparison src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java

equal deleted inserted replaced

-:6c13f5a67766
+:d001808c57e8
 /*
-* Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
+* Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 import javax.lang.model.element.ElementKind;
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.ModuleElement;
 import javax.lang.model.element.Name;
 import javax.lang.model.element.PackageElement;
+import javax.lang.model.element.QualifiedNameable;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.DeclaredType;
 import javax.lang.model.type.TypeMirror;
 import javax.lang.model.util.SimpleAnnotationValueVisitor9;
 * Generates the HTML document tree and prints it out.
 *
 * @param metakeywords Array of String keywords for META tag. Each element
 *                     of the array is assigned to a separate META tag.
 *                     Pass in null for no array
+* @param description the content for the description META tag.
 * @param includeScript true if printing windowtitle script
 *                      false for files that appear in the left-hand frames
 * @param body the body htmltree to be included in the document
 * @throws DocFileIOException if there is a problem writing the file
 */
-public void printHtmlDocument(List<String> metakeywords, boolean includeScript,
+public void printHtmlDocument(List<String> metakeywords,
-Content body) throws DocFileIOException {
+String description,
-printHtmlDocument(metakeywords, includeScript, new ContentBuilder(), body);
+boolean includeScript,
+Content body)
+throws DocFileIOException {
+printHtmlDocument(metakeywords, description, includeScript, new ContentBuilder(), body);
 }
 /**
 * Generates the HTML document tree and prints it out.
 *
 * @param metakeywords Array of String keywords for META tag. Each element
 *                     of the array is assigned to a separate META tag.
 *                     Pass in null for no array
+* @param description the content for the description META tag.
 * @param includeScript true if printing windowtitle script
 *                      false for files that appear in the left-hand frames
-* @param extraContent any additional content to be included in the HEAD element
+* @param extraHeadContent any additional content to be included in the HEAD element
 * @param body the body htmltree to be included in the document
 * @throws DocFileIOException if there is a problem writing the file
 */
-public void printHtmlDocument(List<String> metakeywords, boolean includeScript, Content extraContent,
+public void printHtmlDocument(List<String> metakeywords,
-Content body) throws DocFileIOException {
+String description,
+boolean includeScript,
+Content extraHeadContent,
+Content body)
+throws DocFileIOException {
 Content htmlComment = contents.newPage;
 Head head = new Head(path, configuration.docletVersion)
 .setTimestamp(!configuration.notimestamp)
+.setDescription(description)
+.setGenerator(getGenerator(getClass()))
 .setTitle(winTitle)
 .setCharset(configuration.charset)
 .addKeywords(metakeywords)
 .setStylesheets(configuration.getMainStylesheet(), configuration.getAdditionalStylesheets())
 .setUseModuleDirectories(configuration.useModuleDirectories)
 .setIndex(configuration.createindex, mainBodyScript)
-.addContent(extraContent);
+.addContent(extraHeadContent);
 Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(), head.toContent(), body);
 HtmlDocument htmlDocument = new HtmlDocument(htmlComment, htmlTree);
 htmlDocument.write(DocFile.createFileForOutput(configuration, path));
 }
 protected TableHeader getPackageTableHeader() {
 return new TableHeader(contents.packageLabel, contents.descriptionLabel);
 }
 /**
+* Generates a string for use in a description meta element,
+* based on an element and its enclosing elements
+* @param prefix a prefix for the string
+* @param elem the element
+* @return the description
+*/
+static String getDescription(String prefix, Element elem) {
+LinkedList<Element> chain = new LinkedList<>();
+for (Element e = elem; e != null; e = e.getEnclosingElement()) {
+// ignore unnamed enclosing elements
+if (e.getSimpleName().length() == 0 && e != elem) {
+break;
+}
+chain.addFirst(e);
+}
+StringBuilder sb = new StringBuilder();
+for (Element e: chain) {
+CharSequence name;
+switch (e.getKind()) {
+case MODULE:
+case PACKAGE:
+name = ((QualifiedNameable) e).getQualifiedName();
+if (name.length() == 0) {
+name = "<unnamed>";
+}
+break;
+default:
+name = e.getSimpleName();
+break;
+}
+if (sb.length() == 0) {
+sb.append(prefix).append(": ");
+} else {
+sb.append(", ");
+}
+sb.append(e.getKind().toString().toLowerCase(Locale.US).replace("_", " "))
+.append(": ")
+.append(name);
+}
+return sb.toString();
+}
+static String getGenerator(Class<?> clazz) {
+return "javadoc/" + clazz.getSimpleName();
+}
+/**
 * Returns an HtmlTree for the SCRIPT tag.
 *
 * @return an HtmlTree for the SCRIPT tag
 */
 protected Script getWinTitleScript() {

changeset 53863	d001808c57e8
parent 53562	0d9dee001667
child 53866	880baf6db17b