Skip to content

Commit

Permalink
docs(analyzer): Improve PackageManager class documentation
Browse files Browse the repository at this point in the history
Specifically, clarify that the `projectType` does not refer to
dependencies.

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth authored and fviernau committed Dec 18, 2024
1 parent 60b6c4c commit 83a9a58
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions analyzer/src/main/kotlin/PackageManager.kt
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ typealias ManagedProjectFiles = Map<PackageManagerFactory, List<File>>
typealias ProjectResults = Map<File, List<ProjectAnalyzerResult>>

/**
* A class to represent a package manager of the given [managerName] that handles dependencies for the given
* [projectType]. The analysis of any projects and their dependencies starts in the [analysisRoot] directory using the
* given general [analyzerConfig]. Per-repository configuration is passed in [repoConfig].
* A class to represent a package manager with the given [managerName] that handles projects of the given [projectType].
* The analysis of any projects and their dependencies starts in the [analysisRoot] directory using the given
* [analyzerConfig]. Any project-specific configuration stored in the repository is passed as [repoConfig].
*/
abstract class PackageManager(
val managerName: String,
Expand Down

0 comments on commit 83a9a58

Please sign in to comment.