@@ -12,43 +12,16 @@ permalink: /overviews/scaladoc/:title.html
12
12
Many Scala developers, including those with a great deal of experience, are
13
13
unaware of some of the more powerful features of Scaladoc.
14
14
15
- The quickest way to find out about some of these is to check out this
16
- tutorial video:
17
-
18
- <iframe width =" 560 " height =" 315 " src =" https://www.youtube.com/embed/GQxUEAXX_fE " frameborder =" 0 " allowfullscreen ></iframe >
19
-
20
- However, if you are in a hurry and just want a few pointers to things you
21
- may not have known about already, here are a few key points.
22
-
23
15
## Scaladoc Features in Brief
24
16
25
17
- The latest Scaladoc for the core Scala libraries can always be found at
26
18
[ https://www.scala-lang.org/api/current ] ( https://www.scala-lang.org/api/current ) .
27
- - The search box on the top left narrows the list of classes to those that
28
- match a string search to your typing, use this to home in quickly on the class,
29
- trait or object you are trying to find.
30
- - The letters underneath the search box list all fields, methods and other
31
- tokens found during the creation of the Scaladoc. E.g. if you want to find
32
- where the ` .reverse ` method you are using is defined, click on ** R** in the
33
- list of letters there, and then find in page to locate the ` .reverse ` method and
34
- the list of implementing classes/traits.
35
- - The small icons on the left of the list of classes denote object ` O ` , class ` C `
36
- and/or trait ` T ` . Two icons show that this class or trait has a companion as
37
- well. Clicking on the ` O ` takes you directly to the companion object instead
38
- of the class or trait.
39
- - The same (but larger) icons at the top of the right pane in the title indicate
40
- the same information (i.e. you are looking at the class, trait or object). If
41
- the icon has a "peel over" corner on it, clicking will flip you between the
42
- class/trait and its companion.
43
19
- Methods and values may have information folded away that can be accessed by
44
- clicking on the triangle to the left of the definition .
20
+ activating that items box. This box is indicated by a blue stripe on the left .
45
21
- In the title bar, at the very top, is a breadcrumb list of the parent packages
46
22
and each package is a link to the package object documentation which sometimes
47
23
holds an overview of the package or API as a whole.
48
- - You can use the Hide and Focus links next to the packages to ignore a package
49
- you no longer want to see in searches, or to concentrate only on that package
50
- for searches.
51
- - By expanding linear supertypes triangle, you can see the linearized trait
24
+ - By expanding linear supertypes section, you can see the linearized trait
52
25
definitions for the current class, trait or object.
53
26
- Known subclasses lists all subclasses for this entity within the current
54
27
Scaladoc.
0 commit comments