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

From: Matthew Barnes <mbarnes src gnome org>
To: commits-list gnome org
Cc:
Subject: [evolution-data-server] Camel: Fix Gtk-Doc notation in comment blocks.
Date: Mon, 4 Jul 2011 14:59:53 +0000 (UTC)
commit 988d2666aaed47bab3d21c79c3eda216492811c0
Author: Matthew Barnes <mbarnes redhat com>
Date:   Mon Jul 4 10:53:37 2011 -0400

    Camel: Fix Gtk-Doc notation in comment blocks.

 camel/camel-certdb.c         |    4 ++--
 camel/camel-data-wrapper.c   |    4 ++--
 camel/camel-folder-search.c  |    2 +-
 camel/camel-folder-summary.c |    4 ++--
 camel/camel-folder.c         |    4 ++--
 camel/camel-mempool.c        |    2 +-
 camel/camel-mime-filter.c    |    4 ++--
 camel/camel-mime-parser.c    |    6 +++---
 camel/camel-mime-part.c      |    2 +-
 camel/camel-multipart.c      |    2 +-
 camel/camel-service.c        |    4 ++--
 camel/camel-session.c        |    8 ++++----
 camel/camel-store-summary.c  |    4 ++--
 camel/camel-store.c          |    4 ++--
 camel/camel-stream-buffer.c  |    2 +-
 camel/camel-tcp-stream.c     |    6 +++---
 camel/camel-transport.c      |    4 ++--
 camel/camel-vee-folder.c     |    4 ++--
 18 files changed, 35 insertions(+), 35 deletions(-)
---
diff --git a/camel/camel-certdb.c b/camel/camel-certdb.c
index 33a4ae9..37feb6d 100644
--- a/camel/camel-certdb.c
+++ b/camel/camel-certdb.c
@@ -678,7 +678,7 @@ camel_cert_set_trust (CamelCertDB *certdb, CamelCert *cert, CamelCertTrust trust
  * @certdb: a #CamelCertDB
  * @lock: lock type to lock
  *
- * Locks #certdb's #lock. Unlock it with camel_certdb_unlock().
+ * Locks @certdb's @lock. Unlock it with camel_certdb_unlock().
  *
  * Since: 2.32
  **/
@@ -712,7 +712,7 @@ camel_certdb_lock (CamelCertDB *certdb, CamelCertDBLock lock)
  * @certdb: a #CamelCertDB
  * @lock: lock type to unlock
  *
- * Unlocks #certdb's #lock, previously locked with camel_certdb_lock().
+ * Unlocks @certdb's @lock, previously locked with camel_certdb_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-data-wrapper.c b/camel/camel-data-wrapper.c
index aa52d83..58e9704 100644
--- a/camel/camel-data-wrapper.c
+++ b/camel/camel-data-wrapper.c
@@ -611,7 +611,7 @@ camel_data_wrapper_is_offline (CamelDataWrapper *data_wrapper)
  * @data_wrapper: a #CamelDataWrapper
  * @lock: lock type to lock
  *
- * Locks #data_wrapper's #lock. Unlock it with camel_data_wrapper_unlock().
+ * Locks @data_wrapper's @lock. Unlock it with camel_data_wrapper_unlock().
  *
  * Since: 2.32
  **/
@@ -635,7 +635,7 @@ camel_data_wrapper_lock (CamelDataWrapper *data_wrapper,
  * @data_wrapper: a #CamelDataWrapper
  * @lock: lock type to unlock
  *
- * Unlocks #data_wrapper's #lock, previously locked with
+ * Unlocks @data_wrapper's @lock, previously locked with
  * camel_data_wrapper_lock().
  *
  * Since: 2.32
diff --git a/camel/camel-folder-search.c b/camel/camel-folder-search.c
index 78597c0..3b0cb30 100644
--- a/camel/camel-folder-search.c
+++ b/camel/camel-folder-search.c
@@ -314,7 +314,7 @@ camel_folder_search_set_body_index (CamelFolderSearch *search, CamelIndex *index
  * all matches as a GPtrArray of uid's of matching messages.
  *
  * Note that any settings such as set_body_index(), set_folder(),
- * and so on are reset to #NULL once the search has completed.
+ * and so on are reset to %NULL once the search has completed.
  *
  * TODO: The interface should probably return summary items instead
  * (since they are much more useful to any client).
diff --git a/camel/camel-folder-summary.c b/camel/camel-folder-summary.c
index 229b913..c586940 100644
--- a/camel/camel-folder-summary.c
+++ b/camel/camel-folder-summary.c
@@ -4822,7 +4822,7 @@ camel_folder_summary_guess_content_info (CamelMessageInfo *mi, CamelContentType
  * @summary: a #CamelFolderSummary
  * @lock: lock type to lock
  *
- * Locks #summary's #lock. Unlock it with camel_folder_summary_unlock().
+ * Locks @summary's @lock. Unlock it with camel_folder_summary_unlock().
  *
  * Since: 2.32
  **/
@@ -4858,7 +4858,7 @@ camel_folder_summary_lock (CamelFolderSummary *summary,
  * @summary: a #CamelFolderSummary
  * @lock: lock type to unlock
  *
- * Unlocks #summary's #lock, previously locked with camel_folder_summary_lock().
+ * Unlocks @summary's @lock, previously locked with camel_folder_summary_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 0bcddf9..f819d73 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -2923,7 +2923,7 @@ camel_folder_free_deep (CamelFolder *folder,
  * @folder: a #CamelFolder
  * @lock: lock type to lock
  *
- * Locks #folder's #lock. Unlock it with camel_folder_unlock().
+ * Locks @folder's @lock. Unlock it with camel_folder_unlock().
  *
  * Since: 2.32
  **/
@@ -2951,7 +2951,7 @@ camel_folder_lock (CamelFolder *folder,
  * @folder: a #CamelFolder
  * @lock: lock type to unlock
  *
- * Unlocks #folder's #lock, previously locked with camel_folder_lock().
+ * Unlocks @folder's @lock, previously locked with camel_folder_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-mempool.c b/camel/camel-mempool.c
index 21b364c..55ea53d 100644
--- a/camel/camel-mempool.c
+++ b/camel/camel-mempool.c
@@ -164,7 +164,7 @@ camel_mempool_strdup (CamelMemPool *pool,
  *
  * Flush used memory and mark allocated blocks as free.
  *
- * If @freeall is #TRUE, then all allocated blocks are free'd
+ * If @freeall is %TRUE, then all allocated blocks are free'd
  * as well.  Otherwise only blocks above the threshold are
  * actually freed, and the others are simply marked as empty.
  *
diff --git a/camel/camel-mime-filter.c b/camel/camel-mime-filter.c
index af18eee..b912ade 100644
--- a/camel/camel-mime-filter.c
+++ b/camel/camel-mime-filter.c
@@ -282,7 +282,7 @@ camel_mime_filter_reset (CamelMimeFilter *filter)
 
 /**
  * camel_mime_filter_backup:
- * @filter: a #camelMimeFilter object
+ * @filter: a #CamelMimeFilter object
  * @data: data buffer to backup
  * @length: length of @data
  *
@@ -306,7 +306,7 @@ camel_mime_filter_backup (CamelMimeFilter *filter, const gchar *data, gsize leng
 
 /**
  * camel_mime_filter_set_size:
- * @filter: a #camelMimeFilter object
+ * @filter: a #CamelMimeFilter object
  * @size: requested amount of storage space
  * @keep: %TRUE to keep existing buffered data or %FALSE otherwise
  *
diff --git a/camel/camel-mime-parser.c b/camel/camel-mime-parser.c
index e6afd1b..b93b215 100644
--- a/camel/camel-mime-parser.c
+++ b/camel/camel-mime-parser.c
@@ -470,7 +470,7 @@ camel_mime_parser_init_with_stream (CamelMimeParser *parser,
 /**
  * camel_mime_parser_scan_from:
  * @parser: MIME parser object
- * @scan_from: #TRUE if the scanner should scan From lines.
+ * @scan_from: %TRUE if the scanner should scan From lines.
  *
  * Tell the scanner if it should scan "^From " lines or not.
  *
@@ -494,7 +494,7 @@ camel_mime_parser_scan_from (CamelMimeParser *parser, gboolean scan_from)
 /**
  * camel_mime_parser_scan_pre_from:
  * @parser: MIME parser object
- * @scan_pre_from: #TRUE if we want to get pre-from data.
+ * @scan_pre_from: %TRUE if we want to get pre-from data.
  *
  * Tell the scanner whether we want to know abou the pre-from
  * data during a scan.  If we do, then we may get an additional
@@ -574,7 +574,7 @@ camel_mime_parser_drop_step (CamelMimeParser *parser)
  * camel_mime_parser_step:
  * @parser: MIME parser object
  * @databuffer: Pointer to accept a pointer to the data
- * associated with this step (if any).  May be #NULL,
+ * associated with this step (if any).  May be %NULL,
  * in which case datalength is also ingored.
  * @datalength: Pointer to accept a pointer to the data
  * length associated with this step (if any).
diff --git a/camel/camel-mime-part.c b/camel/camel-mime-part.c
index 7d8abb1..57e2273 100644
--- a/camel/camel-mime-part.c
+++ b/camel/camel-mime-part.c
@@ -981,7 +981,7 @@ camel_mime_part_set_content (CamelMimePart *mime_part,
  * @mime_part: a #CamelMimePart
  *
  * Get the disposition of the MIME part as a structure.
- * Returned pointer is owned by #mime_part.
+ * Returned pointer is owned by @mime_part.
  *
  * Returns: the disposition structure
  *
diff --git a/camel/camel-multipart.c b/camel/camel-multipart.c
index 84a5a0e..ea14b33 100644
--- a/camel/camel-multipart.c
+++ b/camel/camel-multipart.c
@@ -462,7 +462,7 @@ camel_multipart_remove_part (CamelMultipart *multipart,
  *
  * Remove the indicated part from the multipart object.
  *
- * Returns: the removed part. Note that it is #g_object_unref'ed
+ * Returns: the removed part. Note that it is g_object_unref()'ed
  * before being returned, which may cause it to be destroyed.
  **/
 CamelMimePart *
diff --git a/camel/camel-service.c b/camel/camel-service.c
index 8301eae..bb2cec7 100644
--- a/camel/camel-service.c
+++ b/camel/camel-service.c
@@ -927,7 +927,7 @@ camel_service_get_connection_status (CamelService *service)
  * @service: a #CamelService
  * @lock: lock type to lock
  *
- * Locks #service's #lock. Unlock it with camel_service_unlock().
+ * Locks @service's @lock. Unlock it with camel_service_unlock().
  *
  * Since: 2.32
  **/
@@ -954,7 +954,7 @@ camel_service_lock (CamelService *service,
  * @service: a #CamelService
  * @lock: lock type to unlock
  *
- * Unlocks #service's #lock, previously locked with camel_service_lock().
+ * Unlocks @service's @lock, previously locked with camel_service_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-session.c b/camel/camel-session.c
index 69ff38a..d09a93d 100644
--- a/camel/camel-session.c
+++ b/camel/camel-session.c
@@ -1120,7 +1120,7 @@ camel_session_forward_to (CamelSession *session,
  * @session: a #CamelSession
  * @lock: lock type to lock
  *
- * Locks #session's #lock. Unlock it with camel_session_unlock().
+ * Locks @session's @lock. Unlock it with camel_session_unlock().
  *
  * Since: 2.32
  **/
@@ -1147,7 +1147,7 @@ camel_session_lock (CamelSession *session,
  * @session: a #CamelSession
  * @lock: lock type to unlock
  *
- * Unlocks #session's #lock, previously locked with camel_session_lock().
+ * Unlocks @session's @lock, previously locked with camel_session_lock().
  *
  * Since: 2.32
  **/
@@ -1172,7 +1172,7 @@ camel_session_unlock (CamelSession *session,
 /**
  * camel_session_set_socks_proxy:
  * @session: A #CamelSession
- * @socks_host: Hostname of the SOCKS proxy, or #NULL for none.
+ * @socks_host: Hostname of the SOCKS proxy, or %NULL for none.
  * @socks_port: Port number of the SOCKS proxy
  *
  * Sets a SOCKS proxy that will be used throughout the @session for
@@ -1204,7 +1204,7 @@ camel_session_set_socks_proxy (CamelSession *session, const gchar *socks_host, g
  * @port_ret: Location to return the SOCKS proxy port
  *
  * Queries the SOCKS proxy that is configured for a @session.  This will
- * put #NULL in @hosts_ret if there is no proxy configured.
+ * put %NULL in @hosts_ret if there is no proxy configured.
  *
  * Since: 2.32
  */
diff --git a/camel/camel-store-summary.c b/camel/camel-store-summary.c
index 75708f6..63bd94c 100644
--- a/camel/camel-store-summary.c
+++ b/camel/camel-store-summary.c
@@ -1081,7 +1081,7 @@ camel_store_info_set_string (CamelStoreSummary *summary,
  * @summary: a #CamelStoreSummary
  * @lock: lock type to lock
  *
- * Locks #summary's #lock. Unlock it with camel_store_summary_unlock().
+ * Locks @summary's @lock. Unlock it with camel_store_summary_unlock().
  *
  * Since: 2.32
  **/
@@ -1111,7 +1111,7 @@ camel_store_summary_lock (CamelStoreSummary *summary,
  * @summary: a #CamelStoreSummary
  * @lock: lock type to unlock
  *
- * Unlocks #summary's #lock, previously locked with camel_store_summary_lock().
+ * Unlocks @summary's @lock, previously locked with camel_store_summary_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-store.c b/camel/camel-store.c
index d9faa27..6b3e821 100644
--- a/camel/camel-store.c
+++ b/camel/camel-store.c
@@ -2001,7 +2001,7 @@ camel_store_can_refresh_folder (CamelStore *store,
  * @store: a #CamelStore
  * @lock: lock type to lock
  *
- * Locks #store's #lock. Unlock it with camel_store_unlock().
+ * Locks @store's @lock. Unlock it with camel_store_unlock().
  *
  * Since: 2.32
  **/
@@ -2025,7 +2025,7 @@ camel_store_lock (CamelStore *store,
  * @store: a #CamelStore
  * @lock: lock type to unlock
  *
- * Unlocks #store's #lock, previously locked with camel_store_lock().
+ * Unlocks @store's @lock, previously locked with camel_store_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-stream-buffer.c b/camel/camel-stream-buffer.c
index e741d0f..9fd7e3e 100644
--- a/camel/camel-stream-buffer.c
+++ b/camel/camel-stream-buffer.c
@@ -482,7 +482,7 @@ camel_stream_buffer_new_with_vbuf (CamelStream *stream,
  * @max-1 characters.
  *
  * If the newline character is encountered, then it will be
- * included in the buffer @buf.  The buffer will be #NUL terminated.
+ * included in the buffer @buf.  The buffer will be %NULL terminated.
  *
  * Returns: the number of characters read, or %0 for end of file,
  * and %-1 on error.
diff --git a/camel/camel-tcp-stream.c b/camel/camel-tcp-stream.c
index 4367cb1..274959c 100644
--- a/camel/camel-tcp-stream.c
+++ b/camel/camel-tcp-stream.c
@@ -165,7 +165,7 @@ camel_tcp_stream_setsockopt (CamelTcpStream *stream,
  * Get the local address of @stream.
  *
  * Returns: the stream's local address (which must be freed with
- * #g_free) if the stream is connected, or %NULL if not
+ * g_free()) if the stream is connected, or %NULL if not
  *
  * Since: 2.22
  **/
@@ -192,7 +192,7 @@ camel_tcp_stream_get_local_address (CamelTcpStream *stream,
  * Get the remote address of @stream.
  *
  * Returns: the stream's remote address (which must be freed with
- * #g_free) if the stream is connected, or %NULL if not.
+ * g_free()) if the stream is connected, or %NULL if not.
  *
  * Since: 2.22
  **/
@@ -266,7 +266,7 @@ camel_tcp_stream_set_socks_proxy (CamelTcpStream *stream,
  * @socks_port_ret: location to return the port number in the SOCKS host
  *
  * Queries the SOCKS proxy that is configured for a @stream.  This will
- * return #NULL in @socks_host_ret if no proxy is configured.
+ * return %NULL in @socks_host_ret if no proxy is configured.
  *
  * Since: 2.32
  */
diff --git a/camel/camel-transport.c b/camel/camel-transport.c
index 5a25c1f..df31dda 100644
--- a/camel/camel-transport.c
+++ b/camel/camel-transport.c
@@ -171,7 +171,7 @@ camel_transport_init (CamelTransport *transport)
  * @transport: a #CamelTransport
  * @lock: lock type to lock
  *
- * Locks #transport's #lock. Unlock it with camel_transport_unlock().
+ * Locks %transport's %lock. Unlock it with camel_transport_unlock().
  *
  * Since: 2.32
  **/
@@ -195,7 +195,7 @@ camel_transport_lock (CamelTransport *transport,
  * @transport: a #CamelTransport
  * @lock: lock type to unlock
  *
- * Unlocks #transport's #lock, previously locked with camel_transport_lock().
+ * Unlocks %transport's %lock, previously locked with camel_transport_lock().
  *
  * Since: 2.32
  **/
diff --git a/camel/camel-vee-folder.c b/camel/camel-vee-folder.c
index c77dcac..1893b2e 100644
--- a/camel/camel-vee-folder.c
+++ b/camel/camel-vee-folder.c
@@ -2529,7 +2529,7 @@ camel_vee_folder_set_unread_vfolder (CamelVeeFolder *folder,
  * @folder: a #CamelVeeFolder
  * @lock: lock type to lock
  *
- * Locks #folder's #lock. Unlock it with camel_vee_folder_unlock().
+ * Locks @folder's @lock. Unlock it with camel_vee_folder_unlock().
  *
  * Since: 2.32
  **/
@@ -2559,7 +2559,7 @@ camel_vee_folder_lock (CamelVeeFolder *folder,
  * @folder: a #CamelVeeFolder
  * @lock: lock type to unlock
  *
- * Unlocks #folder's #lock, previously locked with camel_vee_folder_lock().
+ * Unlocks @folder's @lock, previously locked with camel_vee_folder_lock().
  *
  * Since: 2.32
  **/
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]