comment cosmetics

git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@9098 67ed7778-7388-44ab-90cf-0a291f65f57c

1 files changed, 45 insertions, 16 deletions

diff --git a/libgphoto2/gphoto2-file.c b/libgphoto2/gphoto2-file.c
index 58e40e69d..8406082f6 100644
--- a/libgphoto2/gphoto2-file.c
+++ b/libgphoto2/gphoto2-file.c
@@ -49,9 +49,8 @@
 # define MAX_PATH 256
 #endif
 
-/*
- * @internal
- * The internals of the CameraFile struct are private.
+/*! The internals of the CameraFile struct are private.
+ * \internal
  */
 struct _CameraFile {
         CameraFileType type;
@@ -71,11 +70,12 @@ struct _CameraFile {
         char header [128];
 };
 
-/**
- * @param file a pointer to a #CameraFile
- * @return a gphoto2 error code.
+
+/*! Create new #CameraFile object.
  *
- **/
+ * \param file a pointer to a #CameraFile
+ * \return a gphoto2 error code.
+ */
 int
 gp_file_new (CameraFile **file)
 {
@@ -93,7 +93,8 @@ gp_file_new (CameraFile **file)
 	return (GP_OK);
 }
 
-/**
+
+/*! \brief descruct a #CameraFile object.
  * @param file a #CameraFile
  * @return a gphoto2 error code.
  *
@@ -109,11 +110,12 @@ int gp_file_free (CameraFile *file)
 	return (GP_OK);
 }
 
-/**
- * @param file a #CameraFile
- * @return a gphoto2 error code.
+
+/*! \brief Increase reference counter for #CameraFile object
  *
- **/
+ * \param file a #CameraFile
+ * \return a gphoto2 error code.
+ */
 int
 gp_file_ref (CameraFile *file)
 {
@@ -124,9 +126,11 @@ gp_file_ref (CameraFile *file)
 	return (GP_OK);
 }
 
-/**
- * @param file a #CameraFile
- * @return a gphoto2 error code.
+
+/*! \brief Decrease reference counter for #CameraFile object
+ *
+ * \param file a #CameraFile
+ * \return a gphoto2 error code.
  *
  **/
 int
@@ -142,6 +146,7 @@ gp_file_unref (CameraFile *file)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param data
@@ -150,7 +155,8 @@ gp_file_unref (CameraFile *file)
  *
  **/
 int
-gp_file_append (CameraFile *file, const char *data, unsigned long int size)
+gp_file_append (CameraFile *file, const char *data, 
+		unsigned long int size)
 {
         char *t;
 
@@ -172,6 +178,7 @@ gp_file_append (CameraFile *file, const char *data, unsigned long int size)
         return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param data
@@ -194,6 +201,7 @@ gp_file_set_data_and_size (CameraFile *file, char *data,
 	return (GP_OK);
 }
 
+
 /**
  * Get a pointer to the data and the file's size.
  *
@@ -219,6 +227,7 @@ gp_file_get_data_and_size (CameraFile *file, const char **data,
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param filename
@@ -255,6 +264,7 @@ gp_file_save (CameraFile *file, const char *filename)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param filename
@@ -356,6 +366,7 @@ gp_file_open (CameraFile *file, const char *filename)
         return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @return a gphoto2 error code.
@@ -400,6 +411,7 @@ gp_file_clean (CameraFile *file)
         return (GP_OK);
 }
 
+
 /**
  * @param destination a #CameraFile
  * @param source a #CameraFile
@@ -433,6 +445,7 @@ gp_file_copy (CameraFile *destination, CameraFile *source)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param name a pointer to a name string
@@ -449,6 +462,7 @@ gp_file_get_name (CameraFile *file, const char **name)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param mime_type a pointer to a MIME type string
@@ -465,6 +479,7 @@ gp_file_get_mime_type (CameraFile *file, const char **mime_type)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param name a pointer to a MIME type string
@@ -481,6 +496,7 @@ gp_file_set_name (CameraFile *file, const char *name)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param mime_type a MIME type string
@@ -497,6 +513,7 @@ gp_file_set_mime_type (CameraFile *file, const char *mime_type)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @return a gphoto2 error code.
@@ -525,6 +542,7 @@ gp_file_detect_mime_type (CameraFile *file)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @return a gphoto2 error code.
@@ -572,6 +590,7 @@ gp_file_adjust_name_for_mime_type (CameraFile *file)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param type a #CameraFileType
@@ -588,6 +607,7 @@ gp_file_set_type (CameraFile *file, CameraFileType type)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param type a #CameraFileType
@@ -604,6 +624,7 @@ gp_file_get_type (CameraFile *file, CameraFileType *type)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param red_table
@@ -643,6 +664,7 @@ gp_file_set_color_table (CameraFile *file,
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param width
@@ -661,6 +683,7 @@ gp_file_set_width_and_height (CameraFile *file, int width, int height)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param header
@@ -677,6 +700,7 @@ gp_file_set_header (CameraFile *file, const char *header)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param method a #CameraFileConversionMethod
@@ -694,6 +718,7 @@ gp_file_set_conversion_method (CameraFile *file,
 	return (GP_OK);
 }
 
+
 /* Chuck Homic's Bayer conversion routine, originally for the Dimera 3500 */
 /**
  * @internal
@@ -774,6 +799,7 @@ gp_file_conversion_chuck (CameraFile *file, unsigned char *data)
 	return (GP_OK);
 }
 
+
 /**
  * @internal
  **/
@@ -811,6 +837,7 @@ gp_file_raw_to_ppm (CameraFile *file)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param mime_type a MIME type string
@@ -830,6 +857,7 @@ gp_file_convert (CameraFile *file, const char *mime_type)
 		return (GP_ERROR_NOT_SUPPORTED);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param mtime
@@ -846,6 +874,7 @@ gp_file_get_mtime (CameraFile *file, time_t *mtime)
 	return (GP_OK);
 }
 
+
 /**
  * @param file a #CameraFile
  * @param mtime