Orb/RELEASE.txt
author Michel Szarindar <Michel.Szarindar@Nokia.com>
Thu, 18 Mar 2010 18:26:18 +0000
changeset 1 82f11024044a
parent 0 42188c7ea2d9
permissions -rw-r--r--
Contribution of a new version of ORB and CXX DITA plug-in bug 1461 bug 1621 bug 1962

License
=======
Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved.
This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html".

Release notes for Orb
================================================
version 0.1.7
	Updates to Doxygen (Doxygen version 1.6.2-20100106_dita_0.1.26-Doxygen version 1.6.2-20100106_dita_0.1.45)
		Fixed defect - links to inherited members are to the wrong file.
		Added option: CLEAR_INCLUDE_CACHE - This clears the include cache after each component has been read so that the include files will be read again. 
		Fixed generate 0.5.0 DOCTYPE declarations.
		Removed flushing of include cache as this was correct but expensive.
		#define CLEAR_G_ALLINCLUDES 0
		Updated DTDs to version 0.5.0
		Added esock_dll generated by Doxygen version 1.6.2-20100106_dita_0.1.38
		Fixes for removing duplicates when #including.
		Aligned with version 0.5 of the DTDs.
		Added -d includes to dump out the include graph.
		DTDs updated to verison 0.5.0.
		Fixed DITA generator so that cxxInterface etc. is not written out.
		Major fix to improve linking to #included files.
		Added XML_DITA_OMIT_DUPLICATE_MEMBERS = YES to doxtemplate.txt
	
version 0.1.6
    Updates to Doxygen (Doxygen version 1.6.2-20100106_dita_0.1.18-Doxygen version 1.6.2-20100106_dita_0.1.24)
        Updated to create more compatible Dita Open Toolkit output
        Updated with option to not omit classes with incomplete function definitions (by default it does)
        keyref attributes now href attributes (conditionally compiled)
    Updates to Post Processing:
        XSLT for transforming Doxygen output to DITA Reference dtd updated for better formating in Dita Open toolkit
        Updated for more informative logging on stdout/stderr during post processing
        Updated toolchain to partially support cross referencing
        Included map creation support for non-distributed system definition 3 files
        
version 0.1.5.1
	Doxygen version 1.6.2-20100106_dita_0.1.15
        Fixed bug in element prefix creator that was generating spurious element names.
        Added addittional file extensions for Symbian like code.
        Fixed memory leak.
        Added extra reporting.
    Added error checking to post processing batch script and ditaot/mode option
    Updated file renamer to support dita open toolkit file names
    Updated guidiser to support dita open toolkit ids
    
System Requirements
===================

For information on installing all listed below see "install_orb.txt"

* Symbian Build System v2 version 2.10.0
* RVCT 2.2 onwards
* epoc32 tree (Symbian Platform SDK/PDK)
* 1GB memory per Symbian build system thread running doxygen.exe
* 8GB free disk space

Known issues v0.1.7
===================
Missing content
---------------
Some classes have no members. There are approximately 1600 exported classes using the NONSHARABLE_CLASS macro. Doxygen is handling macros in 
implementation files but not those in #included files. 

Still losing whole components due to DITA-OT memory issues. This results in large groups of missing links.

Misplaced content
-----------------
There is an issue with content in the wrong components. Critically this leaves some libraries empty.

Potential issues
----------------
There are still out of memory issues in DITA-OT, which are exacerbated by the “classes in wrong components” issue that is causing the maps 
of some components to be larger than they should be.

Missing targets
---------------
Missing targets caused by command lines that are too long. Orb outputs a file (meta.xml) which outputs all the includes using echo. 
Unfortunately there is a character limit on the command line so the entire echo doesn't get printed which means that the file is invalid.