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.9
    Fixed bug in FLM: 
        config.dox files were being created as readonly and failing on attempts to edit. Added a chmod statement to FLM to fix.
    Deleted locations.xml as orb does not need to declare the "tr" for use the flm anymore. (Tested on sbs 2.12.4)
	Fixed FLMs to prevent command line buffer overrun with meta.xml and config.dox. (doxygen.flm, doxygen-sdk.flm)
    Doxygen version 1.6.2-20100106_dita_0.1.50
        Fix for [#13001] NONSHARABLE_CLASS macro isn't being handled
        Tesed on esockserver OK.
    Critical Defects Fixed in release:
        Classes in wrong components
        many missings intem/broken links
        S60 Public and Platform APIs not built by SBS
        50 targets not built (FLM error) including openenvcore libc.
        Classic ui not appearing in the library.
    Fixed defect: Return arguments mising (for functions that don't return void)
        
version 0.1.8
	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.9
===================
Missing content
---------------
Some classes have no members. Doxygen is handling macros in implementation files but not those in #included files. 

Library and header information missing. Library information is not in Orb output. Header information would need to be resolved by first collecting all cxxFileRef
elements and then combining that to be able to create links to headers.

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
documentation.

Enum members missing. Appears to be partially fixed. Some documents contain the first private enum, but not the second public anonymous enum.

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

Doxygen tag support
-------------------
Tags currently not supported which should be are listed below:
@see
@pre
@post
@p
@c
@exception
@verbatim
@panic
@code