From bc17057ec598cd5f755fd66244c429ecc51cff01 Mon Sep 17 00:00:00 2001 From: Dan Winship Date: Tue, 18 Apr 2000 18:11:24 +0000 Subject: Clean, polish, document. Most of the gtk-doc comments added to * camel-data-wrapper.[ch]: * camel-simple-data-wrapper.[ch]: * camel-medium.[ch]: Clean, polish, document. Most of the gtk-doc comments added to camel-data-wrapper.c note serious problems that need to be fixed. svn path=/trunk/; revision=2483 --- camel/camel-data-wrapper.h | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) (limited to 'camel/camel-data-wrapper.h') diff --git a/camel/camel-data-wrapper.h b/camel/camel-data-wrapper.h index 1fec594f62..0805bc47ce 100644 --- a/camel/camel-data-wrapper.h +++ b/camel/camel-data-wrapper.h @@ -1,15 +1,15 @@ /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ /* camelDataWrapper.h : Abstract class for a data wrapper */ -/* +/* * - * Author : + * Author : * Bertrand Guiheneuf * * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com) * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) any later version. * @@ -60,28 +60,27 @@ struct _CamelDataWrapper typedef struct { GtkObjectClass parent_class; - - /* Virtual methods */ - void (*set_input_stream) (CamelDataWrapper *data_wrapper, + + /* Virtual methods */ + void (*set_input_stream) (CamelDataWrapper *data_wrapper, CamelStream *stream); CamelStream * (*get_input_stream) (CamelDataWrapper *data_wrapper); - void (*set_output_stream) (CamelDataWrapper *data_wrapper, + void (*set_output_stream) (CamelDataWrapper *data_wrapper, CamelStream *stream); CamelStream * (*get_output_stream) (CamelDataWrapper *data_wrapper); - void (*set_mime_type) (CamelDataWrapper *data_wrapper, + void (*set_mime_type) (CamelDataWrapper *data_wrapper, const gchar * mime_type); gchar * (*get_mime_type) (CamelDataWrapper *data_wrapper); GMimeContentField * (*get_mime_type_field) (CamelDataWrapper *data_wrapper); - void (*set_mime_type_field) (CamelDataWrapper *data_wrapper, + void (*set_mime_type_field) (CamelDataWrapper *data_wrapper, GMimeContentField *mime_type_field); /* deprecated method */ - CamelStream * (*get_stream) (CamelDataWrapper *data_wrapper); - void (*write_to_stream) (CamelDataWrapper *data_wrapper, + void (*write_to_stream) (CamelDataWrapper *data_wrapper, CamelStream *stream); - void (*construct_from_stream) (CamelDataWrapper *data_wrapper, + void (*construct_from_stream) (CamelDataWrapper *data_wrapper, CamelStream *stream); } CamelDataWrapperClass; @@ -94,27 +93,26 @@ GtkType camel_data_wrapper_get_type (void); /* public methods */ -void camel_data_wrapper_write_to_stream (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream); -void camel_data_wrapper_set_mime_type (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_set_mime_type (CamelDataWrapper *data_wrapper, const gchar *mime_type); gchar * camel_data_wrapper_get_mime_type (CamelDataWrapper *data_wrapper); GMimeContentField * camel_data_wrapper_get_mime_type_field (CamelDataWrapper *data_wrapper); -void camel_data_wrapper_set_mime_type_field (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_set_mime_type_field (CamelDataWrapper *data_wrapper, GMimeContentField *mime_type); -void camel_data_wrapper_set_input_stream (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_set_input_stream (CamelDataWrapper *data_wrapper, CamelStream *stream); CamelStream * camel_data_wrapper_get_input_stream (CamelDataWrapper *data_wrapper); -void camel_data_wrapper_set_output_stream (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_set_output_stream (CamelDataWrapper *data_wrapper, CamelStream *stream); CamelStream * camel_data_wrapper_get_output_stream (CamelDataWrapper *data_wrapper); /* deprecated methods. Left until the new parser scheme is ok */ -CamelStream * camel_data_wrapper_get_stream (CamelDataWrapper *data_wrapper); -void camel_data_wrapper_construct_from_stream (CamelDataWrapper *data_wrapper, +void camel_data_wrapper_construct_from_stream (CamelDataWrapper *data_wrapper, CamelStream *stream); #ifdef __cplusplus -- cgit