WEBVTT

1
00:00:00.228 --> 00:00:03.000
Earlier in the module I showed you how to view

2
00:00:03.001 --> 00:00:05.116
documentation for a class in BlueJ.

3
00:00:06.008 --> 00:00:08.002
BlueJ uses the Java dot tool 

4
00:00:08.004 --> 00:00:09.225
to generate that documentation.

5
00:00:10.119 --> 00:00:13.007
In this demo I'm going to use the Java dot tool 

6
00:00:13.110 --> 00:00:15.224
at the command line to generate documentation 

7
00:00:15.226 --> 00:00:18.115
for all the classes in the adventure game programme.

8
00:00:20.114 --> 00:00:22.223
I have a folder containing the source files

9
00:00:22.226 --> 00:00:24.119
and the compiled class files 

10
00:00:24.222 --> 00:00:26.228
for all the classes in the programme.

11
00:00:28.116 --> 00:00:30.114
The java dot command is available

12
00:00:30.116 --> 00:00:33.223
if you have the Java SDK installed on your computer.

13
00:00:34.220 --> 00:00:38.009
I can use the command by typing javadoc

14
00:00:39.115 --> 00:00:42.115
Now I want to specify a folder or directory

15
00:00:42.119 --> 00:00:45.008
where the documentation will be generated

16
00:00:45.110 --> 00:00:47.117
so I use the option minus d

17
00:00:47.229 --> 00:00:50.008
and then the name of a folder.

18
00:00:50.225 --> 00:00:51.119
And that means 

19
00:00:51.221 --> 00:00:53.227
the documentation will be stored in a folder

20
00:00:53.229 --> 00:00:56.115
called docs within my current folder.

21
00:00:58.113 --> 00:01:01.005
I can use a wildcard to specify that 

22
00:01:01.007 --> 00:01:04.111
all the classes in the current folder will be documented

23
00:01:04.228 --> 00:01:06.008
and then press return.

24
00:01:06.228 --> 00:01:09.006
And the documentation is generated.

25
00:01:09.114 --> 00:01:12.114
A list of folder contents again you can see 

26
00:01:12.118 --> 00:01:15.008
that there's now a folder called docs.

27
00:01:16.115 --> 00:01:18.112
If I change to that folder

28
00:01:19.227 --> 00:01:21.223
and list the contents of that

29
00:01:21.229 --> 00:01:26.221
you can see that this is a set of html files or web pages.

29
00:01:29.006 --> 00:01:30.222
I've now opened the homepage, 

30
00:01:30.223 --> 00:01:34.112
index.html of the documentation in my browser

31
00:01:35.000 --> 00:01:36.224
and you can see that it looks very similar to the

32
00:01:36.226 --> 00:01:38.119
Java API documentation 

33
00:01:38.221 --> 00:01:40.224
we looked at earlier in the module.

33
00:01:42.003 --> 00:01:43.227
The classes are listed on the left

34
00:01:44.002 --> 00:01:46.110
and the detailed documentation for each class 

35
00:01:46.111 --> 00:01:48.117
is shown on the main pane on the right.

36
00:01:49.007 --> 00:01:52.002
For example let's look at the Room class we can see 

37
00:01:52.004 --> 00:01:54.115
the documentation for the constructors

38
00:01:54.228 --> 00:01:56.004
and the methods 

39
00:01:56.112 --> 00:01:59.117
and we can click on any of the method names to see

40
00:01:59.222 --> 00:02:03.002
the more detailed documentation for the methods.