This project is read-only.

CCI Metadata Documentation

CCI Metadata includes conceptual documentation, which provides essential background for using the API, plus a complete API reference.

Conceptual Documentation

This wiki includes the CCI Metadata conceptual documentation, which is divided into three categories, each with its own home page:
  • An Introduction to the Common Compiler Infrastructure provides a general overview of CCI.
  • API Overview contains detailed discussions of key CCI Metadata API elements and concepts. The topics describe the basic programming logic behind each element and how to use the element in applications.
  • Sample Walkthroughs contains walkthroughs based on the CCI Metadata samples. These walkthroughs describe typical application structure and show how to use key API elements.

API Reference Documentation

The CCI Metadata API reference, CCI_Metadata.chm, is in the source tree’s Documentation folder. The CHM is generated from the source tree by SandCastle and includes all available documentation comments. The Documentation folder also includes a SandCastle Help File Builder project file, Metadata.shfbproj. You can use this file to build the CHM yourself and ensure that the reference documentation is fully synchronized with the current state of the source tree.

For directions on how to enlist in the CCI Metadata source tree and how to build the API reference, see Getting Started.

Last edited Jan 22, 2010 at 3:49 PM by Guy_Smith, version 3

Comments

Guy_Smith Dec 17, 2009 at 8:45 PM 
I've just started this wiki, and will continue to add content as I understand the API better. Feedback is welcome. In particular, let me know if there are any topics or samples that you would like me to include.

Guy Smith