Added options to make Robodoc more customizable.
[robodoc.git] / UPGRADE
1 $Id: UPGRADE,v 1.16 2006/06/23 20:50:48 gumpu Exp $
2
3 Upgrading to V4.99.26
4     Should work like V4.99.24
5
6 Upgrading to V4.99.24
7     If you use the SOURCE item and use a language
8     that has multiline comments, such as C's  
9         /* this is a comment
10             on two lines */
11     you will have to add a 
12        remark begin markers:
13     and 
14        remark end markers:
15     to your robodoc.rc file.
16
17     ROBODoc has the following ones built-in
18       /*     */
19       (*     *)
20       {*     *}
21       <!--   -->
22
23 Upgrading to V4.99.10
24     Should work like V4.99.6
25
26 Upgrading to V4.99.8
27     Should work like V4.99.6
28
29 Upgrading to V4.99.6
30     Should work like V4.0.18
31
32 Upgrading to V4.0.18
33     Rename the 'extensions:' block in your robodoc.rc
34     file to 'ignore files:' and read the manual about
35     this new block.
36
37 Upgrading to V4.0.12
38     Should work like V4.0.0
39
40 Upgrading to V4.0.6
41     Should work like V4.0.0
42
43 Upgrading to V4.0.1
44     Should work like V4.0.0
45
46 Upgrading to V4.0.0
47     There are many changes compared to V3.2.4:
48     (1) You no longer need a makefile since robodoc
49         can scan a whole directory tree for you.
50         To generate documentation try 
51         ./robodoc -src ./YourSourceDir --dest ./ADocDir --mulitdoc --html
52     (2) The ROBODoc defaults file has been changed.  It is now
53         called robodoc.rc and has a different format.
54         Please see the manual in Docs/ for more information.
55
56 Upgrading to V3.2.4
57     Should work like V3.2.3
58
59 Upgrading to V3.2.3
60     Should work like V3.2.2
61
62 Upgrading to V3.2.2
63     Add the option HTML to all commands that generate a master index file
64     so use:
65
66       robodoc xrefsfile project_master_index INDEX HTML
67
68    instead of
69    
70       robodoc xrefsfile project_master_index INDEX 
71
72
73