blob: 5efcc470ccb973253dcd44493f011a39c5dc6f70 [file] [log] [blame]
/*
* Copyright 2003-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.codehaus.groovy.groovydoc;
public interface GroovyDoc extends Comparable {
String commentText();
// GroovyTag[] firstSentenceTags();
String getRawCommentText();
// GroovyTag[] inlineTags();
boolean isAnnotationType();
boolean isAnnotationTypeElement();
boolean isClass();
boolean isConstructor();
boolean isEnum();
boolean isEnumConstant();
boolean isError();
boolean isException();
boolean isField();
boolean isIncluded();
boolean isInterface();
boolean isMethod();
boolean isOrdinaryClass();
String name();
// GroovySourcePosition position();
// GroovySeeTag[] seeTags();
void setRawCommentText(String arg0);
// GroovyTag[] tags();
// GroovyTag[] tags(String arg0);
String firstSentenceCommentText();
}