1 License

     2 =======

     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 

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

     7 

     8 Orb Files

     9 =========

    10 Directory tree          Description

    11 --------------          -----------

    12 +---ant                 Ant scripts to transform cxxApiRef dtd xml to dita reference xml.

    13 +---bin                 Preexisisting symbian build system directory. doxygen.exe is copied here and the batch script to transform output to dita reference and produce ditamaps.

    14 |   \---MapCreator      A tool for creating ditamaps from system definition files.

    15 +---CxxApiRef2Dita      xslt and ant scripts to perform the cxxApiRef to dita reference conversion.

    16 +---documentation       Additional documentation about converting output to dita reference dtd and how to generate and use a system definition file with Orb.

    17 +---lib                 Preexisisting symbian build system directory. Orb adds a doxygen configuration to the Symbian Build System so that it can run Doxygen.

    18 \---python              Preexisisting symbian build system directory.

    19     \---doxygen         Python scripts that are used by the map creation and transform scripts

    20 

    21 Installation

    22 ============

    23 For installation instructions please read INSTALL.txt

    24 

    25 Running Orb on my project

    26 =========================

    27 

    28 Once Orb is installed, open a console, change directory to the folder containing the bld.inf and mrp file for your project and run

    29 

    30 sbs -c doxygen

    31 

    32 You can also run it with a .dox extension to your existing configuration. e.g.

    33 

    34 sbs -c arm.v7.rvct4_0.dox

    35 sbs -c rvct3_0.dox

    36 sbs -c armv5_urel.dox

    37 

    38 The documentation for your project will be created in the \epoc32\build\release on your system. 

    39 

    40 The documentation will conform to the cxx DITA dtd specialisation and will need to be converted to 

    41 to xml that conforms to standard DITA reference xml to be processed by the Dita Open Toolkit.

    42 For more information on performing this conversion please see documentation\converting_to_reference.txt.

    43 

    44 Output

    45 ======

    46 Orb builds output to the epoc32 directory under the location indicated by the EPOCROOT environment variable.

    47 The two locations are epoc32\builds and epoc32\release\dita. The builds directory contains the temporary output

    48 that doxygen produces as it runs on all the targets of the Symbian OS. There is one directory per component

    49 and each component directory contains the doxygen output for the documentation for each dll or executable 

    50 target being built. The release directory contains the output of every target copied to a single directory

    51 to remove duplicates.

    52 The script that converts the cxx dita output from doxygen to dita reference requires the release\dita directory.

    53 Its outputs files to epoc32\release\ditareference and epoc32\release\maps.

    54 

    55 Additional documentation

    56 ========================

    57 Some additional documents have been included in the directory named documentation

    58 For a guide on converting doxygen dita output to dita reference and producing dita maps please see 

    59 converting_to_reference.txt 

    60 For a guide on generating and using a system definition version 3 with Orb please see

    61 sysdefv3_guide.txt

    62 For doxygen documentation please see DoxygenDITAEditionUserGuide.chm