From 82c14810dd1c101f20052c4ab92f33c57a255cc1 Mon Sep 17 00:00:00 2001
From: m0gg
Date: Sat, 25 Nov 2006 15:06:57 +0000
Subject: documentation enhancements and code cleanup

---
 libcsoap/soap-ctx.h | 55 ++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 35 insertions(+), 20 deletions(-)

(limited to 'libcsoap/soap-ctx.h')

diff --git a/libcsoap/soap-ctx.h b/libcsoap/soap-ctx.h
index b8bfb3d..a1c041a 100755
--- a/libcsoap/soap-ctx.h
+++ b/libcsoap/soap-ctx.h
@@ -1,5 +1,5 @@
 /******************************************************************
- *  $Id: soap-ctx.h,v 1.12 2006/11/23 15:27:33 m0gg Exp $
+ *  $Id: soap-ctx.h,v 1.13 2006/11/25 15:06:57 m0gg Exp $
  *
  * CSOAP Project:  A SOAP client/server library in C
  * Copyright (C) 2003-2004  Ferhat Ayaz
@@ -32,40 +32,55 @@
 struct SoapCtx
 {
   struct SoapEnv *env;
-  attachments_t *attachments;
+  struct attachments_t *attachments;
 };
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/* should only be used internally */
+/**
+ *
+ * should only be used internally
+ *
+ */
 extern struct SoapCtx *soap_ctx_new(struct SoapEnv * env);
 
 /**
-	Creates a new soap context object.
-*/
+ *
+ * Creates a new soap context object.
+ *
+ */
 extern herror_t soap_ctx_new_with_method(const char *urn, const char *method, struct SoapCtx ** out);
 
 extern void soap_ctx_free(struct SoapCtx * ctx);
+
 /**
-	Returns the attached file if any found. 
-	@param ctx the SoapCtx object which should contain the part
-	@param node the xml node which points to a file via the "href" xml attribute
+ *
+ * Returns the attached file if any found. 
+ *
+ * @param ctx the SoapCtx object which should contain the part
+ * @param node the xml node which points to a file via the "href" xml attribute
+ *
+ * @returns a part_t object of attachment was found, NULL otherwise.
+ *
+ */
+extern struct part_t *soap_ctx_get_file(struct SoapCtx * ctx, xmlNodePtr node);
 
-	@returns a part_t object of attachment was found, NULL otherwise.
-	  
-*/
-extern part_t *soap_ctx_get_file(struct SoapCtx * ctx, xmlNodePtr node);
+/**
+ *
+ * Size of destination dest_href should be MAX_HREF_SIZE
+ *
+ */
+extern herror_t soap_ctx_add_file(struct SoapCtx * ctx, const char *filename, const char *content_type, char *dest_href);
 
-/* Size of destination dest_href should be MAX_HREF_SIZE */
-extern herror_t soap_ctx_add_file(struct SoapCtx * ctx, const char *filename,
-                           const char *content_type, char *dest_href);
-/* 
-Used internally. Will switch the deleteOnExit flag from the 
-given one to the added part.
-*/
-extern void soap_ctx_add_files(struct SoapCtx * ctx, attachments_t * attachments);
+/**
+ *
+ * Used internally. Will switch the deleteOnExit flag from the given one to the
+ * added part.
+ *
+ */
+extern void soap_ctx_add_files(struct SoapCtx * ctx, struct attachments_t * attachments);
 
 #ifdef __cplusplus
 }
-- 
cgit v1.1-32-gdbae