|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
|
2 <html> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> |
|
5 <title>API metadata file</title> |
|
6 <link href="../../book.css" type="text/css" rel="stylesheet"> |
|
7 </head> |
|
8 <body> |
|
9 |
|
10 <h2>API metadata file</h2> |
|
11 <p>A metadata file is used to provide information about an Application Programming Interface (API). Metadata files contain the following information of an API, as shown in the example below:</p> |
|
12 <p><code> |
|
13 <?xml version="1.0" ?><br> |
|
14 <api id="16bdb6fdf38e8ced9e907a4eea1f68c5" dataversion="1.0"><br> |
|
15 <name>Phone Parser API</name><br> |
|
16 <description>This API is used to parse and validate phone numbers.</description><br> |
|
17 <type>c++</type><br> |
|
18 <subsystem>commonservices</subsystem><br> |
|
19 <libs><br> |
|
20 <lib name="CommonEngine.lib" /><br> |
|
21 </libs><br> |
|
22 <release category="sdk" sinceversion="2.0"/><br> |
|
23 <attributes><br> |
|
24 <htmldocprovided>yes</htmldocprovided><br> |
|
25 <adaptation>no</adaptation><br> |
|
26 </attributes><br> |
|
27 </api> |
|
28 </code></p> |
|
29 <p>Metadata files are identified by the extension <i>.metaxml</i>. The name of the file comes from the API name and should be the same as the API directory name. For example, if the API directory is <i>phone_parser_api</i>, the corresponding metadata file name should be <i>phone_parser_api.metaxml</i>. The file is located directly under the API's own directory.</p> |
|
30 <p><b>Tip:</b> These files can be created and edited in the Carbide.c++ development environment with the <i>Metadata Editor</i> tool. You can start the tool from the <b>Carbide > Metadata Editor</b> menu.</p> |
|
31 |
|
32 <div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. |
|
33 License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div> |
|
34 </body> |
|
35 </html> |