GNOME.org
 

[evolution-data-server] Fix Gtk-Doc notation in Camel.

commit c909d0c21f4c2ebf15a463c1b762941070420ad6
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sun Apr 17 14:35:38 2011 -0400

    Fix Gtk-Doc notation in Camel.

 camel/camel-data-wrapper.c     |    2 +-
 camel/camel-folder-summary.c   |    8 +++---
 camel/camel-folder.c           |   48 ++++++++++++++++++++--------------------
 camel/camel-medium.c           |    4 +-
 camel/camel-mime-filter-yenc.c |    2 +-
 camel/camel-mime-filter.c      |    6 ++--
 camel/camel-mime-utils.c       |    4 +-
 camel/camel-multipart.c        |    2 +-
 camel/camel-session.c          |    8 +++---
 camel/camel-store-summary.c    |   12 +++++-----
 camel/camel-store.c            |   10 ++++----
 camel/camel-stream-buffer.c    |    2 +-
 camel/camel-stream-filter.c    |    2 +-
 13 files changed, 55 insertions(+), 55 deletions(-)
---
diff --git a/camel/camel-data-wrapper.c b/camel/camel-data-wrapper.c
index 8327bfd..aa52d83 100644
--- a/camel/camel-data-wrapper.c
+++ b/camel/camel-data-wrapper.c
@@ -568,7 +568,7 @@ camel_data_wrapper_get_mime_type_field (CamelDataWrapper *data_wrapper)
  * @mime_type: a #CamelContentType
  *
  * This sets the data wrapper's MIME type. It suffers from the same
- * flaws as #camel_data_wrapper_set_mime_type.
+ * flaws as camel_data_wrapper_set_mime_type().
  **/
 void
 camel_data_wrapper_set_mime_type_field (CamelDataWrapper *data_wrapper,
diff --git a/camel/camel-folder-summary.c b/camel/camel-folder-summary.c
index 8234fce..3de1edb4 100644
--- a/camel/camel-folder-summary.c
+++ b/camel/camel-folder-summary.c
@@ -2414,7 +2414,7 @@ summary_assign_uid (CamelFolderSummary *s, CamelMessageInfo *info)
  *
  * Adds a new @info record to the summary.  If @info->uid is %NULL,
  * then a new uid is automatically re-assigned by calling
- * #camel_folder_summary_next_uid_string.
+ * camel_folder_summary_next_uid_string().
  *
  * The @info record should have been generated by calling one of the
  * info_new_*() functions, as it will be free'd based on the summary
@@ -2620,7 +2620,7 @@ camel_folder_summary_add_from_message (CamelFolderSummary *s, CamelMimeMessage *
  * Create a new info record from a header.
  *
  * Returns: the newly allocated record which must be freed with
- * #camel_message_info_free
+ * camel_message_info_free()
  **/
 CamelMessageInfo *
 camel_folder_summary_info_new_from_header (CamelFolderSummary *summary,
@@ -2655,7 +2655,7 @@ camel_folder_summary_info_new_from_header (CamelFolderSummary *summary,
  * the message.
  *
  * Returns: the newly allocated record which must be freed with
- * #camel_message_info_free
+ * camel_message_info_free()
  **/
 CamelMessageInfo *
 camel_folder_summary_info_new_from_parser (CamelFolderSummary *s, CamelMimeParser *mp)
@@ -2716,7 +2716,7 @@ camel_folder_summary_info_new_from_parser (CamelFolderSummary *s, CamelMimeParse
  * Create a summary item from a message.
  *
  * Returns: the newly allocated record which must be freed using
- * #camel_message_info_free
+ * camel_message_info_free()
  **/
 CamelMessageInfo *
 camel_folder_summary_info_new_from_message (CamelFolderSummary *s, CamelMimeMessage *msg, const gchar *bodystructure)
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index d3f2787..2a762f6 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -1922,7 +1922,7 @@ camel_folder_get_message_count (CamelFolder *folder)
  * camel_folder_get_unread_message_count:
  * @folder: a #CamelFolder
  *
- * DEPRECATED: use #camel_object_get instead.
+ * DEPRECATED: use camel_object_get() instead.
  *
  * Returns: the number of unread messages in the folder, or %-1 if
  * unknown
@@ -1978,7 +1978,7 @@ camel_folder_get_permanent_flags (CamelFolder *folder)
  * @folder: a #CamelFolder
  * @uid: the UID of a message in @folder
  *
- * Deprecated: Use #camel_folder_get_message_info instead.
+ * Deprecated: Use camel_folder_get_message_info() instead.
  *
  * Returns: the #CamelMessageFlags that are set on the indicated
  * message.
@@ -2007,12 +2007,12 @@ camel_folder_get_message_flags (CamelFolder *folder,
  *
  * Sets those flags specified by @flags to the values specified by @set
  * on the indicated message. (This may or may not persist after the
- * folder or store is closed. See #camel_folder_get_permanent_flags)
+ * folder or store is closed. See camel_folder_get_permanent_flags())
  *
  * E.g. to set the deleted flag and clear the draft flag, use
- * #camel_folder_set_message_flags (folder, uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_DRAFT, CAMEL_MESSAGE_DELETED);
+ * camel_folder_set_message_flags (folder, uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_DRAFT, CAMEL_MESSAGE_DELETED);
  *
- * DEPRECATED: Use #camel_message_info_set_flags on the message info directly
+ * DEPRECATED: Use camel_message_info_set_flags() on the message info directly
  * (when it works)
  *
  * Returns: %TRUE if the flags were changed or %FALSE otherwise
@@ -2045,7 +2045,7 @@ camel_folder_set_message_flags (CamelFolder *folder,
  * @uid: the UID of a message in @folder
  * @name: the name of a user flag
  *
- * DEPRECATED: Use #camel_message_info_get_user_flag on the message
+ * DEPRECATED: Use camel_message_info_get_user_flag() on the message
  * info directly
  *
  * Returns: %TRUE if the given user flag is set on the message or
@@ -2075,12 +2075,12 @@ camel_folder_get_message_user_flag (CamelFolder *folder,
  * @name: the name of the user flag to set
  * @value: the value to set it to
  *
- * DEPRECATED: Use #camel_message_info_set_user_flag on the
+ * DEPRECATED: Use camel_message_info_set_user_flag() on the
  * #CamelMessageInfo directly (when it works)
  *
  * Sets the user flag specified by @name to the value specified by @value
  * on the indicated message. (This may or may not persist after the
- * folder or store is closed. See #camel_folder_get_permanent_flags)
+ * folder or store is closed. See camel_folder_get_permanent_flags())
  **/
 void
 camel_folder_set_message_user_flag (CamelFolder *folder,
@@ -2106,7 +2106,7 @@ camel_folder_set_message_user_flag (CamelFolder *folder,
  * @uid: the UID of a message in @folder
  * @name: the name of a user tag
  *
- * DEPRECATED: Use #camel_message_info_get_user_tag on the
+ * DEPRECATED: Use camel_message_info_get_user_tag() on the
  * #CamelMessageInfo directly.
  *
  * Returns: the value of the user tag
@@ -2136,12 +2136,12 @@ camel_folder_get_message_user_tag (CamelFolder *folder,
  * @name: the name of the user tag to set
  * @value: the value to set it to
  *
- * DEPRECATED: Use #camel_message_info_set_user_tag on the
+ * DEPRECATED: Use camel_message_info_set_user_tag() on the
  * #CamelMessageInfo directly (when it works).
  *
  * Sets the user tag specified by @name to the value specified by @value
  * on the indicated message. (This may or may not persist after the
- * folder or store is closed. See #camel_folder_get_permanent_flags)
+ * folder or store is closed. See camel_folder_get_permanent_flags())
  **/
 void
 camel_folder_set_message_user_tag (CamelFolder *folder,
@@ -2167,7 +2167,7 @@ camel_folder_set_message_user_tag (CamelFolder *folder,
  * @uid: the uid of a message
  *
  * Retrieve the #CamelMessageInfo for the specified @uid.  This return
- * must be freed using #camel_folder_free_message_info.
+ * must be freed using camel_folder_free_message_info().
  *
  * Returns: the summary information for the indicated message, or %NULL
  * if the uid does not exist
@@ -2193,7 +2193,7 @@ camel_folder_get_message_info (CamelFolder *folder,
  * @info: a #CamelMessageInfo
  *
  * Free (unref) a #CamelMessageInfo, previously obtained with
- * #camel_folder_get_message_info.
+ * camel_folder_get_message_info().
  **/
 void
 camel_folder_free_message_info (CamelFolder *folder,
@@ -2215,10 +2215,10 @@ camel_folder_free_message_info (CamelFolder *folder,
  * @folder: a #CamelFolder
  * @info: a #CamelMessageInfo
  *
- * DEPRECATED: Use #camel_message_info_ref directly.
+ * DEPRECATED: Use camel_message_info_ref() directly.
  *
  * Ref a #CamelMessageInfo, previously obtained with
- * #camel_folder_get_message_info.
+ * camel_folder_get_message_info().
  **/
 void
 camel_folder_ref_message_info (CamelFolder *folder,
@@ -2261,7 +2261,7 @@ camel_folder_has_summary_capability (CamelFolder *folder)
  * Get the list of UIDs available in a folder. This routine is useful
  * for finding what messages are available when the folder does not
  * support summaries. The returned array should not be modified, and
- * must be freed by passing it to #camel_folder_free_uids.
+ * must be freed by passing it to camel_folder_free_uids().
  *
  * Returns: a GPtrArray of UIDs corresponding to the messages available
  * in the folder
@@ -2284,7 +2284,7 @@ camel_folder_get_uids (CamelFolder *folder)
  * @folder: a #CamelFolder
  * @array: the array of uids to free
  *
- * Frees the array of UIDs returned by #camel_folder_get_uids.
+ * Frees the array of UIDs returned by camel_folder_get_uids().
  **/
 void
 camel_folder_free_uids (CamelFolder *folder,
@@ -2308,8 +2308,8 @@ camel_folder_free_uids (CamelFolder *folder,
  *
  * Returns the known-uncached uids from a list of uids. It may return uids
  * which are locally cached but should never filter out a uid which is not
- * locally cached. Free the result by called #camel_folder_free_uids.
- * Frees the array of UIDs returned by #camel_folder_get_uids.
+ * locally cached. Free the result by called camel_folder_free_uids().
+ * Frees the array of UIDs returned by camel_folder_get_uids().
  *
  * Since: 2.26
  **/
@@ -2393,7 +2393,7 @@ camel_folder_sort_uids (CamelFolder *folder,
  *
  * This returns the summary information for the folder. This array
  * should not be modified, and must be freed with
- * #camel_folder_free_summary.
+ * camel_folder_free_summary().
  *
  * Returns: an array of #CamelMessageInfo
  **/
@@ -2415,7 +2415,7 @@ camel_folder_get_summary (CamelFolder *folder)
  * @folder: a #CamelFolder
  * @array: the summary array to free
  *
- * Frees the summary array returned by #camel_folder_get_summary.
+ * Frees the summary array returned by camel_folder_get_summary().
  **/
 void
 camel_folder_free_summary (CamelFolder *folder,
@@ -2551,8 +2551,8 @@ camel_folder_search_by_uids (CamelFolder *folder,
  * @folder: a #CamelFolder
  * @result: search results to free
  *
- * Free the result of a search as gotten by #camel_folder_search or
- * #camel_folder_search_by_uids.
+ * Free the result of a search as gotten by camel_folder_search() or
+ * camel_folder_search_by_uids().
  **/
 void
 camel_folder_search_free (CamelFolder *folder,
@@ -2708,7 +2708,7 @@ camel_folder_changed (CamelFolder *folder,
  *
  * Freezes the folder so that a series of operation can be performed
  * without "folder_changed" signals being emitted.  When the folder is
- * later thawed with #camel_folder_thaw, the suppressed signals will
+ * later thawed with camel_folder_thaw(), the suppressed signals will
  * be emitted.
  **/
 void
diff --git a/camel/camel-medium.c b/camel/camel-medium.c
index 7799607..5f3d46e 100644
--- a/camel/camel-medium.c
+++ b/camel/camel-medium.c
@@ -284,7 +284,7 @@ camel_medium_get_header (CamelMedium *medium,
  * caller should not modify the returned data.
  *
  * Returns: the array of headers, which must be freed with
- * #camel_medium_free_headers.
+ * camel_medium_free_headers().
  **/
 GArray *
 camel_medium_get_headers (CamelMedium *medium)
@@ -302,7 +302,7 @@ camel_medium_get_headers (CamelMedium *medium)
 /**
  * camel_medium_free_headers:
  * @medium: a #CamelMedium object
- * @headers: an array of headers returned from #camel_medium_get_headers
+ * @headers: an array of headers returned from camel_medium_get_headers()
  *
  * Frees @headers.
  **/
diff --git a/camel/camel-mime-filter-yenc.c b/camel/camel-mime-filter-yenc.c
index 16c738a..375d19e 100644
--- a/camel/camel-mime-filter-yenc.c
+++ b/camel/camel-mime-filter-yenc.c
@@ -533,7 +533,7 @@ camel_yencode_step (const guchar *in, gsize inlen, guchar *out,
  * @crc: crc state
  *
  * Call this function when finished encoding data with
- * #camel_yencode_step to flush off the remaining state.
+ * camel_yencode_step() to flush off the remaining state.
  *
  * #CAMEL_MIME_YENCODE_CRC_FINAL (@pcrc) will give you the crc32 of the
  * encoded "part". If there are more "parts" to encode, you should
diff --git a/camel/camel-mime-filter.c b/camel/camel-mime-filter.c
index c54c689..af18eee 100644
--- a/camel/camel-mime-filter.c
+++ b/camel/camel-mime-filter.c
@@ -233,8 +233,8 @@ camel_mime_filter_filter (CamelMimeFilter *filter,
  * Passes the input buffer, @in, through @filter and generates an
  * output buffer, @out and makes sure that all data is flushed to the
  * output buffer. This must be the last filtering call made, no
- * further calls to #camel_mime_filter_filter may be called on @filter
- * until @filter has been reset using #camel_mime_filter_reset.
+ * further calls to camel_mime_filter_filter() may be called on @filter
+ * until @filter has been reset using camel_mime_filter_reset().
  **/
 void
 camel_mime_filter_complete (CamelMimeFilter *filter,
@@ -287,7 +287,7 @@ camel_mime_filter_reset (CamelMimeFilter *filter)
  * @length: length of @data
  *
  * Saves @data to be used as prespace input data to the next call to
- * #camel_mime_filter_filter or #camel_mime_filter_complete.
+ * camel_mime_filter_filter() or camel_mime_filter_complete().
  *
  * Note: New calls replace old data.
  **/
diff --git a/camel/camel-mime-utils.c b/camel/camel-mime-utils.c
index 48ec57f..1f6c8c5 100644
--- a/camel/camel-mime-utils.c
+++ b/camel/camel-mime-utils.c
@@ -89,7 +89,7 @@ static const guchar tohex[16] = {
  * @save: leftover bits that have not yet been encoded
  *
  * Uuencodes a chunk of data. Call this when finished encoding data
- * with #camel_uuencode_step to flush off the last little bit.
+ * with camel_uuencode_step() to flush off the last little bit.
  *
  * Returns: the number of bytes encoded
  **/
@@ -383,7 +383,7 @@ camel_uudecode_step (guchar *in, gsize len, guchar *out, gint *state, guint32 *s
  * @save: leftover bits that have not yet been encoded
  *
  * Quoted-printable encodes a block of text. Call this when finished
- * encoding data with #camel_quoted_encode_step to flush off
+ * encoding data with camel_quoted_encode_step() to flush off
  * the last little bit.
  *
  * Returns: the number of bytes encoded
diff --git a/camel/camel-multipart.c b/camel/camel-multipart.c
index 5d76f8c..84a5a0e 100644
--- a/camel/camel-multipart.c
+++ b/camel/camel-multipart.c
@@ -415,7 +415,7 @@ camel_multipart_add_part (CamelMultipart *multipart,
  *
  * Adds the part to the multipart object after the @index'th
  * element. If @index is greater than the number of parts, it is
- * equivalent to #camel_multipart_add_part.
+ * equivalent to camel_multipart_add_part().
  **/
 void
 camel_multipart_add_part_at (CamelMultipart *multipart,
diff --git a/camel/camel-session.c b/camel/camel-session.c
index 9146d8d..20b2a0d 100644
--- a/camel/camel-session.c
+++ b/camel/camel-session.c
@@ -500,9 +500,9 @@ camel_session_get_service (CamelSession *session,
  * @type: the provider type
  * @error: return location for a #GError, or %NULL
  *
- * This works like #camel_session_get_service, but also ensures that
+ * This works like camel_session_get_service(), but also ensures that
  * the returned service will have been successfully connected (via
- * #camel_service_connect.)
+ * camel_service_connect().)
  *
  * Returns: the requested #CamelService, or %NULL
  **/
@@ -633,12 +633,12 @@ camel_session_get_password (CamelSession *session,
  *
  * This function is used by a #CamelService to tell the application
  * that the authentication information it provided via
- * #camel_session_get_password was rejected by the service. If the
+ * camel_session_get_password() was rejected by the service. If the
  * application was caching this information, it should stop,
  * and if the service asks for it again, it should ask the user.
  *
  * @service and @item identify the rejected authentication information,
- * as with #camel_session_get_password.
+ * as with camel_session_get_password().
  *
  * Returns: %TRUE on success, %FALSE on failure
  **/
diff --git a/camel/camel-store-summary.c b/camel/camel-store-summary.c
index d15bf1a..ac4e56f 100644
--- a/camel/camel-store-summary.c
+++ b/camel/camel-store-summary.c
@@ -417,7 +417,7 @@ camel_store_summary_count (CamelStoreSummary *summary)
  * A referenced to the summary item is returned, which may be ref'd or
  * free'd as appropriate.
  *
- * It must be freed using #camel_store_summary_info_free.
+ * It must be freed using camel_store_summary_info_free().
  *
  * Returns: the summary item, or %NULL if @index is out of range
  **/
@@ -452,7 +452,7 @@ camel_store_summary_index (CamelStoreSummary *summary,
  * Obtain a copy of the summary array.  This is done atomically,
  * so cannot contain empty entries.
  *
- * It must be freed using #camel_store_summary_array_free.
+ * It must be freed using camel_store_summary_array_free().
  *
  * Returns: the summary array
  **/
@@ -484,7 +484,7 @@ camel_store_summary_array (CamelStoreSummary *summary)
 /**
  * camel_store_summary_array_free:
  * @summary: a #CamelStoreSummary object
- * @array: the summary array as gotten from #camel_store_summary_array
+ * @array: the summary array as gotten from camel_store_summary_array()
  *
  * Free the folder summary array.
  **/
@@ -513,7 +513,7 @@ camel_store_summary_array_free (CamelStoreSummary *summary,
  * A referenced to the summary item is returned, which may be ref'd or
  * free'd as appropriate.
  *
- * It must be freed using #camel_store_summary_info_free.
+ * It must be freed using camel_store_summary_info_free().
  *
  * Returns: the summary item, or %NULL if the @path name is not
  * available
@@ -730,7 +730,7 @@ camel_store_summary_header_load (CamelStoreSummary *summary)
  *
  * Adds a new @info record to the summary.  If @info->uid is %NULL,
  * then a new uid is automatically re-assigned by calling
- * #camel_store_summary_next_uid_string.
+ * camel_store_summary_next_uid_string().
  *
  * The @info record should have been generated by calling one of the
  * info_new_*() functions, as it will be free'd based on the summary
@@ -803,7 +803,7 @@ camel_store_summary_add_from_path (CamelStoreSummary *summary,
  * Create a new info record from a name.
  *
  * This info record MUST be freed using
- * #camel_store_summary_info_free, #camel_store_info_free will not
+ * camel_store_summary_info_free(), camel_store_info_free() will not
  * work.
  *
  * Returns: the #CamelStoreInfo associated with @path
diff --git a/camel/camel-store.c b/camel/camel-store.c
index b4a87ad..1f0b5ee 100644
--- a/camel/camel-store.c
+++ b/camel/camel-store.c
@@ -1690,9 +1690,9 @@ dump_fi (CamelFolderInfo *fi, gint depth)
 /**
  * camel_store_free_folder_info:
  * @store: a #CamelStore
- * @fi: a #CamelFolderInfo as gotten via #camel_store_get_folder_info
+ * @fi: a #CamelFolderInfo as gotten via camel_store_get_folder_info()
  *
- * Frees the data returned by #camel_store_get_folder_info. If @fi is %NULL,
+ * Frees the data returned by camel_store_get_folder_info(). If @fi is %NULL,
  * nothing is done, the routine simply returns.
  **/
 void
@@ -1715,7 +1715,7 @@ camel_store_free_folder_info (CamelStore *store,
 /**
  * camel_store_free_folder_info_full:
  * @store: a #CamelStore
- * @fi: a #CamelFolderInfo as gotten via #camel_store_get_folder_info
+ * @fi: a #CamelFolderInfo as gotten via camel_store_get_folder_info()
  *
  * An implementation for #CamelStore::free_folder_info. Frees all
  * of the data.
@@ -1730,7 +1730,7 @@ camel_store_free_folder_info_full (CamelStore *store,
 /**
  * camel_store_free_folder_info_nop:
  * @store: a #CamelStore
- * @fi: a #CamelFolderInfo as gotten via #camel_store_get_folder_info
+ * @fi: a #CamelFolderInfo as gotten via camel_store_get_folder_info()
  *
  * An implementation for #CamelStore::free_folder_info. Does nothing.
  **/
@@ -1795,7 +1795,7 @@ folder_info_cmp (gconstpointer ap,
  * to the hierarchy described by their full_names and @separator. If
  * @namespace is non-%NULL, then it will be ignored as a full_name
  * prefix, for purposes of comparison. If necessary,
- * #camel_folder_info_build will create additional #CamelFolderInfo with
+ * camel_folder_info_build() will create additional #CamelFolderInfo with
  * %NULL urls to fill in gaps in the tree. The value of @short_names
  * is used in constructing the names of these intermediate folders.
  *
diff --git a/camel/camel-stream-buffer.c b/camel/camel-stream-buffer.c
index 8e2617f..e741d0f 100644
--- a/camel/camel-stream-buffer.c
+++ b/camel/camel-stream-buffer.c
@@ -389,7 +389,7 @@ camel_stream_buffer_init (CamelStreamBuffer *stream)
  * buffer size (1024 bytes), automatically managed will be used
  * for buffering.
  *
- * See #camel_stream_buffer_new_with_vbuf for details on the
+ * See camel_stream_buffer_new_with_vbuf() for details on the
  * @mode parameter.
  *
  * Returns: a newly created buffered stream.
diff --git a/camel/camel-stream-filter.c b/camel/camel-stream-filter.c
index fc6646f..a647b5a 100644
--- a/camel/camel-stream-filter.c
+++ b/camel/camel-stream-filter.c
@@ -421,7 +421,7 @@ camel_stream_filter_add (CamelStreamFilter *stream,
 /**
  * camel_stream_filter_remove:
  * @stream: a #CamelStreamFilter object
- * @id: Filter id, as returned from #camel_stream_filter_add
+ * @id: Filter id, as returned from camel_stream_filter_add()
  *
  * Remove a processing filter from the stream by id.
  **/
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]