KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > jmi > javamodel > JavaDoc


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.jmi.javamodel;
21
22 /**
23  * JavaDoc object instance interface.
24  * Object representation of JavaDoc.
25  *
26  * <p><em><strong>Note:</strong> This type should not be subclassed or implemented
27  * by clients. It is generated from a MOF metamodel and automatically implemented
28  * by MDR (see <a HREF="http://mdr.netbeans.org/">mdr.netbeans.org</a>).</em></p>
29  */
30 public interface JavaDoc extends org.netbeans.jmi.javamodel.Element {
31     /**
32      * Returns the value of attribute text.
33      * JavaDoc text.
34      * @return Value of attribute text.
35      */
36     public java.lang.String JavaDoc getText();
37     /**
38      * Sets the value of text attribute. See {@link #getText} for description
39      * on the attribute.
40      * @param newValue New value to be set.
41      */
42     public void setText(java.lang.String JavaDoc newValue);
43     /**
44      * Returns the value of attribute tags.
45      * Tags used in this JavaDoc instance.
46      * @return Value of tags attribute. Element type: {@link org.netbeans.jmi.javamodel.TagValue}
47      */
48     public java.util.List JavaDoc/*<org.netbeans.jmi.javamodel.TagValue>*/ getTags();
49 }
50
Popular Tags