Author: nabeel
Date: Thu Jun 15 00:20:39 2006
New Revision: 414494
URL: http://svn.apache.org/viewvc?rev=414494&view=rev
Log:
Updated docs to reflect code chages done
1. replacing double pointer to single pointer
2. om to axiom
3. passing const
4. minor typos
Modified:
webservices/axis2/trunk/c/xdocs/docs/developerguide.html
webservices/axis2/trunk/c/xdocs/docs/om_tutorial.html
webservices/axis2/trunk/c/xdocs/docs/userguide.html
Modified: webservices/axis2/trunk/c/xdocs/docs/developerguide.html
URL:
http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/developerguide.html?rev=414494&r1=414493&r2=414494&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/developerguide.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/developerguide.html Thu Jun 15
00:20:39 2006
@@ -299,7 +299,7 @@
<p>Example:</p>
-<p>To test the OM module, you need to create a file named test_om.c under the
+<p>To test the AXIOM module, you need to create a file named test_om.c under
the
directory modules/test/xml/om. A sample test_om.c might look like as
follows.</p>
<pre class="code">#include <axiom_stax_builder.h>
Modified: webservices/axis2/trunk/c/xdocs/docs/om_tutorial.html
URL:
http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/om_tutorial.html?rev=414494&r1=414493&r2=414494&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/om_tutorial.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/om_tutorial.html Thu Jun 15 00:20:39
2006
@@ -195,9 +195,9 @@
ANSI C complient. Further, platform dependent funtions are also
abstracted.</p>
-<p>As a rule of thumb, all "create" functions take a double pointer to the
+<p>As a rule of thumb, all "create" functions take a pointer to the
environment as its first argument and all other functions take pointer to
-'this' struct as the first argument and a double pointer to environment as
+'this' struct as the first argument and a pointer to the environment as
the second argument. (Please refer to our coding convention page to learn
more about this)</p>
@@ -209,12 +209,10 @@
<p>node = axiom_node_create(env);</p>
-<p>Note that 'env' is a double pointer to the environment struct.</p>
-
<p>child = AXIOM_NODE_GET_FIRST_CHILD(node, env);</p>
-<p>Note that we are parsing the node (pointer to om_node_t ) as the first
-argument and double pointer to environment.</p>
+<p>Note that we are passing the node (pointer to axiom_node_t ) as the first
+argument and the pointer to the environment as the second.</p>
<p></p>
@@ -315,7 +313,7 @@
<p>The SOAP struct hierarchy is made in the most natural way for a
programmer. It acts as a wrapper layer on top of OM implementation. The SOAP
-structs wraps the correspoding om_node_t structs to store information in
+structs wraps the correspoding axiom_node_t structs to store information in
xml.</p>
<!-- The following illustration of the actual class diagram will be helpful
in understanding this.
Need an image here -->
@@ -333,13 +331,13 @@
<p>Add child operation</p>
<pre class="code">axis2_status_t
axiom_node_add_child( axiom_node_t *om_node,
- axis2_env_t **env,
+ const axis2_env_t *env,
axiom_node_t *child_node);</pre>
<p>Detach operation</p>
<pre class="code">axiom_node_t*
axiom_node_detach (axiom_node_t *om_node,
- axis2_env_t **env);</pre>
+ const axis2_env_t *env);</pre>
<p>The detach operation resets the links and remove a node from om
structure.</p>
@@ -390,26 +388,26 @@
</div>
<pre class="code">axiom_namespace_t*
axiom_element_declare_namespace(axiom_element_t *om_ele,
- axis2_env_t **env,
+ const axis2_env_t *env,
axiom_node_t *om_node,
axiom_namespace_t *om_ns);
axiom_namespace_t*
axiom_element_find_namespace(axiom_element_t *om_ele,
- axis2_env_t **env,
+ const axis2_env_t *env,
axiom_node_t *om_node,
axis2_char_t *uri,
axis2_char_t *prefix);
axiom_namespace_t*
axiom_element_find_declared_namespace(axiom_element_t *om_element,
- axis2_env_t **env,
+ const axis2_env_t *env,
axis2_char_t *uri,
axis2_char_t *prefix);
axis2_status_t
axiom_element_set_namespace(axiom_element_t *om_element,
- axis2_env_t **env,
+ const axis2_env_t *env,
axis2_namespace_t *ns,
axiom_node_t *element_node);</pre>
@@ -596,7 +594,7 @@
xml_output = AXIOM_ELEMENT_TO_STRING(foo_ele, env, foo_node);
printf("%s", xml_output);
-AXIS2_FREE((*env)->allocator, xml_output);</pre>
+AXIS2_FREE(env->allocator, xml_output);</pre>
<p>Note that freing the returned buffer is users responsibility</p>
@@ -660,7 +658,7 @@
<p>Therefore following will cause a double free */</p>
-<p>AXIS2_FREE((*env)->allocator, uri);</p>
+<p>AXIS2_FREE(env->allocator, uri);</p>
<p>AXIOM_NAMESPACE_FREE(ns, env);</p>
@@ -792,7 +790,7 @@
<i>/** when om_builder is freed , the builder, om_document and the entire om structure is freed */</i>
AXIOM_STAX_BUILDER_FREE(om_builder, env);
- AXIS2_FREE((*env)->allocator, buffer);
+ AXIS2_FREE(env->allocator, buffer);
<b>return</b> AXIS2_SUCCESS;
@@ -805,7 +803,7 @@
axis2_allocator_t *allocator = NULL;
env = create_environment();
<br />
- status = build_and_serialize_om(&env);
+ status = build_and_serialize_om(env);
<b>if</b>(status == AXIS2_FAILURE)
{
Modified: webservices/axis2/trunk/c/xdocs/docs/userguide.html
URL:
http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/userguide.html?rev=414494&r1=414493&r2=414494&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/userguide.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/userguide.html Thu Jun 15 00:20:39 2006
@@ -661,7 +661,7 @@
<li>Set up the options to be used in the invocation.</li>
<li>Create the service client.</li>
<li>Set the options to service client.</li>
- <li>Build the XML payload to be sent out using OM.</li>
+ <li>Build the XML payload to be sent out using AXIOM.</li>
<li>Send payload and receive result XML as OM.</li>
<li>Consume result.</li>
</ol>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
