(file) Return to PegasusDoc.dxx CVS log (file) (dir) Up to [Pegasus] / pegasus / doc / DevManual

Diff for /pegasus/doc/DevManual/PegasusDoc.dxx between version 1.11 and 1.21

version 1.11, 2001/02/21 01:53:08 version 1.21, 2002/02/16 17:38:44
Line 1 
Line 1 
 /* PegasusDoc.dxx - Top Level file for Developer Documentation. /* PegasusDoc.dxx - Top Level file for Developer Documentation.
 This file defines the document strucuture and provides the introduction This file defines the document strucuture and provides the introduction
         $Log$  
         Revision 1.11  2001/02/21 01:53:08  karl  
         Namespaces stuff  
   
         Revision 1.10  2001/02/20 14:06:05  karl  
         name changes  
   
         Revision 1.9  2001/02/19 21:48:40  karl  
         CIMxx Class and file name chages  
  
         Revision 1.8  2001/02/06 17:02:13  karl          Fixed file name case for use on GNU/Linux:
         rearrange documentation for interfaces              Header file "StopWatch.h" is actually "Stopwatch.h"
               "objectives.dxx" is actually "Objectives.dxx"
               "Architecture.dxx" is actually "architecture.dxx"
               "Components.dxx" is actually "components.dxx"
               "installation.dxx" is actually "Installation.dxx"
               "MOFCompiler.dxx" is actually "MOFcompiler.dxx"
               "CIMObjects.dxx" is actually "cimobjects.dxx"
               "CIMOBJECTTable.dxx" is actually "CIMobjectTable.dxx"
               "Classes.dxx" is actually "classes.dxx"
               "Interfaces.dxx" is actually "interfaces.dxx"
               "FAQ.dxx" is actually "FAQ.DXX"
  
         Revision 1.7  2001/02/05 14:14:00  karl          $Log$
         doc++ extension for respository          Revision 1.21  2002/02/16 17:38:44  kumpf
           Modify Doc++ build environment to support Unix environments.
  
         Revision 1.6  2001/02/02 19:38:23  karl          Revision 1.20  2001/12/13 14:53:21  mike
         add graphic          Merged dev branch into main trunk.
  
         Revision 1.5  2001/02/02 18:48:20  karl          Revision 1.19.2.3  2001/10/05 21:16:41  kumpf
         Doc++ expansion          HP-RK Fix case for platforms with case-sensitive file names.
  
         Revision 1.4  2001/01/30 23:38:18  karl          Revision 1.19.2.2  2001/09/21 05:47:58  karl
         Add to documentation          doc change to TOG formats
  
         Revision 1.3  2001/01/24 17:17:05  karl          Revision 1.19.2.1  2001/09/13 21:29:24  karl
         add Doc++ comments          Update to no Frame work
  
         Revision 1.2  2001/01/24 16:16:38  karl          Revision 1.19  2001/05/27 10:11:50  karl
         Incorporate Doc++ Comments as documentation into .h files          Clean up object tables
  
         Revision 1.1  2001/01/24 14:18:48  karl          Revision 1.18  2001/05/21 17:33:33  karl
         import Dev Doc Files          Update version number
  
  
         $Author$         $Author$
 */ */
 /** @name Pegasus  /* do not change the following Name.  Used in the Frame definition.
   If you change it, the HTML Frame must also be changed.
   */
   /** @name Introduction
  
 <STRONG><B>Welcome to PEGASUS</B></STRONG>  <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>
  
 <P><B>DRAFT FOR REVIEW</B>  <P><B><CENTER>DRAFT FOR REVIEW</CENTER></B>
 <P>Version 0.5, 01/02/02</P>  <SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL>
 <P>Version 0.6  01/04/02 - Clean up the API defintions. and Add repository section.  
 <P>Version 0.7  02/20/02 - Change Class names, Add definitions, Add Architecture documentation.  
  
 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
  
Line 54 
Line 57 
  
 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. 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 manual you should find:  Within this manual you will find:
 <UL> <UL>
 <LI>Information on the installation and operation of the broker and additional components. <LI>Information on the installation and operation of the broker and additional components.
 <LI> A basic defintion of the architecture and function of Pegasus. <LI> A basic defintion of the architecture and function of Pegasus.
Line 63 
Line 66 
 available to interface with Pegasus as providers, consumers, and services. available to interface with Pegasus as providers, consumers, and services.
 </UL> </UL>
  
 <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.  <B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each.
  
 This is not an internals manual for Pegasus.  The Internals for Pegasus developers will be defined in a separate manual that is also available from The Open Group (\URL{http://www.opengroup.org/Management}.  This is not an internals manual for Pegasus.  The Internals for Pegasus developers will be defined in a separate manual that will be available from The Open Group (\URL{http://www.opengroup.org/management}).
  
 NOTE: This a working document today.  It is revised frequently as we learn more about the documentation system and stabilize the Pegasus interfaces.  We apologize for the existing insonsistencies and errors in this working version of the document. NOTE: This a working document today.  It is revised frequently as we learn more about the documentation system and stabilize the Pegasus interfaces.  We apologize for the existing insonsistencies and errors in this working version of the document.
  
 This version of the Pegasus User Manual was created at \today This version of the Pegasus User Manual was created at \today
 */ */
  
 /*  
 Table stuff to see if it worksl  
   
 <table border cellspacing=0 cellpadding=5>  
 <tr>  
 <td colspan=2 rowspan=2></td>  
 <th colspan=2 align=center>Preferences></th>  
 </tr>  
 <tr>  
 <th>Eating Kumquats</th>  
 <th>poke int he eye</th>  
 </tr>  
 </table>  
 */ */
   /* //@Include:DocumentHistory.dxx */
 /* Change list to mvoe this into repository  /* The following is the complete file hiearchy for this document.
     Datetime - Done Comments need more work     We have tried to keep all file references in only this one place
     String - Moved but comments need work     to make modification easier.  In the future, please keep the
     Name     references here and text in the individual files.
     Type  
     Property  
     Reference  
     Value  
     Union  - First comments in  
 */ */
 //@{  
     //@Include: objectives.dxx      //@Include: Objectives.dxx
     //@Include: overview.dxx     //@Include: overview.dxx
     //@Include: credits.dxx     //@Include: credits.dxx
     //@Include: Architecture.dxx      //@Include: architecture.dxx
     //@Include: Components.dxx      //@Include: components.dxx
     //@Include: Utilization.dxx     //@Include: Utilization.dxx
     //@Include: CIMOBJECTS.dxx  
          //@{          //@{
                 //@Include: ..\..\src\Pegasus\Common\Array.h          //@Include: availability.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMClass.h          //@Include: Installation.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMDateTime.h          //@Include: operation.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h          //@Include: CIMClients.dxx
                 //@Include: ..\..\src\Pegasus\Common\String.h          //@Include: PegasusProviders.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMType.h          //@Include: MOFcompiler.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMInstance.h          //@}
                 //@Include: ..\..\src\Pegasus\Common\CIMValue.h      //@Include: programming.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMParameter.h          //@{
                 //@Include: ..\..\src\Pegasus\Common\CIMProperty.h             //@Include: cimobjects.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMScope.h             //@Include: CIMobjectTable.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMReference.h             //@Include: classes.dxx
                 //@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h             //@{
                 //@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h                  //@Include: ../../src/Pegasus/Common/Array.h
                 //@Include: ..\..\src\Pegasus\Common\CIMQualifier.h                  //@Include: ../../src/Pegasus/Common/CIMClass.h
                 //@Include: ..\..\src\Pegasus\Common\CIMName.h                  //@Include: ../../src/Pegasus/Common/CIMDateTime.h
                 //@Include: ..\..\src\Pegasus\Common\CIMMethod.h                  //@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
                 //@Include: ..\..\src\Pegasus\Common\CIMFlavor.h                  //@Include: ../../src/Pegasus/Common/String.h
                 //@Include: ..\..\src\Pegasus\Common\Char16.h                  //@Include: ../../src/Pegasus/Common/CIMType.h
                 //@Include: ..\..\src\Pegasus\Common\DeclContext.h                  //@Include: ../../src/Pegasus/Common/CIMNamedInstance.h
                 //@Include: ..\..\src\Pegasus\Common\Exception.h                  //@Include: ../../src/Pegasus/Common/CIMInstance.h
                   //@Include: ../../src/Pegasus/Common/CIMValue.h
                   //@Include: ../../src/Pegasus/Common/CIMParameter.h
                   //@Include: ../../src/Pegasus/Common/CIMProperty.h
                   //@Include: ../../src/Pegasus/Common/CIMScope.h
                   //@Include: ../../src/Pegasus/Common/CIMReference.h
                   //@Include: ../../src/Pegasus/Common/CIMQualifierList.h
                   //@Include: ../../src/Pegasus/Common/CIMQualifierNames.h
                   //@Include: ../../src/Pegasus/Common/CIMQualifier.h
                   //@Include: ../../src/Pegasus/Common/CIMName.h
                   //@Include: ../../src/Pegasus/Common/CIMMethod.h
                   //@Include: ../../src/Pegasus/Common/CIMFlavor.h
                   //@Include: ../../src/Pegasus/Common/Char16.h
                   //@Include: ../../src/Pegasus/Common/DeclContext.h
                   //@Include: ../../src/Pegasus/Common/Stack.h
                   //@Include: ../../src/Pegasus/Common/CIMName.h
                   //@Include: ../../src/Pegasus/Common/Stopwatch.h
                   //@Include: ../../src/Pegasus/Common/TimeValue.h
   
   
                   //@{
                   //@Include: Exceptions.dxx
                   //@Include: ../../src/Pegasus/Common/Exception.h
                   //@}
               //@}
  
         //@}         //@}
     //@Include: Interfaces.dxx      //@Include: interfaces.dxx
        //@{        //@{
             //@Include: CIMOperations.dxx             //@Include: CIMOperations.dxx
                 //@{                 //@{
                     //@Include: ..\..\src\Pegasus\Common\CIMOperations.h                      //@Include: ../../doc/CIMOperations.h
                 //@}                 //@}
             //@Include: ClientInterfaces.dxx             //@Include: ClientInterfaces.dxx
                 //@{                 //@{
                     //@Include: ..\..\src\Pegasus\Client\CIMClient.h                      //@Include: ../../src/Pegasus/Client/CIMClient.h
                 //@}                 //@}
            //@Include: ProviderInterfaces.dxx            //@Include: ProviderInterfaces.dxx
                 //@{                 //@{
                     //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h  /*                  //@Include: ../../src/Pegasus/Provider/CIMProvider.h */
                       //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMBaseProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMClassProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMPropertyProvider.h
                       //@Include: ../../src/Pegasus/Provider/CIMQueryProvider.h
   
                 //@}                 //@}
            //@Include: ServiceInterfaces.dxx            //@Include: ServiceInterfaces.dxx
            //@Include: RepositoryInterfaces.dxx            //@Include: RepositoryInterfaces.dxx
                 //@{                 //@{
                     //@Include: ..\..\src\Pegasus\Repository\CIMRepository.h                      //@Include: ../../src/Pegasus/Repository/CIMRepository.h
                 //@}                 //@}
        //@}        //@}
  
     //@Include: ProviderWriting.dxx     //@Include: ProviderWriting.dxx
     //@Include: definitions.dxx     //@Include: definitions.dxx
     //@Include: Examples.dxx     //@Include: Examples.dxx
     //@Include: references.dxx  
     //@Include: FAQ.dxx  
 //@}  
  
           //@{
                   //@Include: ExamplesClient.dxx
                   //@Include: ExamplesProvider.dxx
           //@}
       //@Include: references.dxx
       //@Include: FAQ.DXX
  
  

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.21
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2