sl@0: // Copyright (c) Symbian Software Ltd 2006-2007. All rights reserved.
sl@0: 
sl@0: // Description:		Content Access Framework Doygen Readme file
sl@0: // Location:		caf2/docs_internal/dox
sl@0: 
sl@0: 
sl@0: This folder holds the Doxygen files needed to build the Compiled HTML Help file 
sl@0: that documents the CAF2 APIs.
sl@0: 
sl@0: 
sl@0: // ----------------------------------------------------
sl@0: // Pre-requisites for building the documentation
sl@0: // ----------------------------------------------------
sl@0: 
sl@0: Windows PC with:
sl@0: 
sl@0: o DOxygen 1.4.6 or later, 
sl@0: 	http://www.stack.nl/~dimitri/doxygen/
sl@0: o Graphviz 2.8 or later, 
sl@0: 	http://www.graphviz.org/
sl@0: o Microsoft HTML Help Workshop 4.74 or later,  
sl@0: 	http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
sl@0:  
sl@0: 
sl@0: // ----------------------------------------------------
sl@0: // Build Procedure
sl@0: // ----------------------------------------------------
sl@0: 
sl@0: This section shows how to create the 'CAF_Documentation.chm' file.
sl@0: Use the caf2\docs_internal\dox\builddox.bat or the procedure below.
sl@0: 
sl@0: 1. Open a command window and change directory to the caf2\docs_internal component folder.
sl@0: 2. Create the 'output' folder with the command: mkdir dox\output
sl@0: 3. Make sure 'CAF_documentation.chm' is not read-only (i.e. Open for Edit in Perforce)
sl@0: 4. Execute:  del /S /F /Q dox\output\*.*
sl@0: 5. Execute:	 doxygen dox\Doxyfile.cfg > doxygen.log 2>&1
sl@0: 6. Review the doxygen.log for errors/warnings that need fixing
sl@0: 7. Clean up and remove the dox.log file and output folder.
sl@0: 8. Documentation is now ready!
sl@0: 
sl@0: TIP: If Doxygen is failing to pick up image files specified with the @image tag, try
sl@0: emptying the 'output' folder and rebuilding.
sl@0: 
sl@0: TIP: You can also the Doxygen wizard to configure and execute the configuration file.
sl@0: