1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/readme.txt	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,45 @@
     1.4 +// Copyright (c) Symbian Software Ltd 2006-2007. All rights reserved.
     1.5 +
     1.6 +// Description:		Content Access Framework Doygen Readme file
     1.7 +// Location:		caf2/docs_internal/dox
     1.8 +
     1.9 +
    1.10 +This folder holds the Doxygen files needed to build the Compiled HTML Help file 
    1.11 +that documents the CAF2 APIs.
    1.12 +
    1.13 +
    1.14 +// ----------------------------------------------------
    1.15 +// Pre-requisites for building the documentation
    1.16 +// ----------------------------------------------------
    1.17 +
    1.18 +Windows PC with:
    1.19 +
    1.20 +o DOxygen 1.4.6 or later, 
    1.21 +	http://www.stack.nl/~dimitri/doxygen/
    1.22 +o Graphviz 2.8 or later, 
    1.23 +	http://www.graphviz.org/
    1.24 +o Microsoft HTML Help Workshop 4.74 or later,  
    1.25 +	http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
    1.26 + 
    1.27 +
    1.28 +// ----------------------------------------------------
    1.29 +// Build Procedure
    1.30 +// ----------------------------------------------------
    1.31 +
    1.32 +This section shows how to create the 'CAF_Documentation.chm' file.
    1.33 +Use the caf2\docs_internal\dox\builddox.bat or the procedure below.
    1.34 +
    1.35 +1. Open a command window and change directory to the caf2\docs_internal component folder.
    1.36 +2. Create the 'output' folder with the command: mkdir dox\output
    1.37 +3. Make sure 'CAF_documentation.chm' is not read-only (i.e. Open for Edit in Perforce)
    1.38 +4. Execute:  del /S /F /Q dox\output\*.*
    1.39 +5. Execute:	 doxygen dox\Doxyfile.cfg > doxygen.log 2>&1
    1.40 +6. Review the doxygen.log for errors/warnings that need fixing
    1.41 +7. Clean up and remove the dox.log file and output folder.
    1.42 +8. Documentation is now ready!
    1.43 +
    1.44 +TIP: If Doxygen is failing to pick up image files specified with the @image tag, try
    1.45 +emptying the 'output' folder and rebuilding.
    1.46 +
    1.47 +TIP: You can also the Doxygen wizard to configure and execute the configuration file.
    1.48 +