8000 Merge pull request #1723 from coreyoconnor/patch-1 · babo/docs.scala-lang@6135edc · GitHub
[go: up one dir, main page]

Skip to content

Commit 6135edc

Browse files
authored
Merge pull request scala#1723 from coreyoconnor/patch-1
Update scaladoc interface docs
2 parents 95ffc19 + 5aa20d9 commit 6135edc

File tree

1 file changed

+2
-29
lines changed

1 file changed

+2
-29
lines changed

_overviews/scaladoc/interface.md

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,43 +12,16 @@ permalink: /overviews/scaladoc/:title.html
1212
Many Scala developers, including those with a great deal of experience, are
1313
unaware of some of the more powerful features of Scaladoc.
1414

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-
2315
## Scaladoc Features in Brief
2416

2517
- The latest Scaladoc for the core Scala libraries can always be found at
2618
[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.
4319
- 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.
4521
- In the title bar, at the very top, is a breadcrumb list of the parent packages
4622
and each package is a link to the package object documentation which sometimes
4723
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
5225
definitions for the current class, trait or object.
5326
- Known subclasses lists all subclasses for this entity within the current
5427
Scaladoc.

0 commit comments

Comments
 (0)
0