azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IR] Don't use @sample in generated kdocs

Browse Source 
`@sample` is used for showing usage examples, not the generation
template.

IDEA shows the body of the method referenced in `@sample` in
the class's kdoc, which pollutes the docs with irrelevant code.
This commit is contained in:
Sergej Jaskiewicz
2023-03-15 21:11:40 +01:00
committed by Space Team
parent f96ff6d52d
commit ba5ff7967c
105 changed files with 208 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiler/ir/ir.tree/tree-generator/ReadMe.md
+1 -1
View File
@@ -6,4 +6,4 @@ The generator is run on every build. If you change something in the model or in
The model is declared in [IrTree.kt](src/org/jetbrains/kotlin/ir/generator/IrTree.kt).
You can navigate to the model from a generated `Ir*` class by following the `@sample` link in its kdoc.
You can navigate to the model from a generated `Ir*` class by following the `Generated from` link in its kdoc.