summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorkumpf <kumpf>2008-08-11 21:44:45 +0000
committerkumpf <kumpf>2008-08-11 21:44:45 +0000
commit2da20f3ab12923febee317b89c688df4fb43981e (patch)
treec4eaef2cd3d18820c87cd5a5d3ea1feb6c950186 /doc
parent3e595862d2a9b7f091f95451d583b2f860c7c683 (diff)
downloadtog-pegasus-2da20f3ab12923febee317b89c688df4fb43981e.zip
tog-pegasus-2da20f3ab12923febee317b89c688df4fb43981e.tar.gz
tog-pegasus-2da20f3ab12923febee317b89c688df4fb43981e.tar.xz
BUG#: 4311
TITLE: pegasus/doc/apidoc directory is obsolete DESCRIPTION: Remove obsolete files.
Diffstat (limited to 'doc')
-rw-r--r--doc/apidoc/Makefile53
-rw-r--r--doc/apidoc/PageFooter.html11
-rw-r--r--doc/apidoc/apidoc.dxx258
-rw-r--r--doc/apidoc/doc++.conf154
-rw-r--r--doc/apidoc/pageheader.html40
5 files changed, 0 insertions, 516 deletions
diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile
deleted file mode 100644
index 45c2958..0000000
--- a/doc/apidoc/Makefile
+++ /dev/null
@@ -1,53 +0,0 @@
-#//%2006////////////////////////////////////////////////////////////////////////
-#//
-#// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
-#// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
-#// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
-#// IBM Corp.; EMC Corporation, The Open Group.
-#// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
-#// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
-#// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
-#// EMC Corporation; VERITAS Software Corporation; The Open Group.
-#// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
-#// EMC Corporation; Symantec Corporation; The Open Group.
-#//
-#// Permission is hereby granted, free of charge, to any person obtaining a copy
-#// of this software and associated documentation files (the "Software"), to
-#// deal in the Software without restriction, including without limitation the
-#// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-#// sell copies of the Software, and to permit persons to whom the Software is
-#// furnished to do so, subject to the following conditions:
-#//
-#// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
-#// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
-#// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-#// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-#// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-#// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-#// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-#// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#//
-#//==============================================================================
-ROOT = $(PEGASUS_ROOT)
-PROGRAM_NAME=apidoc
-
-DIR = $(PROGRAM_NAME)
-include $(ROOT)/mak/config.mak
-
-DOC_ROOT = $(ROOT)/doc
-DOC_DIR = $(DOC_ROOT)/$(DIR)
-DOC_OUTPUT = $(HOME_DIR)/$(DIR)html
-DOC_HEAD = $(PROGRAM_NAME).dxx
-
-all:
- $(RM) $(DOC_OUTPUT)/*
- docxx --dir $(DOC_OUTPUT) --verbose -H $(DOC_HEAD)
- $(COPY) $(DOC_DIR)/*.gif $(DOC_OUTPUT)
- $(COPY) $(DOC_DIR)/*.htm $(DOC_OUTPUT)
- $(COPY) $(DOC_DIR)/*.html $(DOC_OUTPUT)
- $(COPY) $(DOC_DIR)/*.shtml $(DOC_OUTPUT)
-clean:
- $(RM) $(DOC_OUTPUT)/*
-depend:
-
-tests:
diff --git a/doc/apidoc/PageFooter.html b/doc/apidoc/PageFooter.html
deleted file mode 100644
index 8c2557e..0000000
--- a/doc/apidoc/PageFooter.html
+++ /dev/null
@@ -1,11 +0,0 @@
-</td>
- </tr>
-</table>
-<div align="center">
- <h5>
- <!--#include virtual="/includes/main-footer.htm" --></h5>
-</div>
-
-</body>
-
-</html> \ No newline at end of file
diff --git a/doc/apidoc/apidoc.dxx b/doc/apidoc/apidoc.dxx
deleted file mode 100644
index a5e12aa..0000000
--- a/doc/apidoc/apidoc.dxx
+++ /dev/null
@@ -1,258 +0,0 @@
-/** @name Pegasus API Documentation
-
-
-<CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>
-
-<P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
-<SMALL><CENTER>version 1.01 30 October 2003, Pegasus 2.3</CENTER></SMALL>
-
-<p> This document was produced on \date .</p>
-
-<P>This is a working document that contains the interfaces for the Pegasus
-CIM Server implementation. This is created by the OpenGroup
-Enterprise Management Program Group.
-<p>Within this document, you will find the following:</p>
-<UL>
-<LI> An introduction to the public APIs defined and used in Pegasus in the \Ref{Introduction} section.
-<LI>A definition of the public APIs defined for the current version of Pegasus including
- <ul>
- <li>the client APIs \Ref{Client Interfaces}
- <li>The CIM Object Manager APIs (see \Ref{} includng both the Pegasus object equivalent to
- the CIM Objects(see \Ref{} and other server service APIs (\Ref{}) that have been
- made public.
- <li>the APIs required by provider writers to create Pegasus C++ providers in section \Ref{Providers}.
- <li>Common term definitions (See \Ref{Glossary}).
- </u.>
-<LI>Information on the status of these APIs (frozen, experimental, etc.).
-<LI> Usage examples of many of the APIs with the defintions.
-</UL>
-
-This API documentation is not a tutorial on Pegasus or a developers guide.
-<p>In addition to this documentation, Pegasus has a Users' Guide that
-specifies overview information and how to set up and install Pegasus. In
-addition to the manual, the README files contain specific information to
-aide you in when working with Pegasus and its documentation.</p>
-
-@memo Public API reference document for the Pegasus CIM Object Manager
-implementation.
-
-*/
-/* api.dxx - Top Level file for Developer api Documentation.
-This file defines the document strucuture and provides the introduction
-*/
-
-
-//@{
-/** @name Introduction
-
-
-The APIs documented here are those that are considered frozen and that we expect
-not to change within minor releases of Pegasus. It is an objective of Pegasus
-to keep these APIs frozen as long as Pegasus remains at the version 2.x revision
-level so that providers written for any 2.x Pegasus will run in environments that
-use the same or higher level revisions.
-
-Note that Pegasus does extend and add new APIs to the publically available API set
-most releases as new functionality is defined. Typically these are marked experimental
-for the first release so that developers can be made aware that they may change. Once
-they have been tested and used, the experimental qualifications will be removed and they
-become part of the Pegasus public API set.
-
-REVIEWERS: more on versions.
-*/
-//@{
-
-
-/// @name Common API Characteristics
-
-//@{
-
-/** @name Shared Classes.
-A shared class consists of a pointer to a shared data block that
-contains a reference count and the data.
-
-When a shared object is created, it sets the reference count to 1. The
-reference count is incremented whenever a new object references the shared
-data, and decremented when the object dereferences the shared data. The
-shared data is deleted when the reference count becomes zero.
-
-When dealing with shared objects, there are two ways of copying an object.
-We usually speak about deep and shallow copies. A deep copy implies
-duplicating an object. A shallow copy is a reference copy, i.e. just a
-pointer to a shared data block. Making a deep copy can be expensive in
-terms of memory and CPU. Making a shallow copy is very fast, because it
-only involves setting a pointer and incrementing the reference count.
-
-Object assignment (with operator=()) for implicitly and explicitly shared
-objects is implemented using shallow copies. A deep copy can be made by
-calling a copy() function.
-
-The benefit of sharing is that a program does not need to duplicate data
-unnecessarily, which results in lower memory use and less copying of data.
-Objects can easily be assigned, sent as function arguments, and returned
-from functions.
-
-Now comes the distinction between explicit and implicit sharing. Explicit
-sharing means that the programmer must be aware of the fact that objects
-share common data. Implicit sharing means that the sharing mechanism
-takes place behind the scenes and the programmer does not need to worry
-about it.
-
-All of the shared classes in Pegasus are explicitly shared. These classes
-have a clone() function that returns a deep copy with a reference count of 1.
-*/
-
-
-/** @name Encapsulation
-REVIEWERS: To be completed
-*/
-
-/** @name Error Handling
-
-REVIEWERS: TO Be completed
-*/
-
-
-/** @name Threading
-REVIEWERS: To be completed
-*/
-
-
-/** @name Memory Ownership
-REVIEWERS:
-*/
-
-
-//@}
-//@}
-
-/*
-<p>The following are interfaces that are frozen with the 2.3 release of Pegasus:
-CONNIE: we will go nuts if we try to do the lists this way. We need to mark them
- in the classes and methods themselves, not in this list. In reality
- all interfaces that are not explicitly marked experimental are frozen.
- We should state that.
- Need to reference PEP 57 as the authority for this release.
-
-
-<p>The following are interfaces that are experimental:
-CONNIE: We might get by with this experimental list but it will change for each
- version of the document.
-
-
-<p>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.
- </p>
-
-TODO: We should be getting Pegasus Version information directly from Pegasus, not
-just in this text file.
-
-*/
-
-/** @name Pegasus CIM Objects and Common Function APIs.
- This section defines the Pegasus C++ Classes that represent
- the CIM objects and the common functions used by Pegasus
-*/
-
- //@{
- /// @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 General Server Functionality Classes
- //@{
- //@Include: ../../src/Pegasus/Common/OperationContext.h
- //@Include: ../../src/Pegasus/Common/ResponseHandler.h
- //@Include: ../../src/Pegasus/Common/SSLContext.h
- //@}
- /// @name CIM Object Exceptions
- //@{
- //@Include: ../../src/Pegasus/Common/Exception.h
- //@}
- //@}
- /// @name Client Interfaces
- //@{
- /// @name Pegasus Client CIM Operation and Connection Interfaces
- //@{
- //@Include: ../../src/Pegasus/Client/CIMClient.h
- //@Include: ../../src/Pegasus/Client/CIMClientException.h
- //@}
- /// @name Pegasus Client SLP interfaces
- //@{
- //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
- //@Include: ../../src/Pegasus/Common/CIMServerDescription.h
- //@Include: ../../src/Pegasus/Common/Attribute.h
- //@}
- /// @name Pegasus Listener Interfaces
- //@{
- //@Include: ../../src/Pegasus/Listener/CIMListener.h
- //@}
- //@}
- /// @name C++ Provider Interfaces
- //@{
- /// Pegasus CIM Provider Types and Interfaces
- //@{
- //@Include: ../../src/Pegasus/Provider/CIMProvider.h
- //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
- //@Include: ../../src/Pegasus/Consumer/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 Pegasus Server Indication Consumer
- //@{
- //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
- //@}
-
-//@Include: ..\DevManual\definitions.dxx
-
-/** @name Document References
-
-This section will contain references to external documents.
-
-NOTE: Documents we must reference include:
- <UL>
- <LI>CIM Operations Spec.
- <LI>CIM Spec.
- </UL>
-*/
-
-//@}
-
diff --git a/doc/apidoc/doc++.conf b/doc/apidoc/doc++.conf
deleted file mode 100644
index 9dd5ee4..0000000
--- a/doc/apidoc/doc++.conf
+++ /dev/null
@@ -1,154 +0,0 @@
-# Document all
-# documentAll false
-
-# Use C/C++ comments as doc++-comments
-useNormalComments false
-
-# Parse HTML syntax, not only TeX
-HTMLSyntax true
-
-# Read a list of input files from this file
-# fileList
-
-# Parse Java instead of C/C++
-parseJava false
-
-# Ignore `#define' macros
-ignoreDefines false
-
-# Document private members
-documentPrivateMembers false
-
-# Optimize for speed instead of size
-optimizeForSpeed false
-
-# Activate Quantel extensions, folding & appended comments
-quantelExtensions false
-
-# Generate internal documentation
-internalDoc false
-
-# Generate TeX output instead of HTML
-doTeX false
-
-# Generate upwards arrows in class graphs
-upwardsArrows true
-
-# Turn verbose mode on
-verboseOperation true
-
-# Scan `#include'ed header files
-scanIncludes false
-
-# Parse IDL instead of C/C++
-parseIDL false
-
-# Generate DocBook SGML output instead of HTML
-doDocBook false
-
-# List of input files
-# inputFiles
-
-#
-# Additional options for HTML output
-#
-
-# Use tables instead of descriptions lists
-useTables true
-
-# Use tables with borders instead of descriptions lists
-useTablesWithBorders true
-
-# Use this file as footer on HTML pages
-footer PageFooter.html
-
-# Set the output directory
-# Turned this off because not sure that it
-# can take environment variables as input
-# We use %PEGASUSMANUAL_HOME% to locate html.
-#outputDir html
-
-# Show filenames in manual pages
-showFilenames true
-
-# Show filenames with path in manual pages
-showFilenamesWithPath true
-
-# Do not generate GIFS for equations, etc.
-noGifs false
-
-# Force generation of GIFs
-forceGifs false
-
-# Don't show inherited members
-noInheritedMembers false
-
-# Do not generate Java graphs
-noJavaGraphs false
-
-# Keep trivial class graphs
-trivialGraphs true
-
-# Don't show members without documentation in DOC section
-noMembers false
-
-# Show members in TOC
-showMembersInTOC true
-
-# Discard general stuff
-discardGeneral false
-
-# Sort entries alphabetically
-sortEntries false
-
-# Use this file as header on HTML pages
-header pageheader.html
-
-# Print group documentation before group
-groupBeforeGroup true
-
-# Print class documentation before group
-classBeforeGroup true
-
-# Use this suffix for HTML pages
-htmlSuffix .html
-
-# use this file as HTML style sheet
-htmlStyleSheet http://www.opengroup.org/stylesheets/info1.css">
-
-#
-# Additional options for TeX output
-#
-
-# Only generate class graph
-onlyClassGraph false
-
-# Read TeX environment from this file
-# environment
-
-# Generate index
-generateIndex true
-
-# Setup TeX style option
-# style
-
-# Use the following TeX packages
-# usePackage
-
-# Use the content of this file as TeX title page
-# title
-
-# Set minimum depth (number of levels) in TOC
-minimumDepth 1
-
-# Do not generate TeX environment
-noEnvironment false
-
-# Do not generate the class graph
-noClassGraph false
-
-# Set output file name
-# outputFilename
-
-# Generate source code listing
-generateSourceListing false
diff --git a/doc/apidoc/pageheader.html b/doc/apidoc/pageheader.html
deleted file mode 100644
index 120d39d..0000000
--- a/doc/apidoc/pageheader.html
+++ /dev/null
@@ -1,40 +0,0 @@
-<html>
-
-<head>
-<title>Pegasus Developers Manual</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="http://www.opengroup.org/stylesheets/info1.css">
-<meta name="keywords" content>
-<meta name="description" content>
-</head>
-
-<body background="http://www.opengroup.org/images/template/background.gif" leftmargin="0" rightmargin="0" topmargin="0" marginwidth="0" marginheight="0">
-
-<!--#include virtual="/includes/main-incl1.htm" -->
-<table border="0" cellpadding="0" cellspacing="0" width="97%" align="center">
- <tr>
- <td width="28%"><img height="1" src width="1"></td>
- </tr>
- <tr>
- <td valign="top" align="left" width="28%">
- <!--#include virtual="/includes/main-incl2.htm" --></td>
- <td bgcolor="#ffffff" width="72%" colspan="2" align="center" valign="top">
- <!--#include virtual="/includes/main-navbar.htm" -->
- <!--#include virtual="pegdoctopbar.shtml" --></td>
- </tr>
-</table>
-<!--#include virtual="/includes/main-incl3.htm" -->
-<p><br>
-</p>
-<table width="97%" border="0" cellspacing="0" cellpadding="0" align="center">
- <tr bgcolor="#FFFFFF">
- <td>
- <!--#include virtual="/includes/main-incl4.htm" --></td>
- </tr>
-</table>
-<table width="97%" border="0" cellspacing="0" cellpadding="10" bgcolor="#FFFFFF" align="center" height="507">
- <tr bgcolor="#FFFFFF" valign="top">
- <td width="20%" align="left">
- <!--#include virtual="pegdocsidebarleft.shtml" --></td>
- <td width="60%" align="left">
-