Skip to content

Commit

Permalink
Kdoc: more details abuot what classpath is searched by Resolver
Browse files Browse the repository at this point in the history
Kdoc only change. 

See #1075
  • Loading branch information
martinbonnin authored and ting-yuan committed Oct 29, 2024
1 parent 2f1f62c commit ab35821
Showing 1 changed file with 6 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@ interface Resolver {
fun getAllFiles(): Sequence<KSFile>

/**
* Get all symbols with specified annotation.
* Get all symbols with specified annotation in the current compilation unit.
* Note that in multiple round processing, only symbols from deferred symbols of last round and symbols from newly generated files will be returned in this function.
*
* @param annotationName is the fully qualified name of the annotation; using '.' as separator.
* @param inDepth whether to check symbols in depth, i.e. check symbols from local declarations. Operation can be expensive if true.
* @return Elements annotated with the specified annotation.
*
* @see getDeclarationsFromPackage to get declarations outside the current compilation unit.
*/
fun getSymbolsWithAnnotation(annotationName: String, inDepth: Boolean = false): Sequence<KSAnnotated>

Expand Down Expand Up @@ -231,6 +233,9 @@ interface Resolver {

/**
* Returns declarations with the given package name.
*
* getDeclarationsFromPackage looks for declaration in the whole classpath, including dependencies.
*
* @param packageName the package name to look up.
* @return A sequence of [KSDeclaration] with matching package name.
* This will return declarations from both dependencies and source.
Expand Down

0 comments on commit ab35821

Please sign in to comment.