Skip to content
Snippets Groups Projects
Commit 5bb8307c authored by Tinny Ng's avatar Tinny Ng
Browse files

Documentation Update: get ready for Xerces-C++ 2.0. 

git-svn-id: https://svn.apache.org/repos/asf/xerces/c/trunk@173677 13f79535-47bb-0310-9956-ffa450edef68
parent 61be76ea
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
doc/Doxyfile
+ 10
− 7
View file @ 5bb8307c
...@@ -25,7 +25,7 @@ PROJECT_NAME = Xerces-C++ ...@@ -25,7 +25,7 @@ PROJECT_NAME = Xerces-C++
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = v1.7.0 PROJECT_NUMBER = v2.0.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
...@@ -205,7 +205,7 @@ ENABLED_SECTIONS = ...@@ -205,7 +205,7 @@ ENABLED_SECTIONS =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = ../src/xercesc/dom ../src/xercesc/idom ../src/xercesc/framework ../src/xercesc/sax ../src/xercesc/parsers ../src/xercesc/util ../src/xercesc/sax2 INPUT = ../src/xercesc/dom ../src/xercesc/framework ../src/xercesc/sax ../src/xercesc/parsers ../src/xercesc/util ../src/xercesc/sax2
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
...@@ -230,13 +230,16 @@ EXCLUDE = ...@@ -230,13 +230,16 @@ EXCLUDE =
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. # certain files from those directories.
EXCLUDE_PATTERNS = *Impl.hpp Janitor.hpp BitOps.hpp BitSet.hpp ChildNode.hpp \ EXCLUDE_PATTERNS = *Impl.hpp DOM_*.hpp DOMParser.hpp \
CountedPointer.hpp DomMemDebug.hpp MemDebug.hpp DStringPool.hpp TransENameMap.hpp \ ChildNode.hpp DOM.hpp DomMemDebug.hpp MemDebug.hpp DStringPool.hpp \
IDCasts.hpp IDChildNode.hpp IDDeepNodeListPool.hpp IDDOMImplementation.hpp \ NodeIDMap.hpp NameNodeFilter.hpp NodeVector.hpp DOMString.hpp ParentNode.hpp \
IDNodeIDMap.hpp IDNodeVector.hpp IDParentNode.hpp IDStringPool.hpp \ DOMCasts.hpp DOMChildNode.hpp DOMDeepNodeListPool.hpp \
DOMNodeIDMap.hpp DOMNodeVector.hpp DOMParentNode.hpp DOMStringPool.hpp \
NameIdPool.hpp KVStringPair.hpp Janitor.hpp BitOps.hpp BitSet.hpp \
CountedPointer.hpp TransENameMap.hpp \
FlagJanitor.hpp HashBase.hpp HashPtr.hpp HashXMLCh.hpp KeyValuePair.hpp \ FlagJanitor.hpp HashBase.hpp HashPtr.hpp HashXMLCh.hpp KeyValuePair.hpp \
KVStringPair.hpp NameIdPool.hpp NodeIDMap.hpp NameNodeFilter.hpp NodeVector.hpp \ KVStringPair.hpp NameIdPool.hpp NodeIDMap.hpp NameNodeFilter.hpp NodeVector.hpp \
NodeImpl.hpp CommonParentNode.hpp RefArrayOf.hpp RefHash*.hpp RefStackOf.hpp \ RefArrayOf.hpp RefHash*.hpp RefStackOf.hpp \
RefVectorOf.hpp ValueArrayOf.hpp ValueStackOf.hpp ValueVectorOf.hpp \ RefVectorOf.hpp ValueArrayOf.hpp ValueStackOf.hpp ValueVectorOf.hpp \
XML256TableTranscoder.hpp XML88591Transcoder.hpp XMLASCIITranscoder.hpp \ XML256TableTranscoder.hpp XML88591Transcoder.hpp XMLASCIITranscoder.hpp \
XMLBufferMgr.hpp XMLBuffer.hpp XMLChTranscoder.hpp XMLEBCDICTranscoder.hpp \ XMLBufferMgr.hpp XMLBuffer.hpp XMLChTranscoder.hpp XMLEBCDICTranscoder.hpp \
......
doc/migration.xml
+ 29
− 95
View file @ 5bb8307c
...@@ -2,13 +2,14 @@ ...@@ -2,13 +2,14 @@
<!DOCTYPE s1 SYSTEM "sbk:/style/dtd/document.dtd"> <!DOCTYPE s1 SYSTEM "sbk:/style/dtd/document.dtd">
<s1 title="Migration"> <s1 title="Migration">
<s2 title="Migrating from &XercesCName; &XercesCVersion160; to &XercesCName; &XercesCVersion;"> <s2 title="Migrating from &XercesCName; 1.7.0 to &XercesCName; &XercesCVersion;">
<p>This document is a discussion of the technical differences between <p>This document is a discussion of the technical differences between
&XercesCName; &XercesCVersion160; code base and the &XercesCName; &XercesCVersion;.</p> &XercesCName; 1.7.0 code base and the &XercesCName; &XercesCVersion;.</p>
<p>Topics discussed are:</p> <p>Topics discussed are:</p>
<ul> <ul>
<li><link anchor="NewFeatures">New features in &XercesCName; &XercesCVersion;</link></li> <li><link anchor="NewFeatures">New features in &XercesCName; &XercesCVersion;</link></li>
<li><link anchor="LibraryChange">Library Name change in &XercesCName; &XercesCVersion;</link></li>
<li><link anchor="DirChange">Directory change in &XercesCName; &XercesCVersion;</link></li> <li><link anchor="DirChange">Directory change in &XercesCName; &XercesCVersion;</link></li>
<li><link anchor="API">Public API Changes in &XercesCName; &XercesCVersion;</link></li> <li><link anchor="API">Public API Changes in &XercesCName; &XercesCVersion;</link></li>
<ul> <ul>
...@@ -17,129 +18,62 @@ ...@@ -17,129 +18,62 @@
<li><link anchor="DeprecatedAPI">Deprecated Public API</link></li> <li><link anchor="DeprecatedAPI">Deprecated Public API</link></li>
</ul> </ul>
</ul> </ul>
</s2>
<anchor name="NewFeatures"/> <anchor name="NewFeatures"/>
<s2 title="New features in &XercesCName; &XercesCVersion;"> <s3 title="New features in &XercesCName; &XercesCVersion;">
<ul> <ul>
<li>Support SAX2-ext's DeclHandler.</li> <li></li>
<li>Directory sane_include reorganization: add sub-directory 'xercesc' to src / include folder.
See <link anchor="DirChange">"Directory change in &XercesCName; &XercesCVersion;"</link>
below for detail.</li>
<li>More IDOM test cases - port IDOMMemTest, and merge ThreadTest and IThreadTest.</li>
<li>Support IconvFBSD in multi-threading environment.</li>
<li>Use IDOM in schema processing for faster performance.</li>
<li>Add Project files for BCB6.</li>
<li>Port to Caldera (SCO) OpenServer.</li>
<li>Support building with new MacOSURLAccessCF NetAccessor that doesn't require
Carbon but can allow Xerces to live solely within CoreServices layer.</li>
</ul> </ul>
</s2> </s3>
<anchor name="LibraryChange"/>
<s3 title="Library Name Change in &XercesCName; &XercesCVersion;">
<ul>
<li></li>
</ul>
</s3>
<anchor name="DirChange"/> <anchor name="DirChange"/>
<s2 title="Directory change in &XercesCName; &XercesCVersion;"> <s3 title="Directory change in &XercesCName; &XercesCVersion;">
<ul> <ul>
<li>A new directory, <em>src/xercesc</em> is created to be the new parent directory of <li></li>
all src's direct subdirectories.</li>
<li>And in the binary package, all the headers are distributed in <em>include/xercesc</em> directory.</li>
<li>Migration considerations:</li>
<ul>
<li>Windows application, <br/>
either change the <em>include directories </em> setting to
"..\..\..\..\..\src\<em>xercesc</em>" (Projects->settings->C/C++->Preprocessor), <br/>
or <br/>
change the relevant #include instances in the source/header files, accordingly, eg <br/>
#include &lt;util/XMLString.hpp&gt; be changed to <br/>
#include &lt;<em>xercesc</em>/util/XMLString.hpp&gt; </li>
<li>Unix application, <br/>
either change the <em>include search path </em> in the Makefile to
" -I &lt;installroot&gt;/include/<em>xercesc</em>", <br/>
or <br/>
change the relevant #include instances in the source/header files as shown above. </li>
</ul>
</ul> </ul>
</s2> </s3>
<anchor name="API"/> <anchor name="API"/>
<s2 title="Public API Changes in &XercesCName; &XercesCVersion;"> <s3 title="Public API Changes in &XercesCName; &XercesCVersion;">
<p>The following lists the public API changes between the &XercesCName; <p>The following lists the public API changes between the &XercesCName;
&XercesCVersion; and the &XercesCName; &XercesCVersion; releases 1.7.0; and the &XercesCName; &XercesCVersion; releases
of the parser. </p> of the parser. </p>
<anchor name="NewAPI"/> <anchor name="NewAPI"/>
<s3 title="New Public API"> <s4 title="New Public API">
<ul> <ul>
<li>Added SAX2-ext's DeclHandler class. <li></li>
See <jump href="api.html">the API documentation page</jump> for details.</li>
<li>To support SAX2-ext's DeclHandler, the following new methods are added
in classes DefaultHandler and SAX2XMLReader:</li>
<ul>
<li>void DefaultHandler::elementDecl(const XMLCh* const name, const XMLCh* const model)</li>
<li>void DefaultHandler::attributeDecl(const XMLCh* const eName, const XMLCh* const aName,
const XMLCh* const type, const XMLCh* const mode, const XMLCh* const value)</li>
<li>void DefaultHandler::internalEntityDecl(const XMLCh* const name, const XMLCh* const value)</li>
<li>void DefaultHandler::externalEntityDecl(const XMLCh* const name, const XMLCh* const publicId,
const XMLCh* const systemId)</li>
<li>DeclHandler* SAX2XMLReader::getDeclarationHandler() const</li>
<li>void SAX2XMLReader::setDeclarationHandler(DeclHandler* const handler)</li>
</ul>
<li>To conform to DOM Level 2 specification, the following methods are added:</li>
<ul>
<li>DOM_Node DOM_NodeIterator::getRoot()</li>
<li>DOM_Node DOM_TreeWalker::getRoot()</li>
<li>bool DOM_Node::hasAttributes() const</li>
<li>bool DOM_Element::hasAttribute(const DOMString &amp;name) const</li>
<li>bool DOM_Element::hasAttributeNS(const DOMString &amp;namespaceURI,
const DOMString &amp;localName) const</li>
<li>IDOM_Node* IDOM_NodeIterator::getRoot()</li>
<li>IDOM_Node* IDOM_TreeWalker::getRoot()</li>
<li>bool IDOM_Node::hasAttributes() const</li>
<li>bool IDOM_Element::hasAttribute(const XMLCh* name) const</li>
<li>bool IDOM_Element::hasAttributeNS(const XMLCh* namespaceURI,
const XMLCh* localName) const</li>
</ul>
<li>To fix [Bug 5570], a copy constructor is added to DOM_Range</li>
</ul> </ul>
</s3> </s4>
<anchor name="ModifiedAPI"/> <anchor name="ModifiedAPI"/>
<s3 title="Modified Public API"> <s4 title="Modified Public API">
<ul> <ul>
<li>To conform to the SAX2 specification, the namespace-prefixes feature <li></li>
in SAX2 is set to off as default.</li>
<li>To fix [Bug 6330], the Base64::encode and Base64::decode have been modified
as follows</li>
<ul>
<li>static XMLByte* Base64::encode(const XMLByte* const inputData,
const unsigned int inputLength,
unsigned int* outputLength);</li>
<li>static XMLByte* Base64::decode(const XMLByte* const inputData,
unsigned int* outputLength);</li>
<li>static XMLCh* decode(const XMLCh* const inputData,
unsigned int* outputLength);</li>
</ul>
<li>To conform to DOM Level 2 specification, the DOM_Node::supports and IDOM_Node::supports
are modified to</li>
<ul>
<li>bool DOM_Node::isSupported(const DOMString &amp;feature, const DOMString &amp;version) const</li>
<li>bool IDOM_Node::isSupported(const XMLCh* feature, const XMLCh* version) const</li>
</ul>
</ul> </ul>
</s3> </s4>
<anchor name="DeprecatedAPI"/> <anchor name="DeprecatedAPI"/>
<s3 title="Deprecated Public API"> <s4 title="Deprecated Public API">
<ul> <ul>
<li>No Deprecated Public API in this release.</li> <li></li>
</ul> </ul>
</s3> </s4>
</s3>
</s2> </s2>
<s2 title="Migration Archive"> <s2 title="Migration Archive">
<p>For migration information to &XercesCName; &XercesCVersion160; or earlier, <p>For migration information to &XercesCName; 1.7.0 or earlier,
please refer to <jump href="migrate_archive.html">Migration Archive. </jump></p> please refer to <jump href="migrate_archive.html">Migration Archive. </jump></p>
</s2> </s2>
......
doc/migration_archive.xml
+ 192
− 410
View file @ 5bb8307c
This diff is collapsed.
doc/releases.xml
+ 88
− 1200
View file @ 5bb8307c
This diff is collapsed.
doc/releases_archive.xml
+ 1206
− 10
View file @ 5bb8307c
This diff is collapsed.
doc/style/dtd/entities.ent
+ 7
− 9
View file @ 5bb8307c
...@@ -2,15 +2,13 @@ ...@@ -2,15 +2,13 @@
<!ENTITY XercesCFullName "Xerces C++ Parser"> <!-- fullproductname --> <!ENTITY XercesCFullName "Xerces C++ Parser"> <!-- fullproductname -->
<!ENTITY XercesCName "Xerces-C++"> <!-- productname --> <!ENTITY XercesCName "Xerces-C++"> <!-- productname -->
<!ENTITY XercesCVersion140 "1.4.0"> <!-- versionnumber --> <!ENTITY XercesCVersion "2.0.0"> <!-- versionnumber -->
<!ENTITY XercesCVersion152 "1.5.2"> <!-- versionnumber -->
<!ENTITY XercesCVersion160 "1.6.0"> <!-- versionnumber -->
<!ENTITY XercesCVersion "1.7.0"> <!-- versionnumber -->
<!ENTITY XercesCProjectName "Xerces"> <!-- projectname --> <!ENTITY XercesCProjectName "Xerces"> <!-- projectname -->
<!ENTITY XercesCInstallDir "xerces-c1_7_0"> <!-- installdirname --> <!ENTITY XercesCInstallDir "xerces-c2_0_0"> <!-- installdirname -->
<!ENTITY XercesCSrcInstallDir "xerces-c-src1_7_0"> <!-- sourcedirectory --> <!ENTITY XercesCSrcInstallDir "xerces-c-src2_0_0"> <!-- sourcedirectory -->
<!ENTITY XercesCWindowsLib "xerces-c_1"> <!-- windowslibname --> <!ENTITY XercesCWindowsLib "xerces-c_2"> <!-- windowslibname -->
<!ENTITY XercesCWindowsDLL "xerces-c_1_7_0"> <!-- windowsDLLname --> <!ENTITY XercesCWindowsDLL "xerces-c_2_0_0"> <!-- windowsDLLname -->
<!ENTITY XercesCUnixLib "libxerces-c1_7_0"> <!-- unixlibname --> <!ENTITY XercesCUnixSoName "20.0"> <!-- unixlibname -->
<!ENTITY XercesCUnixLib "libxerces-c"> <!-- unixlibname -->
<!ENTITY XercesCEmailAddress "xerces-c-dev@xml.apache.org "> <!-- emailaddress --> <!ENTITY XercesCEmailAddress "xerces-c-dev@xml.apache.org "> <!-- emailaddress -->
<!ENTITY XercesDistDir "xml.apache.org/dist/xerces-c"> <!-- download directory --> <!ENTITY XercesDistDir "xml.apache.org/dist/xerces-c"> <!-- download directory -->
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment