X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=xmltooling%2FXMLObjectBuilder.h;h=bb0b3ef88366cccf63c29a76c1aa75aa7277c515;hb=723157700628d2f94e1911b9fc0145f351ccdcf1;hp=5ad43944a37a683464b851301d5e6162d4577722;hpb=a0d768778a8f5f539b909baf5b115e70ea765f0f;p=shibboleth%2Fcpp-xmltooling.git diff --git a/xmltooling/XMLObjectBuilder.h b/xmltooling/XMLObjectBuilder.h index 5ad4394..bb0b3ef 100644 --- a/xmltooling/XMLObjectBuilder.h +++ b/xmltooling/XMLObjectBuilder.h @@ -1,17 +1,21 @@ -/* - * Copyright 2001-2010 Internet2 - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at +/** + * Licensed to the University Corporation for Advanced Internet + * Development, Inc. (UCAID) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for + * additional information regarding copyright ownership. + * + * UCAID licenses this file to you under the Apache License, + * Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the + * License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + * either express or implied. See the License for the specific + * language governing permissions and limitations under the License. */ /** @@ -38,8 +42,7 @@ namespace xmltooling { /** - * A factory interface for obtaining XMLObjects. - * Subclasses MAY supply additional factory methods. + * A factory interface for obtaining an XMLObject. */ class XMLTOOL_API XMLObjectBuilder { @@ -50,6 +53,7 @@ namespace xmltooling { /** * Creates an empty XMLObject with a particular element name. *

The results are undefined if localName is nullptr or empty. + *

The caller is responsible for freeing the resulting object. * * @param nsURI namespace URI for element * @param localName local name of element @@ -63,6 +67,7 @@ namespace xmltooling { /** * Creates an empty XMLObject with a particular element name. + *

The caller is responsible for freeing the resulting object. * * @param q QName of element for object * @return the empty XMLObject @@ -71,6 +76,7 @@ namespace xmltooling { /** * Creates an unmarshalled XMLObject from a DOM Element. + *

The caller is responsible for freeing the resulting object. * * @param element the unmarshalling source * @param bindDocument true iff the XMLObject should take ownership of the DOM Document @@ -80,6 +86,7 @@ namespace xmltooling { /** * Creates an unmarshalled XMLObject from the root of a DOM Document. + *

The caller is responsible for freeing the resulting object. * * @param doc the unmarshalling source * @param bindDocument true iff the XMLObject should take ownership of the DOM Document @@ -89,6 +96,7 @@ namespace xmltooling { /** * Creates an unmarshalled XMLObject using the default build method, if a builder can be found. + *

The caller is responsible for freeing the resulting object. * * @param element the unmarshalling source * @param bindDocument true iff the new XMLObject should take ownership of the DOM Document