Return to apidoc.dxx CVS log

Up to [Pegasus] / pegasus / doc / apidoc

Correct list of header files in the public API documentation and modify the outline of the documentation

/* api.dxx - Top Level file for Developer api Documentation.
This file defines the document strucuture and provides the introduction

	$Author: karl $
*/
/* do not change the following Name.  Used in the Frame definition.
If you change it, the HTML Frame must also be changed.
*/
/** @name Introduction

<CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>

<P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
<SMALL><CENTER>version 1.01 13 September 2003, Pegasus 2.3</CENTER></SMALL>

Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.

<B>This Document</B>

<P>This is a working document that is the temporary user and developers manual for the Pegasus CIM Server implementation which is being created by the OpenGroup Enterprise Management Program Group.

This manual serves as both a manual for installation and operation of the prototype version of Pegasus and a manual for developing components to attach to Pegasus. In addition to the manual, we keep current working information in a set of README files within the Pegasus distributions. Please consult these files also.

Within this document you will find:
<UL>
<LI>definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs
<LI> Information on the status of these APIs (frozen, experimental, etc.)
<LI> Usage examples of the APIs with the defintions.
</UL>
*/

/* The following is the complete file hiearchy for this document.
   We have tried to keep all file references in only this one place
   to make modification easier.  In the future, please keep the
   references here and text in the individual files.
   
TBD: Pegasus API version information
*/

/** @name Pegasus CIM Objects and Common Function APIs
	NOTE: This needs to be reorganized to take into account a structure for these APIs 
*/    
        //@{
        /// @name Classes for CIM Objects and Containers
           //@{ 
		//@Include: ../../src/Pegasus/Common/Array.h
		//@Include: ../../src/Pegasus/Common/ArrayInter.h
		//@Include: ../../src/Pegasus/Common/Boolean.h
		//@Include: ../../src/Pegasus/Common/CIMClass.h
		//@Include: ../../src/Pegasus/Common/CIMDateTime.h
		//@Include: ../../src/Pegasus/Common/CIMFlavor.h
		//@Include: ../../src/Pegasus/Common/CIMIndication.h
		//@Include: ../../src/Pegasus/Common/CIMInstance.h
		//@Include: ../../src/Pegasus/Common/CIMMethod.h
		//@Include: ../../src/Pegasus/Common/CIMName.h
		//@Include: ../../src/Pegasus/Common/CIMObject.h
		//@Include: ../../src/Pegasus/Common/CIMObjectPath.h
		//@Include: ../../src/Pegasus/Common/CIMParamValue.h
		//@Include: ../../src/Pegasus/Common/CIMParameter.h
		//@Include: ../../src/Pegasus/Common/CIMProperty.h
		//@Include: ../../src/Pegasus/Common/CIMPropertyList.h
		//@Include: ../../src/Pegasus/Common/CIMQualifier.h
		//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
		//@Include: ../../src/Pegasus/Common/CIMQualifierList.h
		//@Include: ../../src/Pegasus/Common/CIMScope.h
		//@Include: ../../src/Pegasus/Common/CIMStatusCode.h
		//@Include: ../../src/Pegasus/Common/CIMType.h
		//@Include: ../../src/Pegasus/Common/CIMValue.h
		//@Include: ../../src/Pegasus/Common/Char16.h
		//@Include: ../../src/Pegasus/Common/Config.h
		//@Include: ../../src/Pegasus/Common/String.h
		//@Include: ../../src/Pegasus/Common/CIMIndication.h
	    //@}
        /// @name Classes General Functionality
           //@{ 
		//@Include: ../../src/Pegasus/Common/OperationContext.h
		//@Include: ../../src/Pegasus/Common/ResponseHandler.h
		//@Include: ../../src/Pegasus/Common/SSLContext.h
            //@}
       /// @name Exceptions
            //@{
        	//@Include: ../../src/Pegasus/Common/Exception.h
            //@}
       //@}
    /// @name ClientInterfaces
       //@{
	    /** @name Pegasus Operations
	    NOTE That this section should probably go away
	    */
	        //@{
		    //@Include: ../../doc/CIMOperations.h
		//@}
	    /// @name Pegasus Client CIM Operation and Connection Interfaces   
		//@{    
		    //@Include: ../../src/Pegasus/Client/CIMClient.h
		//@}
	    /// @name Pegasus Client SLP interfaces   
		//@{    
		    //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
		    //@Include: ../../src/Pegasus/Client/CIMServerDescription.h
		    //@Include: ../../src/Pegasus/Client/Attribute.h
		//@}
	    /// @name Pegasus Listener Interfaces   
		//@{    
		    //@Include: ../../src/Pegasus/Listener/CIMListener.h
		//@}
       //@}
   /// @name Pegasus Provider Interfaces
	//@{
	    /// Pegasus CIM Provider Types and Interfaces
	        //@{
			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h
			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
	        //@}  	 
	    /// Pegasus CIM Provider  CIMOM Handle Callback
	      //@{ 
		//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
	        //@}  	 
	    /// Pegasus CIM Provider Exceptions
	      //@{ 
		//@Include: ../../src/Pegasus/Provider/ProviderException.h
	      //@}  	 
	//@}  	 
/** @name Document References

This section will contain references to external documents.

NOTE: documents we must reference include:

<UL>
	<LI>DMTF Specifications
	<LI>
</UL/
*/    //@Include: references.dxx