svn commit: r312933 - /webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html

[li...@apache.org]

Author: lilantha
Date: Tue Oct 11 11:26:35 2005
New Revision: 312933

URL: http://svn.apache.org/viewcvs?rev=312933&view=rev
Log:
revert back

Modified:
    webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html

Modified: webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html?rev=312933&r1=312932&r2=312933&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html (original)
+++ webservices/axis2/trunk/c/xdocs/axis2_coding_convention.html Tue Oct 11 11:26:35 2005
@@ -23,20 +23,14 @@
 
 <h3> 1.1 Variables</h3>
 
-<p>Use meaningful nouns. Use all lower case letters for private & public variables.
-Use uppercase names for constant. If it is a local variable or a member of a struct, 
-no need to prefix it with axis2_</p>
+<p>Use meaningful nouns. Use all lower case letters. If it is a local
+variable or a member of a struct, no need to prefix it with axis2_</p>
 
 <p>e.g. </p>
-<pre>
-int count = 0;
-char *prefix = NULL;
-</pre>
-
-Private variable names All lowercase
-Public variable names All lowercase
-Constant names Uppercase only
-
+
+<p>int count = 0;</p>
+
+<p>char* prefix = NULL;</p>
 
 <h3>1.2 Functions </h3>
 
@@ -46,21 +40,24 @@
 <p></p>
 
 <p>e.g. </p>
-<pre>
-<p>axis2_om_node_t * axis2_om_node_create(axis2_env_t* env);</p>
-</pre>
+
+<p>axis2_om_node_t *axis2_om_node_create(axis2_environment_t
+*environment);</p>
 
 <p></p>
 
 <h3>1.3 Structures and User Defined Data Types </h3>
 
 <p>e.g.</p>
-<pre>
-typedef struct axis2_om_namespace {
-	char *uri;
-	char *prefix;
-} axis2_om_namespace_t;
-</pre>
+
+<p>typedef struct axis2_om_namespace {</p>
+
+<p> char *uri;</p>
+
+<p> char *prefix;</p>
+
+<p>} axis2_om_namespace_t;</p>
+
 <p></p>
 
 <p>Note the _t suffix in the type name.</p>
@@ -76,21 +73,26 @@
 structs or is a type definition.</p>
 
 <p>e.g.</p>
-<pre>
+
 <p>#define AXIS2_H</p>
-<p>#define axis2_error_get_message(error) ((error)-&gt;ops-&gt;get_message())</p>
-</pre>
+
+<p>#define axis2_error_get_message(error)
+((error)-&gt;ops-&gt;get_message())</p>
+
 <p></p>
 
 <h3>1.5 Enumerations</h3>
 
 <p>e.g.</p>
-<pre>
-typedef enum axis2_status_codes {
-	AXIS2_FAILURE = 0,
-	AXIS2_SUCCESS
-} axis2_status_codes_t;
-</pre>
+
+<p>typedef enum axis2_status_codes {</p>
+
+<p> AXIS2_FAILURE = 0,</p>
+
+<p> AXIS2_SUCCESS</p>
+
+<p>} axis2_status_codes_t;</p>
+
 <p></p>
 
 <h2>2 Indentation</h2>
@@ -117,29 +119,17 @@
 <h2>4 Function Parameters and Return Value Conventions</h2>
 
 <p>Each function should be passed a pointer to an instance of
-axis2_env_t  struct as the first parameter. If the function is tightly
+axis2_environment_t struct as the first parameter. If the function is tightly
 bound to a struct, the second parameter is a pointer to an instance of that
 struct.</p>
 
 <p>Functions returning pointers should return NULL in case of an error. The
-developer should make sure to set the relavant error code in env's
+developer should make sure to set the relavant error code in environment's
 error struct.</p>
 
-<p>Functions returning none pointer values should always return AXIS2_FAILURE
+<p>Functions returning non pointer values should always return AXIS2_FAILURE
 status code on error whenever possible, or some defined error value (in case
 of returning a struct may be). A relavant error code must also be set in
-env's error struct.</p>
-
-<h2>5 Include Directives</h2>
-<p>It is prefereable to include header files in following fashion:</p>
-
-<pre>
-&lt;standard header files&gt;
-&lt;other system headers&gt;
-"local header files"
-</pre>
-
-
-
+environment's error struct.</p>
 </body>
 </html>