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