Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/WriterFactory.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/WriterFactory.java
- changeset 1568
- 5f0731e4e5e6
- parent 1359
- 25e14ad23cef
- child 1606
- ccbe7ffdd867
equal
deleted
inserted
replaced
| 1488:56c97aff46bb | 1568:5f0731e4e5e6 |
|---|---|
| 1 /* | 1 /* |
| 2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. | 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 * | 4 * |
| 5 * This code is free software; you can redistribute it and/or modify it | 5 * This code is free software; you can redistribute it and/or modify it |
| 6 * under the terms of the GNU General Public License version 2 only, as | 6 * under the terms of the GNU General Public License version 2 only, as |
| 7 * published by the Free Software Foundation. Oracle designates this | 7 * published by the Free Software Foundation. Oracle designates this |
| 24 */ | 24 */ |
| 25 | 25 |
| 26 package com.sun.tools.doclets.internal.toolkit; | 26 package com.sun.tools.doclets.internal.toolkit; |
| 27 | 27 |
| 28 import com.sun.javadoc.*; | 28 import com.sun.javadoc.*; |
| 29 import com.sun.tools.javac.jvm.Profile; | |
| 29 import com.sun.tools.doclets.internal.toolkit.util.*; | 30 import com.sun.tools.doclets.internal.toolkit.util.*; |
| 30 | 31 |
| 31 /** | 32 /** |
| 32 * The interface for a factory creates writers. | 33 * The interface for a factory creates writers. |
| 33 * | 34 * |
| 61 * writer is not supported by the doclet. | 62 * writer is not supported by the doclet. |
| 62 */ | 63 */ |
| 63 public abstract PackageSummaryWriter getPackageSummaryWriter(PackageDoc | 64 public abstract PackageSummaryWriter getPackageSummaryWriter(PackageDoc |
| 64 packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) | 65 packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) |
| 65 throws Exception; | 66 throws Exception; |
| 67 | |
| 68 /** | |
| 69 * Return the writer for the profile summary. | |
| 70 * | |
| 71 * @param profile the profile being documented. | |
| 72 * @param prevProfile the previous profile that was documented. | |
| 73 * @param nextProfile the next profile being documented. | |
| 74 * @return the writer for the profile summary. Return null if this | |
| 75 * writer is not supported by the doclet. | |
| 76 */ | |
| 77 public abstract ProfileSummaryWriter getProfileSummaryWriter(Profile | |
| 78 profile, Profile prevProfile, Profile nextProfile) | |
| 79 throws Exception; | |
| 80 | |
| 81 /** | |
| 82 * Return the writer for the profile package summary. | |
| 83 * | |
| 84 * @param packageDoc the profile package being documented. | |
| 85 * @param prevPkg the previous profile package that was documented. | |
| 86 * @param nextPkg the next profile package being documented. | |
| 87 * @param profile the profile being documented. | |
| 88 * @return the writer for the profile package summary. Return null if this | |
| 89 * writer is not supported by the doclet. | |
| 90 */ | |
| 91 public abstract ProfilePackageSummaryWriter getProfilePackageSummaryWriter( | |
| 92 PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg, | |
| 93 Profile profile) throws Exception; | |
| 66 | 94 |
| 67 /** | 95 /** |
| 68 * Return the writer for a class. | 96 * Return the writer for a class. |
| 69 * | 97 * |
| 70 * @param classDoc the class being documented. | 98 * @param classDoc the class being documented. |
