You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ka...@apache.org on 2008/03/31 18:51:44 UTC
svn commit: r643059 - in /webservices/axis2/trunk/c/axiom/include:
axiom_util.h axiom_xml_reader.h axiom_xml_writer.h
Author: kaushalye
Date: Mon Mar 31 09:51:41 2008
New Revision: 643059
URL: http://svn.apache.org/viewvc?rev=643059&view=rev
Log:
Hackathon : Axiom headers
Modified:
webservices/axis2/trunk/c/axiom/include/axiom_util.h
webservices/axis2/trunk/c/axiom/include/axiom_xml_reader.h
webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h
Modified: webservices/axis2/trunk/c/axiom/include/axiom_util.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_util.h?rev=643059&r1=643058&r2=643059&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_util.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_util.h Mon Mar 31 09:51:41 2008
@@ -30,7 +30,6 @@
#endif
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element_with_uri(
axiom_node_t * ele_node,
const axutil_env_t * env,
@@ -38,7 +37,6 @@
axiom_node_t ** child);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_sibling_element_with_uri(
axiom_node_t * ele_node,
const axutil_env_t * env,
@@ -46,7 +44,6 @@
axiom_node_t ** next_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -54,7 +51,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_last_child_element(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -62,7 +58,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_sibling_element(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -70,7 +65,6 @@
axiom_node_t ** next_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element_with_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -79,7 +73,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_last_child_element_with_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -88,7 +81,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_siblng_element_with_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -97,7 +89,6 @@
axiom_node_t ** next_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element_with_uri_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -106,7 +97,6 @@
axis2_char_t * uri,
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_last_child_element_with_uri_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -116,7 +106,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_sibling_element_with_uri_localname(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -126,7 +115,6 @@
axiom_node_t ** next_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element_with_localnames(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -135,7 +123,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_last_child_element_with_localnames(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -144,7 +131,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_siblng_element_with_localnames(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -153,7 +139,6 @@
axiom_node_t ** next_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_first_child_element_with_localname_attr(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -164,7 +149,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_last_child_element_with_localname_attr(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -175,7 +159,6 @@
axiom_node_t ** child_node);
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
axiom_util_get_next_siblng_element_with_localname_attr(
axiom_element_t * ele,
const axutil_env_t * env,
@@ -201,7 +184,6 @@
const axutil_env_t * env);
AXIS2_EXTERN axiom_child_element_iterator_t *AXIS2_CALL
-
axiom_util_get_child_elements(
axiom_element_t * om_ele,
const axutil_env_t * env,
Modified: webservices/axis2/trunk/c/axiom/include/axiom_xml_reader.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_xml_reader.h?rev=643059&r1=643058&r2=643059&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_xml_reader.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_xml_reader.h Mon Mar 31 09:51:41 2008
@@ -426,117 +426,230 @@
axiom_xml_reader_cleanup(
);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_xml_reader_next(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_xml_reader_free(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_xml_reader_get_attribute_count(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_attribute_name_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_attribute_prefix_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_attribute_value_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_attribute_namespace_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_value(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_xml_reader_get_namespace_count(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_namespace_uri_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_namespace_prefix_by_number(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
int i);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_prefix(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_name(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_pi_target(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_pi_data(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_dtd(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_xml_reader_xml_free(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
void *data);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_char_set_encoding(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_reader_get_namespace_uri(
axiom_xml_reader_t * parser,
const axutil_env_t * env);
+ /**
+ *
+ * @param parser pointer to the OM XML Reader struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_xml_reader_get_namespace_uri_by_prefix(
axiom_xml_reader_t * parser,
const axutil_env_t * env,
Modified: webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h?rev=643059&r1=643058&r2=643059&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h Mon Mar 31 09:51:41 2008
@@ -553,8 +553,12 @@
int is_prefix_default,
int compression);
+ /**
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axiom_xml_writer_t *AXIS2_CALL
-
axiom_xml_writer_create_for_memory(
const axutil_env_t * env,
axis2_char_t * encoding,
@@ -562,34 +566,61 @@
int compression,
int type);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_xml_writer_free(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_start_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_end_start_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_start_element_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_start_element_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
@@ -597,23 +628,38 @@
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_empty_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_empty_element_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * localname,
axis2_char_t * namespace_uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_empty_element_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
@@ -621,18 +667,34 @@
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_end_element(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_end_document(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_attribute(
axiom_xml_writer_t * writer,
@@ -640,8 +702,13 @@
axis2_char_t * localname,
axis2_char_t * value);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_attribute_with_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
@@ -649,8 +716,13 @@
axis2_char_t * value,
axis2_char_t * namespace_uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_attribute_with_namespace_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
@@ -659,6 +731,12 @@
axis2_char_t * namespace_uri,
axis2_char_t * prefix);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_namespace(
axiom_xml_writer_t * writer,
@@ -666,85 +744,157 @@
axis2_char_t * prefix,
axis2_char_t * namespace_uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_default_namespace(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * namespace_uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_comment(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * value);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_processing_instruction(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_processing_instruction_data(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * target,
axis2_char_t * data);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_cdata(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * data);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_dtd(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * dtd);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_entity_ref(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * name);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_start_document(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_start_document_with_version(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_write_start_document_with_version_encoding(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * version,
axis2_char_t * encoding);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_characters(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * text);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_xml_writer_get_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_set_prefix(
axiom_xml_writer_t * writer,
@@ -752,13 +902,24 @@
axis2_char_t * prefix,
axis2_char_t * uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_xml_writer_set_default_prefix(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * uri);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_encoded(
axiom_xml_writer_t * writer,
@@ -766,27 +927,57 @@
axis2_char_t * text,
int in_attr);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN void *AXIS2_CALL
axiom_xml_writer_get_xml(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN unsigned int AXIS2_CALL
axiom_xml_writer_get_xml_size(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_xml_writer_get_type(
axiom_xml_writer_t * writer,
const axutil_env_t * env);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_write_raw(
axiom_xml_writer_t * writer,
const axutil_env_t * env,
axis2_char_t * content);
+ /**
+ * @param writer pointer to the OM XML Writer struct
+ * @param env environment struct, must not be null
+ *
+ * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_xml_writer_flush(
axiom_xml_writer_t * writer,
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org