From cf5af0f7ea3d479be141d18cec03b1f16ddb8535 Mon Sep 17 00:00:00 2001
From: Dmitriy Novozhilov <dmitriy.novozhilov@jetbrains.com>
Date: Wed, 12 May 2021 14:38:25 +0300
Subject: [PATCH] [FIR] Add KDoc to FirModuleData

---
 .../org/jetbrains/kotlin/fir/FirModuleData.kt | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/compiler/fir/tree/src/org/jetbrains/kotlin/fir/FirModuleData.kt b/compiler/fir/tree/src/org/jetbrains/kotlin/fir/FirModuleData.kt
index c73f5be0615..e0e40d6b5db 100644
--- a/compiler/fir/tree/src/org/jetbrains/kotlin/fir/FirModuleData.kt
+++ b/compiler/fir/tree/src/org/jetbrains/kotlin/fir/FirModuleData.kt
@@ -5,10 +5,40 @@
 
 package org.jetbrains.kotlin.fir
 
+import org.jetbrains.kotlin.fir.declarations.FirDeclaration
 import org.jetbrains.kotlin.name.Name
 import org.jetbrains.kotlin.platform.TargetPlatform
 import org.jetbrains.kotlin.resolve.PlatformDependentAnalyzerServices
 
+/**
+ * [FirModuleData] is an abstraction over modules module inside FIR compiler.
+ *
+ * Each FIR declaration holds module data in [FirDeclaration.moduleData], and this module data represents
+ *   module which this declaration belongs to
+ *
+ * Module data contains minimal information about module ([name] and [platform]) and
+ *   number of collections with different kinds of dependencies of current module.
+ * There are three different kinds of dependencies:
+ *   - [dependencies] are just regular dependencies. Current module can reference public declarations from them
+ *   - [friendDependencies] are dependencies with friend relation. Current module can reference public and internal
+ *       declarations from them
+ *   - [dependsOnDependencies] are special kind of dependencies which came from MPP project model. Current module can reference
+ *       public and internal declarations from them (like from friends) and also can actualize `common` declarations from them
+ *       with corresponding `actual` declarations
+ *
+ * Each module data should belong to some [FirSession], but some FirSessions can have multiple module data. Basically, there are
+ *   two main kinds of FirSession: session for module with sources and session for binary dependencies. Each source session must
+ *   have exactly one module data which represents corresponding module (and it is accessible via [FirSession.moduleData] extension).
+ *   Libraries sessions may have multiple module data for different kinds of dependencies (one for regular, friend and depends dependencies
+ *   set), and it's impossible to extract any module data from such session.
+ *
+ * Mental model for libraries sessions and module data:
+ *   Each klib/jar/smth else in binary dependency may be added to project with one of three kinds which are declared above, so we need
+ *   different module data for them. But for deserializing declarations from dependencies we should use single provider to reduce number
+ *   of IO operations and false matches. To solve this problem we use single session for all dependencies with single deserialized
+ *   symbol provider. And during creation FIR for some declaration symbol provider chose which module this declaration will belong to
+ *   basing on path of this declaration and passed compiler arguments
+ */
 abstract class FirModuleData : FirSessionComponent {
     abstract val name: Name
     abstract val dependencies: List<FirModuleData>