GroovyPackageDoc (groovy 2.4.4 API)

org.codehaus.groovy.groovydoc.GroovyDoc

All Superinterfaces:

GroovyDoc

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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.

Methods Summary

Methods
Type	Name and description
`GroovyClassDoc[]`	`allClasses()` All included classes and interfaces in this package.
`GroovyClassDoc[]`	`allClasses(boolean filter)` All classes and interfaces in this package optionally limited to just the included ones.
`String`	`description()` Description of the package.
`GroovyClassDoc[]`	`enums()` Included enum types in this package.
`GroovyClassDoc[]`	`errors()` Included errors in this package.
`GroovyClassDoc[]`	`exceptions()` Included exceptions in this package.
`GroovyClassDoc`	`findClass(String className)` Find a class or interface within this package.
`String`	`getRelativeRootPath()`
`GroovyClassDoc[]`	`interfaces()` Included interfaces in this package.
`String`	`nameWithDots()`
`GroovyClassDoc[]`	`ordinaryClasses()` Included ordinary classes in this package.
`String`	`summary()` The one-sentence summary for the package derived from the beginning of the description.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface GroovyDoc`	`commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText`
`interface Comparable`	`compareTo`

- Method Detail
  - public GroovyClassDoc[] allClasses()
    
    All included classes and interfaces in this package.
    Returns:
    array of classes and interfaces found or empty array if none found
  - public GroovyClassDoc[] allClasses(boolean filter)
    
    All classes and interfaces in this package optionally limited to just the included ones.
    Parameters:
    filter - Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.
    Returns:
    array of classes and interfaces found or empty array if none found
  - public String description()
    
    Description of the package.
    Returns:
    the description
  - public GroovyClassDoc[] enums()
    
    Included enum types in this package.
    Returns:
    array of enum types found or empty array if none found
  - public GroovyClassDoc[] errors()
    
    Included errors in this package.
    Returns:
    array of errors found or empty array if none found
  - public GroovyClassDoc[] exceptions()
    
    Included exceptions in this package.
    Returns:
    array of exceptions found or empty array if none found
  - public GroovyClassDoc findClass(String className)
    
    Find a class or interface within this package.
    Parameters:
    className - the name of the class to find
    Returns:
    ClassDoc of found class or interface, or null if not found
  - public String getRelativeRootPath()
  - public GroovyClassDoc[] interfaces()
    
    Included interfaces in this package.
    Returns:
    array of interfaces found or empty array if none found
  - public String nameWithDots()
  - public GroovyClassDoc[] ordinaryClasses()
    
    Included ordinary classes in this package.
    Returns:
    array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
  - public String summary()
    
    The one-sentence summary for the package derived from the beginning of the description.
    Returns:
    the summary

Summary:
Method

| Detail:
Method

[Java] Interface GroovyPackageDoc

Methods Summary

Inherited Methods Summary

Method Detail

public GroovyClassDoc[] allClasses()

public GroovyClassDoc[] allClasses(boolean filter)

public String description()

public GroovyClassDoc[] enums()

public GroovyClassDoc[] errors()

public GroovyClassDoc[] exceptions()

public GroovyClassDoc findClass(String className)

public String getRelativeRootPath()

public GroovyClassDoc[] interfaces()

public String nameWithDots()

public GroovyClassDoc[] ordinaryClasses()

public String summary()