Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/FieldWriter.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/FieldWriter.java
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
equal
deleted
inserted
replaced
| -1:000000000000 | 1:9a66ca7c79fa |
|---|---|
| 1 /* | |
| 2 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. | |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 * | |
| 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 | |
| 7 * published by the Free Software Foundation. Sun designates this | |
| 8 * particular file as subject to the "Classpath" exception as provided | |
| 9 * by Sun in the LICENSE file that accompanied this code. | |
| 10 * | |
| 11 * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 * accompanied this code). | |
| 16 * | |
| 17 * You should have received a copy of the GNU General Public License version | |
| 18 * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 * | |
| 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, | |
| 22 * CA 95054 USA or visit www.sun.com if you need additional information or | |
| 23 * have any questions. | |
| 24 */ | |
| 25 | |
| 26 package com.sun.tools.doclets.internal.toolkit; | |
| 27 | |
| 28 import java.io.*; | |
| 29 import com.sun.javadoc.*; | |
| 30 | |
| 31 /** | |
| 32 * The interface for writing field output. | |
| 33 * | |
| 34 * This code is not part of an API. | |
| 35 * It is implementation that is subject to change. | |
| 36 * Do not use it as an API | |
| 37 * | |
| 38 * @author Jamie Ho | |
| 39 * @since 1.5 | |
| 40 */ | |
| 41 | |
| 42 public interface FieldWriter { | |
| 43 | |
| 44 /** | |
| 45 * Write the header for the field documentation. | |
| 46 * | |
| 47 * @param classDoc the class that the fields belong to. | |
| 48 * @param header the header to write. | |
| 49 */ | |
| 50 public void writeHeader(ClassDoc classDoc, String header); | |
| 51 | |
| 52 /** | |
| 53 * Write the field header for the given field. | |
| 54 * | |
| 55 * @param field the field being documented. | |
| 56 * @param isFirst the flag to indicate whether or not the field is the | |
| 57 * first to be documented. | |
| 58 */ | |
| 59 public void writeFieldHeader(FieldDoc field, boolean isFirst); | |
| 60 | |
| 61 /** | |
| 62 * Write the signature for the given field. | |
| 63 * | |
| 64 * @param field the field being documented. | |
| 65 */ | |
| 66 public void writeSignature(FieldDoc field); | |
| 67 | |
| 68 /** | |
| 69 * Write the deprecated output for the given field. | |
| 70 * | |
| 71 * @param field the field being documented. | |
| 72 */ | |
| 73 public void writeDeprecated(FieldDoc field); | |
| 74 | |
| 75 /** | |
| 76 * Write the comments for the given field. | |
| 77 * | |
| 78 * @param field the field being documented. | |
| 79 */ | |
| 80 public void writeComments(FieldDoc field); | |
| 81 | |
| 82 /** | |
| 83 * Write the tag output for the given field. | |
| 84 * | |
| 85 * @param field the field being documented. | |
| 86 */ | |
| 87 public void writeTags(FieldDoc field); | |
| 88 | |
| 89 /** | |
| 90 * Write the field footer. | |
| 91 */ | |
| 92 public void writeFieldFooter(); | |
| 93 | |
| 94 /** | |
| 95 * Write the footer for the field documentation. | |
| 96 * | |
| 97 * @param classDoc the class that the fields belong to. | |
| 98 */ | |
| 99 public void writeFooter(ClassDoc classDoc); | |
| 100 | |
| 101 /** | |
| 102 * Close the writer. | |
| 103 */ | |
| 104 public void close() throws IOException; | |
| 105 } |
