Skip to content

Commit 2a58ea2

Browse files
committed
Merge pull request scala#4503 from alexeyr/patch-1
Move a Scaladoc sentence to the correct method
2 parents a436e90 + 4afcc2d commit 2a58ea2

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

src/reflect/scala/reflect/api/Symbols.scala

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ trait Symbols { self: Universe =>
228228
throw new ScalaReflectionException(s"$this $msg")
229229
}
230230

231-
/** Used to provide a better error message for `asMethod`
231+
/** Used to provide a better error message for `asMethod`.
232232
*
233233
* @group Tests
234234
*/
@@ -257,7 +257,7 @@ trait Symbols { self: Universe =>
257257
def isClass: Boolean = false
258258

259259
/** Does this symbol represent the definition of a class implicitly associated
260-
* with an object definition (module class in scala compiler parlance).
260+
* with an object definition (module class in scala compiler parlance)?
261261
* If yes, `isType` is also guaranteed to be true.
262262
*
263263
* Note to compiler developers: During the "mixin" phase, trait implementation class symbols
@@ -294,7 +294,7 @@ trait Symbols { self: Universe =>
294294

295295
/** For a class: the module or case class factory with the same name in the same package.
296296
* For a module: the class with the same name in the same package.
297-
* For all others: NoSymbol
297+
* For all others: NoSymbol.
298298
*
299299
* This API may return unexpected results for module classes, packages and package classes.
300300
* Use `companion` instead in order to get predictable results.
@@ -345,7 +345,7 @@ trait Symbols { self: Universe =>
345345
*/
346346
def overrides: List[Symbol]
347347

348-
/** The overloaded alternatives of this symbol
348+
/** The overloaded alternatives of this symbol.
349349
*
350350
* @group Basics
351351
*/
@@ -370,7 +370,7 @@ trait Symbols { self: Universe =>
370370

371371
/** Does this symbol represent a declaration or definition written in a source file as `private[this]`
372372
* or generated in tree/symbol form with the combination of flags LOCAL and PRIVATE?
373-
* If yes, `isPrivate` is guaranteed to be true,
373+
* If yes, `isPrivate` is guaranteed to be true.
374374
*
375375
* @group Tests
376376
*/
@@ -678,7 +678,7 @@ trait Symbols { self: Universe =>
678678
*/
679679
def toTypeIn(site: Type): Type
680680

681-
/** A type reference that refers to this type symbol
681+
/** A type reference that refers to this type symbol.
682682
* Note if symbol is a member of a class, one almost always is interested
683683
* in `asTypeIn` with a site type instead.
684684
*
@@ -727,7 +727,7 @@ trait Symbols { self: Universe =>
727727
*/
728728
def isExistential : Boolean
729729

730-
/** For a polymorphic type, its type parameters, the empty list for all other types
730+
/** For a polymorphic type, its type parameters, the empty list for all other types.
731731
*
732732
* @group Type
733733
*/
@@ -756,12 +756,13 @@ trait Symbols { self: Universe =>
756756
*/
757757
def typeParams: List[Symbol]
758758

759-
/** @see [[paramLists]] */
759+
/** @see [[paramLists]]
760+
*
761+
* The name ending with "ss" indicates that the result type is a list of lists. */
760762
@deprecated("Use `paramLists` instead", "2.11.0")
761763
def paramss: List[List[Symbol]]
762764

763765
/** All parameter lists of the method.
764-
* The name ending with "ss" indicates that the result type is a list of lists.
765766
*
766767
* Can be used to distinguish nullary methods and methods with empty parameter lists.
767768
* For a nullary method, returns the empty list (i.e. `List()`).
@@ -777,7 +778,7 @@ trait Symbols { self: Universe =>
777778
*/
778779
def isVarargs: Boolean
779780

780-
/** The return type of the method
781+
/** The return type of the method.
781782
*
782783
* @group Method
783784
*/
@@ -911,7 +912,7 @@ trait Symbols { self: Universe =>
911912
*/
912913
def superPrefix(supertpe: Type): Type
913914

914-
/** For a polymorphic class/trait, its type parameters, the empty list for all other classes/trait
915+
/** For a polymorphic class/trait, its type parameters, the empty list for all other classes/trait.
915916
*
916917
* @group Class
917918
*/

0 commit comments

Comments
 (0)