From b51f4dcbd56f170b5240449994c7f6595dc33ce0 Mon Sep 17 00:00:00 2001
From: Neil Graham <neilg@apache.org>
Date: Mon, 24 Nov 2003 05:21:04 +0000
Subject: [PATCH] update method documentation
git-svn-id: https://svn.apache.org/repos/asf/xerces/c/trunk@175443 13f79535-47bb-0310-9956-ffa450edef68
---
src/xercesc/framework/XMLAttDef.hpp | 7 ++
src/xercesc/framework/XMLElementDecl.hpp | 9 +++
.../validators/schema/SchemaElementDecl.hpp | 67 ++++++++++++-------
3 files changed, 59 insertions(+), 24 deletions(-)
diff --git a/src/xercesc/framework/XMLAttDef.hpp b/src/xercesc/framework/XMLAttDef.hpp
index 898701800..cb992243d 100644
--- a/src/xercesc/framework/XMLAttDef.hpp
+++ b/src/xercesc/framework/XMLAttDef.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.11 2003/11/24 05:19:15 neilg
+ * update method documentation
+ *
* Revision 1.10 2003/10/10 16:23:29 peiyongz
* Implementation of Serialization/Deserialization
*
@@ -357,6 +360,7 @@ public:
*
* @return Returns a boolean value that indicates whether this attribute
* was explicitly provided.
+ * @deprecated
*/
bool getProvided() const;
@@ -413,11 +417,13 @@ public:
/**
* @return the uri part of DOM Level 3 TypeInfo
+ * @deprecated
*/
virtual const XMLCh* getDOMTypeInfoUri() const = 0;
/**
* @return the name part of DOM Level 3 TypeInfo
+ * @deprecated
*/
virtual const XMLCh* getDOMTypeInfoName() const = 0;
@@ -458,6 +464,7 @@ public:
* attributes that have been explicitly provided.
*
* @param newValue The new provided state to set
+ * @deprecated
*/
void setProvided(const bool newValue);
diff --git a/src/xercesc/framework/XMLElementDecl.hpp b/src/xercesc/framework/XMLElementDecl.hpp
index 60a005701..3c7a6aea9 100644
--- a/src/xercesc/framework/XMLElementDecl.hpp
+++ b/src/xercesc/framework/XMLElementDecl.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.9 2003/11/24 05:19:15 neilg
+ * update method documentation
+ *
* Revision 1.8 2003/10/10 16:23:29 peiyongz
* Implementation of Serialization/Deserialization
*
@@ -199,6 +202,10 @@ class XMLPARSER_EXPORT XMLElementDecl : public XSerializable, public XMemory
, JustFaultIn
};
+ /**
+ * @deprecated Use of addIfNotFound couldl produce undefined
+ * behaviour in multithreaded environments.
+ */
enum LookupOpts
{
AddIfNotFound
@@ -258,6 +265,8 @@ class XMLPARSER_EXPORT XMLElementDecl : public XSerializable, public XMemory
* defaulted in if not found. If it is defaulted in, then wasAdded should
* be set, else it should be cleared. If its not found and the caller does
* not want defaulting, then return a null pointer.
+ * Note that, in a multithreaded environment, it is dangerous for a
+ * caller to invoke this method with options set to AddIfNotFound.
*
* @param qName This is the qName of the attribute, i.e. the actual
* lexical name found.
diff --git a/src/xercesc/validators/schema/SchemaElementDecl.hpp b/src/xercesc/validators/schema/SchemaElementDecl.hpp
index 77e6f7590..bf0b11352 100644
--- a/src/xercesc/validators/schema/SchemaElementDecl.hpp
+++ b/src/xercesc/validators/schema/SchemaElementDecl.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.17 2003/11/24 05:21:04 neilg
+ * update method documentation
+ *
* Revision 1.16 2003/11/21 22:34:46 neilg
* More schema component model implementation, thanks to David Cargill.
* In particular, this cleans up and completes the XSModel, XSNamespaceItem,
@@ -291,11 +294,11 @@ public :
* 1.1.1.2 clause 1.2 of Schema-Validity Assessment (Element) (3.3.4) applied and the item was valid as defined by Element Locally Valid (Type) (3.3.4).
* 1.1.2 Neither its [children] nor its [attributes] contains an information item (element or attribute respectively) whose [validity] is invalid.
* 1.1.3 Neither its [children] nor its [attributes] contains an information item (element or attribute respectively) with a context-determined declaration of mustFind whose [validity] is unknown.
- , then valid;
- * 1.2 otherwise invalid.
- * 2 otherwise notKnown.
- */
- // @deprecated; not thread-safe
+ * , then valid;
+ * 1.2 otherwise invalid.
+ * 2 otherwise notKnown.
+ * @deprecated; not thread-safe
+ */
PSVIDefs::Validity getValidity() const;
@@ -304,65 +307,69 @@ public :
* 1 If it was strictly assessed and neither its [children] nor its [attributes] contains an information item (element or attribute respectively) whose [validation attempted] is not full, then full;
* 2 If it was not strictly assessed and neither its [children] nor its [attributes] contains an information item (element or attribute respectively) whose [validation attempted] is not none, then none;
*3 otherwise partial.
+ * @deprecated; not thread-safe
*/
- // @deprecated; not thread-safe
PSVIDefs::Validation getValidationAttempted() const;
/**
* @return the complexity. simple or complex, depending on the type definition.
+ * @deprecated; not thread-safe
*/
- // @deprecated; not thread-safe
PSVIDefs::Complexity getTypeType() const;
/**
* The target namespace of the type definition.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
const XMLCh* getTypeUri() const;
/**
* The {name} of the type definition, if it is not absent.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
const XMLCh* getTypeName() const;
/**
* true if the {name} of the type definition is absent, otherwise false.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
bool getTypeAnonymous() const;
/**
* If this method returns true and validity is VALID then the next three
* produce accurate results
* @return true if the element is validated using a union type
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
bool isTypeDefinitionUnion() const;
/**
* The {target namespace} of the actual member type definition.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
const XMLCh* getMemberTypeUri() const;
/**
* @return true if the {name} of the actual member type definition is absent, otherwise false.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
bool getMemberTypeAnonymous() const;
/**
* @return the {name} of the actual member type definition, if it is not absent.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
*/
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
const XMLCh* getMemberTypeName() const;
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
virtual const XMLCh* getDOMTypeInfoUri() const;
- // @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
virtual const XMLCh* getDOMTypeInfoName() const;
@@ -378,27 +385,39 @@ public :
void setMiscFlags(const int flags);
void setDefaultValue(const XMLCh* const value);
void setComplexTypeInfo(ComplexTypeInfo* const typeInfo);
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void setXsiComplexTypeInfo(ComplexTypeInfo* const typeInfo);
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void setXsiSimpleTypeInfo(const DatatypeValidator* const dtv);
void setAttWildCard(SchemaAttDef* const attWildCard);
void setSubstitutionGroupElem(SchemaElementDecl* const elemDecl);
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void setValidity(PSVIDefs::Validity valid);
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void setValidationAttempted(PSVIDefs::Validation validation);
- //called when element content of this element was validated
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * called when element content of this element was validated
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void updateValidityFromElement(const XMLElementDecl *decl, Grammar::GrammarType eleGrammar);
//called when attribute content of this element was validated
// @deprecated; should not be needed in a thread-safe implementation
void updateValidityFromAttribute(const SchemaAttDef *def);
- //cleans up inbetween uses of the SchemaElementDecl. Resets xsiType, Validity etc.
- // @deprecated; should not be needed in a thread-safe implementation
+ /**
+ * cleans up inbetween uses of the SchemaElementDecl. Resets xsiType, Validity etc.
+ * @deprecated; not thread-safe (will not work with xsi:type and shared grammars)
+ */
void reset();
// -----------------------------------------------------------------------
--
GitLab