3 Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. |
3 Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. |
4 This component and the accompanying materials are made available under the terms of the License |
4 This component and the accompanying materials are made available under the terms of the License |
5 "Eclipse Public License v1.0" which accompanies this distribution, |
5 "Eclipse Public License v1.0" which accompanies this distribution, |
6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". |
6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 |
7 |
|
8 Orb uses the major.minor versioning system. We recommended that the release notes are consulted when there are significant version changes. |
|
9 |
8 Release notes for Orb |
10 Release notes for Orb |
9 ===================== |
11 ===================== |
10 |
12 |
|
13 version 0.2.0 |
|
14 Orb Core |
|
15 Fixed DEFECT 'Links to Example code zip and html files broken in eclipse jar'- examples directory is now lowercase in final jar (build/build.xml build/common.xml) |
|
16 Fixed DEFECT 'Links to Example code zip and html files broken in eclipse jar'- html files now copied over (build.xml) |
|
17 Fixed DEFECT in run_mpdot: was looking for ditaot home in the wrong place. (build.xml) |
|
18 Adding a call to setup the baseline to the main task (build.xml) |
|
19 Adding update of label in sdl toc.xml (build.xml) |
|
20 Adding automated modification of manifest and plugin.xml (build.xml) |
|
21 Adding eclipsehelp generation for mpdot macro nad integrating into main build script. (build.xml common.xml) |
|
22 Fixed path DEFECT in sbs exec adding archiving of build and release dir prior to build (build.xml and common.xml) |
|
23 Can now use transtype=eclipsehelp to generate a single eclipsehelp directory. (common.xml) |
|
24 adding generic dita macro and calling it from build for guide transform (build.xml common.xml properties.txt) |
|
25 Added better cleanup code to build.xml |
|
26 Updated Orb to version 0.6.0 of the DTDs. |
|
27 Added comparative copy script which copies the largest output.xml file of the same name created for each target built. |
|
28 Added check of sbs exec task return code. Fails if return code is not zero or one. |
|
29 Orb Postprocessing |
|
30 Stopped catching parsers.ExpatError as it was causing problems when running tests (doxyidredirect.py lib.py) |
|
31 cxx map sorting now only done when cxxapiref.preprocess.sort.process property is explicity set |
|
32 Added map sorting, doc strings and the ability to read an environment variable to set the logging level. |
|
33 Fixed DEFECT Added comparative copy script which copies the largest output.xml file of the same name created for each target built. |
|
34 Fixed DEFECT using cElementree in guidiser |
|
35 Orb Filter |
|
36 Fixed WhatLogParser so it works if it is passed a line which ends with one or more empty lines (filter_orb.py) |
|
37 Added debug statement to print what is passed to the filter (filter_orb.py) |
|
38 Added the ability to set the log level with an environment variable ORB_LOGGING_LEVEL. See http://docs.python.org/library/logging.html#logging-levels. |
|
39 CXX Specialisation documentation |
|
40 Documented all cxx specialisation elements. This is in both xml for building and html built using the DITA Open Toolkit. |
|
41 Added a small sample of C++ source code, Doxygen output and DITA Open Toolkit output.(cxx sample) |
|
42 Added cxx plugin XSDs |
|
43 Doxygen |
|
44 Added Doxygen binary Doxygen version 1.6.3-20100418_dita_0.1.60 |
|
45 Added version 0.1 of the Orb Architecture document. |
|
46 Added new Doxygen version 1.6.3-20100418_dita_0.1.52 |
|
47 |
11 version 0.1.9 |
48 version 0.1.9 |
12 Fixed bug in FLM: |
49 Fixed DEFECT in FLM: |
13 config.dox files were being created as readonly and failing on attempts to edit. Added a chmod statement to FLM to fix. |
50 config.dox files were being created as readonly and failing on attempts to edit. Added a chmod statement to FLM to fix. |
14 Deleted locations.xml as orb does not need to declare the "tr" for use the flm anymore. (Tested on sbs 2.12.4) |
51 Deleted locations.xml as orb does not need to declare the "tr" for use the flm anymore. (Tested on sbs 2.12.4) |
15 Fixed FLMs to prevent command line buffer overrun with meta.xml and config.dox. (doxygen.flm, doxygen-sdk.flm) |
52 Fixed FLMs to prevent command line buffer overrun with meta.xml and config.dox. (doxygen.flm, doxygen-sdk.flm) |
16 Doxygen version 1.6.2-20100106_dita_0.1.50 |
53 Doxygen version 1.6.2-20100106_dita_0.1.50 |
17 Fix for [#13001] NONSHARABLE_CLASS macro isn't being handled |
54 Fix for [#13001] NONSHARABLE_CLASS macro isn't being handled |
65 System Requirements |
102 System Requirements |
66 =================== |
103 =================== |
67 |
104 |
68 For information on installing all listed below see "install_orb.txt" |
105 For information on installing all listed below see "install_orb.txt" |
69 |
106 |
70 * Symbian Build System v2 version 2.10.0 |
107 * Symbian Build System v2 version 2.10.0 and above |
71 * RVCT 2.2 onwards |
108 * RVCT 2.2 onwards |
72 * epoc32 tree (Symbian Platform SDK/PDK) |
109 * epoc32 tree (Symbian Platform SDK/PDK) |
73 * 1GB memory per Symbian build system thread running doxygen.exe |
110 * 1GB memory per Symbian build system thread running doxygen.exe |
74 * 8GB free disk space |
111 * 8GB free disk space |
75 |
112 |
76 Known issues v0.1.9 |
113 Known issues v0.2.0 |
77 =================== |
114 =================== |
78 Missing content |
115 Missing content |
79 --------------- |
116 --------------- |
80 Some classes have no members. Doxygen is handling macros in implementation files but not those in #included files. |
|
81 |
|
82 Library and header information missing. Library information is not in Orb output. Header information would need to be resolved by first collecting all cxxFileRef |
|
83 elements and then combining that to be able to create links to headers. |
|
84 |
117 |
85 Some global functions in libc not appearing in final content. e.g. clearerr is built by doxygen in libc target with it's comment from the dosc file, but does not appear in the final |
118 Some global functions in libc not appearing in final content. e.g. clearerr is built by doxygen in libc target with it's comment from the dosc file, but does not appear in the final |
86 documentation. |
119 documentation. |
87 |
120 |
88 Enum members missing. Appears to be partially fixed. Some documents contain the first private enum, but not the second public anonymous enum. |
121 Enum members missing. Appears to be partially fixed. Some documents contain the first private enum, but not the second public anonymous enum. |
89 |
122 |
90 Misplaced content |
123 If a class declaration has more than one base class, only the first class is shown. This appears to be a limitation |
91 ----------------- |
124 in the XML. |
92 There is an issue with content in the wrong components. Critically this leaves some libraries empty. |
|
93 |
|
94 Doxygen tag support |
|
95 ------------------- |
|
96 Tags currently not supported which should be are listed below: |
|
97 @see |
|
98 @pre |
|
99 @post |
|
100 @p |
|
101 @c |
|
102 @exception |
|
103 @verbatim |
|
104 @panic |
|
105 @code |
|
106 |
125 |
107 |
126 |
108 |
127 |
109 |
128 |
110 |
129 |
111 |
130 |
112 |
131 |
113 |
|
114 |
|