Skip to content

Commit cab18d0

Browse files
committed
Fix docs indentation
1 parent d376905 commit cab18d0

File tree

1 file changed

+67
-66
lines changed

1 file changed

+67
-66
lines changed

library/src/scala/tasty/Reflection.scala

Lines changed: 67 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,9 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
274274
type TypeBoundsTree = internal.TypeBoundsTree
275275

276276
/** Type tree representing wildcard type bounds written in the source.
277-
* The wildcard type `_` (for example in in `List[_]`) will be a type tree that
278-
* represents a type but has `TypeBound`a inside.
279-
*/
277+
* The wildcard type `_` (for example in in `List[_]`) will be a type tree that
278+
* represents a type but has `TypeBound`a inside.
279+
*/
280280
type WildcardTypeTree = internal.WildcardTypeTree
281281

282282
/** Branch of a pattern match or catch clause */
@@ -367,10 +367,10 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
367367

368368

369369
/** Import selectors:
370-
* * SimpleSelector: `.bar` in `import foo.bar`
371-
* * RenameSelector: `.{bar => baz}` in `import foo.{bar => baz}`
372-
* * OmitSelector: `.{bar => _}` in `import foo.{bar => _}`
373-
*/
370+
* * SimpleSelector: `.bar` in `import foo.bar`
371+
* * RenameSelector: `.{bar => baz}` in `import foo.{bar => baz}`
372+
* * OmitSelector: `.{bar => _}` in `import foo.{bar => _}`
373+
*/
374374
type ImportSelector = internal.ImportSelector
375375
type SimpleSelector = internal.SimpleSelector
376376
type RenameSelector = internal.RenameSelector
@@ -395,8 +395,8 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
395395
type Constant = internal.Constant
396396

397397
/** Symbol of a definition.
398-
* Then can be compared with == to know if the definition is the same.
399-
*/
398+
* Then can be compared with == to know if the definition is the same.
399+
*/
400400
type Symbol = internal.Symbol
401401

402402
/** FlagSet of a Symbol */
@@ -675,19 +675,19 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
675675
object Ref {
676676

677677
/** Create a reference tree from a symbol
678-
*
679-
* If `sym` refers to a class member `foo` in class `C`,
680-
* returns a tree representing `C.this.foo`.
681-
*
682-
* If `sym` refers to a local definition `foo`, returns
683-
* a tree representing `foo`.
684-
*
685-
* @note In both cases, the constructed tree should only
686-
* be spliced into the places where such accesses make sense.
687-
* For example, it is incorrect to have `C.this.foo` outside
688-
* the class body of `C`, or have `foo` outside the lexical
689-
* scope for the definition of `foo`.
690-
*/
678+
*
679+
* If `sym` refers to a class member `foo` in class `C`,
680+
* returns a tree representing `C.this.foo`.
681+
*
682+
* If `sym` refers to a local definition `foo`, returns
683+
* a tree representing `foo`.
684+
*
685+
* @note In both cases, the constructed tree should only
686+
* be spliced into the places where such accesses make sense.
687+
* For example, it is incorrect to have `C.this.foo` outside
688+
* the class body of `C`, or have `foo` outside the lexical
689+
* scope for the definition of `foo`.
690+
*/
691691
def apply(sym: Symbol)(given ctx: Context): Ref =
692692
internal.Ref_apply(sym)
693693
}
@@ -1804,7 +1804,7 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
18041804

18051805
/**
18061806
* An accessor for `scala.internal.MatchCase[_,_]`, the representation of a `MatchType` case.
1807-
*/
1807+
*/
18081808
def MatchCaseType(given Context): Type = {
18091809
import scala.internal.MatchCase
18101810
Type(classOf[MatchCase[_,_]])
@@ -2028,15 +2028,16 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
20282028
* this symbol to the DefDef constructor.
20292029
*
20302030
* @note As a macro can only splice code into the point at which it is expanded, all generated symbols must be
2031-
* direct or indirect children of the reflection context's owner. */
2031+
* direct or indirect children of the reflection context's owner.
2032+
*/
20322033
def newMethod(parent: Symbol, name: String, tpe: Type)(given ctx: Context): Symbol =
20332034
newMethod(parent, name, tpe, Flags.EmptyFlags, noSymbol)
20342035

20352036
/** Works as the other newMethod, but with additional parameters.
20362037
*
20372038
* @param flags extra flags to with which the symbol should be constructed
20382039
* @param privateWithin the symbol within which this new method symbol should be private. May be noSymbol.
2039-
* */
2040+
*/
20402041
def newMethod(parent: Symbol, name: String, tpe: Type, flags: Flags, privateWithin: Symbol)(given ctx: Context): Symbol =
20412042
internal.Symbol_newMethod(parent, name, flags, tpe, privateWithin)
20422043

@@ -2194,12 +2195,12 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
21942195
extension signatureOps on (sig: Signature) {
21952196

21962197
/** The signatures of the method parameters.
2197-
*
2198-
* Each *type parameter section* is represented by a single Int corresponding
2199-
* to the number of type parameters in the section.
2200-
* Each *term parameter* is represented by a String corresponding to the fully qualified
2201-
* name of the parameter type.
2202-
*/
2198+
*
2199+
* Each *type parameter section* is represented by a single Int corresponding
2200+
* to the number of type parameters in the section.
2201+
* Each *term parameter* is represented by a String corresponding to the fully qualified
2202+
* name of the parameter type.
2203+
*/
22032204
def paramSigs: List[String | Int] = internal.Signature_paramSigs(sig)
22042205

22052206
/** The signature of the result type */
@@ -2217,8 +2218,8 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
22172218
object defn extends StandardSymbols with StandardTypes
22182219

22192220
/** Defines standard symbols (and types via its base trait).
2220-
* @group API
2221-
*/
2221+
* @group API
2222+
*/
22222223
trait StandardSymbols {
22232224

22242225
/** The module symbol of root package `_root_`. */
@@ -2315,8 +2316,8 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
23152316
def Array_update: Symbol = internal.Definitions_Array_update
23162317

23172318
/** A dummy class symbol that is used to indicate repeated parameters
2318-
* compiled by the Scala compiler.
2319-
*/
2319+
* compiled by the Scala compiler.
2320+
*/
23202321
def RepeatedParamClass: Symbol = internal.Definitions_RepeatedParamClass
23212322

23222323
/** The class symbol of class `scala.Option`. */
@@ -2332,23 +2333,23 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
23322333
def ProductClass: Symbol = internal.Definitions_ProductClass
23332334

23342335
/** Function-like object that maps arity to symbols for classes `scala.FunctionX`.
2335-
* - 0th element is `Function0`
2336-
* - 1st element is `Function1`
2337-
* - ...
2338-
* - Nth element is `FunctionN`
2339-
*/
2336+
* - 0th element is `Function0`
2337+
* - 1st element is `Function1`
2338+
* - ...
2339+
* - Nth element is `FunctionN`
2340+
*/
23402341
def FunctionClass(arity: Int, isImplicit: Boolean = false, isErased: Boolean = false): Symbol =
23412342
internal.Definitions_FunctionClass(arity, isImplicit, isErased)
23422343

23432344
/** Function-like object that maps arity to symbols for classes `scala.TupleX`.
2344-
* - 0th element is `NoSymbol`
2345-
* - 1st element is `NoSymbol`
2346-
* - 2st element is `Tuple2`
2347-
* - ...
2348-
* - 22nd element is `Tuple22`
2349-
* - 23nd element is `NoSymbol` // TODO update when we will have more tuples
2350-
* - ...
2351-
*/
2345+
* - 0th element is `NoSymbol`
2346+
* - 1st element is `NoSymbol`
2347+
* - 2st element is `Tuple2`
2348+
* - ...
2349+
* - 22nd element is `Tuple22`
2350+
* - 23nd element is `NoSymbol` // TODO update when we will have more tuples
2351+
* - ...
2352+
*/
23522353
def TupleClass(arity: Int): Symbol =
23532354
internal.Definitions_TupleClass(arity)
23542355

@@ -2357,28 +2358,28 @@ class Reflection(private[scala] val internal: CompilerInterface) { self =>
23572358
internal.Definitions_isTupleClass(sym)
23582359

23592360
/** Contains Scala primitive value classes:
2360-
* - Byte
2361-
* - Short
2362-
* - Int
2363-
* - Long
2364-
* - Float
2365-
* - Double
2366-
* - Char
2367-
* - Boolean
2368-
* - Unit
2369-
*/
2361+
* - Byte
2362+
* - Short
2363+
* - Int
2364+
* - Long
2365+
* - Float
2366+
* - Double
2367+
* - Char
2368+
* - Boolean
2369+
* - Unit
2370+
*/
23702371
def ScalaPrimitiveValueClasses: List[Symbol] =
23712372
UnitClass :: BooleanClass :: ScalaNumericValueClasses
23722373

23732374
/** Contains Scala numeric value classes:
2374-
* - Byte
2375-
* - Short
2376-
* - Int
2377-
* - Long
2378-
* - Float
2379-
* - Double
2380-
* - Char
2381-
*/
2375+
* - Byte
2376+
* - Short
2377+
* - Int
2378+
* - Long
2379+
* - Float
2380+
* - Double
2381+
* - Char
2382+
*/
23822383
def ScalaNumericValueClasses: List[Symbol] =
23832384
ByteClass :: ShortClass :: IntClass :: LongClass :: FloatClass :: DoubleClass :: CharClass :: Nil
23842385

0 commit comments

Comments
 (0)