[cairo] [PATCH 07/12] doc: Do not use the '@' prefix on some tags

Andrea Canciani ranma42 at gmail.com
Tue Mar 27 04:25:54 PDT 2012


Make the 'Since' and 'Returns' tags consistent by removing the '@'
prefix.

Fixes some "missing 'Since' field" warnings.
---
 src/cairo-image-surface.c  |    2 +-
 src/cairo-script-surface.c |    2 +-
 src/cairo-surface.c        |   10 +++++-----
 src/cairo-user-font.c      |    2 +-
 src/cairo-version.c        |    8 ++++----
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/cairo-image-surface.c b/src/cairo-image-surface.c
index 52f1af8..c118346 100644
--- a/src/cairo-image-surface.c
+++ b/src/cairo-image-surface.c
@@ -77,7 +77,7 @@
  * The image surface backend is always built in.
  * This macro was added for completeness in cairo 1.8.
  *
- * @Since: 1.8
+ * Since: 1.8
  **/
 
 static cairo_bool_t
diff --git a/src/cairo-script-surface.c b/src/cairo-script-surface.c
index e307c1b..89cf525 100644
--- a/src/cairo-script-surface.c
+++ b/src/cairo-script-surface.c
@@ -60,7 +60,7 @@
  * Defined if the script surface backend is available.
  * The script surface backend is always built in since 1.12.
  *
- * @Since: 1.10
+ * Since: 1.10
  **/
 
 
diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index cbc44c2..299ce3b 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -1084,7 +1084,7 @@ _cairo_mime_data_destroy (void *ptr)
  *
  * The Joint Photographic Experts Group (JPEG) 2000 image coding standard (ISO/IEC 15444-1).
  *
- * @Since: 1.10
+ * Since: 1.10
  **/
 
 /**
@@ -1092,7 +1092,7 @@ _cairo_mime_data_destroy (void *ptr)
  *
  * The Joint Photographic Experts Group (JPEG) image coding standard (ISO/IEC 10918-1).
  *
- * @Since: 1.10
+ * Since: 1.10
  **/
 
 /**
@@ -1100,7 +1100,7 @@ _cairo_mime_data_destroy (void *ptr)
  *
  * The Portable Network Graphics image file format (ISO/IEC 15948).
  *
- * @Since: 1.10
+ * Since: 1.10
  **/
 
 /**
@@ -1108,7 +1108,7 @@ _cairo_mime_data_destroy (void *ptr)
  *
  * URI for an image file (unofficial MIME type).
  *
- * @Since: 1.10
+ * Since: 1.10
  **/
 
 /**
@@ -1116,7 +1116,7 @@ _cairo_mime_data_destroy (void *ptr)
  *
  * Unique identifier for a surface (cairo specific MIME type).
  *
- * @Since: 1.12
+ * Since: 1.12
  **/
 
 /**
diff --git a/src/cairo-user-font.c b/src/cairo-user-font.c
index bdac6e4..297f21c 100644
--- a/src/cairo-user-font.c
+++ b/src/cairo-user-font.c
@@ -59,7 +59,7 @@
  * The user font backend is always built in versions of cairo that support
  * this feature (1.8 and later).
  *
- * @Since: 1.8
+ * Since: 1.8
  **/
 
 typedef struct _cairo_user_scaled_font_methods {
diff --git a/src/cairo-version.c b/src/cairo-version.c
index 11f919d..6e13fa5 100644
--- a/src/cairo-version.c
+++ b/src/cairo-version.c
@@ -176,13 +176,13 @@
  * @major: the major component of the version number
  * @minor: the minor component of the version number
  * @micro: the micro component of the version number
- * 
+ *
  * This macro encodes the given cairo version into an integer.  The numbers
  * returned by %CAIRO_VERSION and cairo_version() are encoded using this macro.
  * Two encoded version numbers can be compared as integers.  The encoding ensures
  * that later versions compare greater than earlier versions.
  *
- * @Returns: the encoded version.
+ * Returns: the encoded version.
  **/
 
 /**
@@ -195,9 +195,9 @@
  * returned by %CAIRO_VERSION_STRING and cairo_version_string() are encoded using this macro.
  * The parameters to this macro must expand to numerical literals.
  *
- * @Returns: a string literal containing the version.
+ * Returns: a string literal containing the version.
  *
- * @Since: 1.8
+ * Since: 1.8
  **/
 
 /**
-- 
1.7.5.4



More information about the cairo mailing list