MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

IDEA-265654: add doc comments

Browse Source 
GitOrigin-RevId: 13e3a675d9c07f59c3818d346fb22c1a72e52dd1
This commit is contained in:
Anastasia Ivanova
2021-04-15 05:59:26 +03:00
committed by intellij-monorepo-bot
parent 7b5f6d8cf5
commit b79bd97e08
2 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/statistics/src/com/intellij/internal/statistic/IdeActivity.kt
+2 -1
View File
@@ -16,7 +16,8 @@ private val LOG = Logger.getInstance(IdeActivity::class.java)
internal enum class IdeActivityState { NOT_STARTED, STARTED, FINISHED }
@Deprecated("Use com.intellij.internal.statistic.StructuredIdeActivity instead")
@Deprecated("Use com.intellij.internal.statistic.StructuredIdeActivity instead. " +
"It allows us to generate events scheme from the product code and ensures that only data matching the scheme is being sent.")
@ApiStatus.Internal
class IdeActivity @JvmOverloads constructor(private val projectOrNullForApplication: Project?,
private val group: String,
platform/statistics/src/com/intellij/internal/statistic/StructuredIdeActivity.kt
+12
View File
@@ -15,6 +15,18 @@ import java.util.concurrent.atomic.AtomicInteger
private val LOG = Logger.getInstance(StructuredIdeActivity::class.java)
/**
* New style API to record information about process.
* It allows you to record start/finish events, calculate duration and link them by common id.
*
* To record a process:
* - Register ide activity in event log group (see [com.intellij.internal.statistic.eventLog.EventLogGroup.registerIdeActivity]).
* - Use [com.intellij.internal.statistic.IdeActivityDefinition.started] or
* [com.intellij.internal.statistic.IdeActivityDefinition.startedAsync] to record start event and
* [com.intellij.internal.statistic.StructuredIdeActivity.finished] to record finish event.
*
* See example in dev-guide/fus-collectors.md.
*/
@ApiStatus.Internal
class StructuredIdeActivity internal constructor(private val projectOrNullForApplication: Project?,
private val ideActivityDefinition: IdeActivityDefinition) {