diff options
28 files changed, 285 insertions, 266 deletions
diff --git a/libgphoto2/bayer.c b/libgphoto2/bayer.c index 1fea1e2da..8a6b5a8f6 100644 --- a/libgphoto2/bayer.c +++ b/libgphoto2/bayer.c @@ -1,6 +1,6 @@ /* bayer.c * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * Copyright 2001 Lutz Müller <lutz@users.sf.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/bayer.h b/libgphoto2/bayer.h index 92eb26253..e62100f26 100644 --- a/libgphoto2/bayer.h +++ b/libgphoto2/bayer.h @@ -1,17 +1,20 @@ -/* bayer.h +/** \file * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * \author Copyright 2001 Lutz Müller <lutz@users.sf.net> * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gamma.c b/libgphoto2/gamma.c index eddb76924..a84973637 100644 --- a/libgphoto2/gamma.c +++ b/libgphoto2/gamma.c @@ -1,6 +1,6 @@ /* gamma.c * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * Copyright 2001 Lutz Müller <lutz@users.sf.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gamma.h b/libgphoto2/gamma.h index dec793e19..8b4e139fc 100644 --- a/libgphoto2/gamma.h +++ b/libgphoto2/gamma.h @@ -1,17 +1,20 @@ -/* gamma.h +/** \file * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * \author Copyright 2001 Lutz Müller <lutz@users.sf.net> * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-abilities-list.c b/libgphoto2/gphoto2-abilities-list.c index d8f9f1b8a..8892b67fa 100644 --- a/libgphoto2/gphoto2-abilities-list.c +++ b/libgphoto2/gphoto2-abilities-list.c @@ -1,7 +1,7 @@ /** \file gphoto2-abilities-list.c * \brief List of supported camera models including their abilities. * - * \author Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * * \par * This library is free software; you can redistribute it and/or diff --git a/libgphoto2/gphoto2-abilities-list.h b/libgphoto2/gphoto2-abilities-list.h index a563ab6b1..d67294a5f 100644 --- a/libgphoto2/gphoto2-abilities-list.h +++ b/libgphoto2/gphoto2-abilities-list.h @@ -1,7 +1,7 @@ /** \file gphoto2-abilities-list.h * \brief List of supported camera models including their abilities. * - * \author Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * * \par * This library is free software; you can redistribute it and/or diff --git a/libgphoto2/gphoto2-camera.c b/libgphoto2/gphoto2-camera.c index fe9d32b2b..8fa3f09ed 100644 --- a/libgphoto2/gphoto2-camera.c +++ b/libgphoto2/gphoto2-camera.c @@ -2,8 +2,8 @@ * * Implement Camera object representing a camera attached to the system. * - * \author Copyright © 2000 Scott Fritzinger - * \author 2001-2002: Lutz Müller <lutz@users.sf.net> + * \author Copyright 2000 Scott Fritzinger + * \author Copyright 2001-2002 Lutz Müller <lutz@users.sf.net> * * \note * This library is free software; you can redistribute it and/or diff --git a/libgphoto2/gphoto2-camera.h b/libgphoto2/gphoto2-camera.h index 73a1c9107..6c6ae69db 100644 --- a/libgphoto2/gphoto2-camera.h +++ b/libgphoto2/gphoto2-camera.h @@ -1,18 +1,22 @@ -/** \file gphoto2-camera.h - * \brief Implement Camera object representing a camera attached to the system. +/** \file * - * Copyright © 2000 Scott Fritzinger + * Implement Camera object representing a camera attached to the system. * + * \author Copyright 2000 Scott Fritzinger + * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-context.c b/libgphoto2/gphoto2-context.c index b0daee76f..1efa787cd 100644 --- a/libgphoto2/gphoto2-context.c +++ b/libgphoto2/gphoto2-context.c @@ -1,6 +1,6 @@ /* gphoto2-context.c * - * Copyright © 2001 Lutz Müller <lutz@users.sourceforge.net> + * Copyright 2001 Lutz Müller <lutz@users.sourceforge.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gphoto2-context.h b/libgphoto2/gphoto2-context.h index c4ba2c5fa..07f7c7acd 100644 --- a/libgphoto2/gphoto2-context.h +++ b/libgphoto2/gphoto2-context.h @@ -1,17 +1,20 @@ -/* gphoto2-context.h +/** \file * - * Copyright © 2001 Lutz Müller <lutz@users.sourceforge.net> + * \author Copyright 2001 Lutz Müller <lutz@users.sourceforge.net> * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-file.c b/libgphoto2/gphoto2-file.c index 2c4d7d941..58e40e69d 100644 --- a/libgphoto2/gphoto2-file.c +++ b/libgphoto2/gphoto2-file.c @@ -1,6 +1,6 @@ /** \file * - * \author Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * * \note * This library is free software; you can redistribute it and/or diff --git a/libgphoto2/gphoto2-file.h b/libgphoto2/gphoto2-file.h index 77a22d36b..e17d02b78 100644 --- a/libgphoto2/gphoto2-file.h +++ b/libgphoto2/gphoto2-file.h @@ -1,6 +1,6 @@ /** \file * - * \author Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * * \note * This library is free software; you can redistribute it and/or diff --git a/libgphoto2/gphoto2-filesys.c b/libgphoto2/gphoto2-filesys.c index ff81781af..4b5856635 100644 --- a/libgphoto2/gphoto2-filesys.c +++ b/libgphoto2/gphoto2-filesys.c @@ -1,6 +1,6 @@ /* gphoto2-filesys.c * - * Copyright © 2000 Scott Fritzinger + * Copyright 2000 Scott Fritzinger * * Contributions: * Lutz Müller <lutz@users.sf.net> (2001) diff --git a/libgphoto2/gphoto2-filesys.h b/libgphoto2/gphoto2-filesys.h index 817c4c13e..ac1c60bc7 100644 --- a/libgphoto2/gphoto2-filesys.h +++ b/libgphoto2/gphoto2-filesys.h @@ -1,20 +1,24 @@ -/* gphoto2-filesys.h +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * Contributions: * Lutz Müller <lutz@users.sf.net> (2001) * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-library.c b/libgphoto2/gphoto2-library.c index 836db6250..3bb8c7542 100644 --- a/libgphoto2/gphoto2-library.c +++ b/libgphoto2/gphoto2-library.c @@ -1,6 +1,6 @@ /* gphoto2-library.c: Dummy file for gtk-doc * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * Copyright 2001 Lutz Müller <lutz@users.sf.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gphoto2-library.h b/libgphoto2/gphoto2-library.h index ab89329cc..d033bf8bb 100644 --- a/libgphoto2/gphoto2-library.h +++ b/libgphoto2/gphoto2-library.h @@ -1,17 +1,20 @@ -/* gphoto2-library.h: +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, @@ -30,35 +33,34 @@ extern "C" { #endif /* __cplusplus */ /** - * CameraLibraryIdFunc: - * @id: a #CameraText - * * Returns a unique @id for the camera driver. * - * Return value: a gphoto2 error code + * @param id a #CameraText + * @return a gphoto2 error code + * **/ typedef int (* CameraLibraryIdFunc) (CameraText *id); /** - * CameraLibraryAbilitiesFunc: - * @list: a #CameraAbilitiesList - * * Adds the abilities of the supported models to the supplied @list. * - * Return value: a gphoto2 error code + * @param list a #CameraAbilitiesList + * @return a gphoto2 error code + * **/ typedef int (* CameraLibraryAbilitiesFunc) (CameraAbilitiesList *list); /** - * CameraLibraryInitFunc: - * @camera: a #Camera - * @context: a #GPContext + * Initializes the camera. + * + * @param camera a #Camera + * @param context a #GPContext + * @return a gphoto2 error code * - * Initializes the camera. The camera driver will establish a first connection + * The camera driver will establish a first connection * to the camera and configure the @camera variable (i.e. using * #gp_filesystem_set_list_funcs or #gp_port_get_settings). * - * Return value: a gphoto2 error code **/ typedef int (* CameraLibraryInitFunc) (Camera *camera, GPContext *context); diff --git a/libgphoto2/gphoto2-list.c b/libgphoto2/gphoto2-list.c index 995c1a407..0b72dec40 100644 --- a/libgphoto2/gphoto2-list.c +++ b/libgphoto2/gphoto2-list.c @@ -1,17 +1,20 @@ -/* list.c +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, @@ -33,12 +36,11 @@ /** - * gp_list_new: - * @list: - * * Creates a new #CameraList. * - * Return value: a gphoto2 error code + * @param list + * @return a gphoto2 error code + * **/ int gp_list_new (CameraList **list) @@ -56,12 +58,11 @@ gp_list_new (CameraList **list) } /** - * gp_list_ref: - * @list: a #CameraList - * * Increments the reference count of the @list. * - * Return value: a gphoto2 error code. + * @param list a #CameraList + * @return a gphoto2 error code. + * **/ int gp_list_ref (CameraList *list) @@ -74,13 +75,13 @@ gp_list_ref (CameraList *list) } /** - * gp_list_unref: - * @list: a #CameraList + * Decrements the reference count of the \c list. + * + * @param list a #CameraList + * @return a gphoto2 error code * - * Decrements the reference count of the @list. If there are no references - * left, the @list will be freed. + * If there are no references left, the \c list will be freed. * - * Return value: a gphoto2 error code **/ int gp_list_unref (CameraList *list) @@ -96,12 +97,11 @@ gp_list_unref (CameraList *list) } /** - * gp_list_free: - * @list: the #CameraList to be freed + * Frees the \c list. It is recommended to use #gp_list_unref instead. * - * Frees the @list. It is recommended to use #gp_list_unref instead. + * @param list the #CameraList to be freed + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_free (CameraList *list) @@ -114,12 +114,11 @@ gp_list_free (CameraList *list) } /** - * gp_list_reset: - * @list: a #CameraList + * Resets the \c list and removes all entries. * - * Resets the @list and removes all entries. + * @param list a #CameraList + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_reset (CameraList *list) @@ -132,14 +131,13 @@ gp_list_reset (CameraList *list) } /** - * gp_list_append: - * @list: a #CameraList - * @name: the name of the entry to append - * @value: the value of the entry to append + * Appends \c name and \c value to the \c list. * - * Appends @name and @value to the @list. + * @param list a #CameraList + * @param name the name of the entry to append + * @param value the value of the entry to append + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_append (CameraList *list, const char *name, const char *value) @@ -185,6 +183,9 @@ gp_list_append (CameraList *list, const char *name, const char *value) return (GP_OK); } +/** + * @internal + */ static void exchange (CameraList *list, int x, int y) { @@ -203,12 +204,11 @@ exchange (CameraList *list, int x, int y) } /** - * gp_list_sort: - * @list: a #CameraList + * Sorts the \c list entries with respect to the names. * - * Sorts the @list entries with respect to the names. + * @param list a #CameraList + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_sort (CameraList *list) @@ -228,12 +228,11 @@ gp_list_sort (CameraList *list) } /** - * gp_list_count: - * @list: a #CameraList - * - * Counts the entries in the @list. + * Counts the entries in the \c list. * - * Return value: a gphoto2 error code + * @param list a #CameraList + * @return a gphoto2 error code + * **/ int gp_list_count (CameraList *list) @@ -244,14 +243,13 @@ gp_list_count (CameraList *list) } /** - * gp_list_get_name: - * @list: a #CameraList - * @index: index of the entry - * @name: + * Retrieves the \c name of entry with \c index. * - * Retrieves the @name of entry with @index. + * @param list a #CameraList + * @param index index of the entry + * @param name + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_list_get_name (CameraList *list, int index, const char **name) @@ -267,14 +265,13 @@ gp_list_get_name (CameraList *list, int index, const char **name) } /** - * gp_list_get_value: - * @list: a #CameraList - * @index: index of the entry - * @value: + * Retrieves the value of entry with \c index. * - * Retrieves the value of entry with @index. + * @param list a #CameraList + * @param index index of the entry + * @param value + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_get_value (CameraList *list, int index, const char **value) @@ -290,14 +287,13 @@ gp_list_get_value (CameraList *list, int index, const char **value) } /** - * gp_list_set_value: - * @list: a #CameraList - * @index: index of the entry - * @value: the value to be set + * Sets the \c value of an entry. * - * Sets the @value of an entry. + * @param list a #CameraList + * @param index index of the entry + * @param value the value to be set + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_list_set_value (CameraList *list, int index, const char *value) @@ -327,14 +323,13 @@ gp_list_set_value (CameraList *list, int index, const char *value) } /** - * gp_list_set_name: - * @list: a #CameraList - * @index: index of entry - * @name: name to be set - * * Sets the name of an entry. * - * Return value: a gphoto2 error code + * @param list a #CameraList + * @param index index of entry + * @param name name to be set + * @return a gphoto2 error code + * **/ int gp_list_set_name (CameraList *list, int index, const char *name) @@ -364,18 +359,18 @@ gp_list_set_name (CameraList *list, int index, const char *name) } /** - * gp_list_populate: - * @list: a #CameraList - * @format: the format - * @count: number of entries to be added to the @list + * Adds \c count entries to the list. + * + * @param list a #CameraList + * @param format the format + * @param count number of entries to be added to the @list + * @return a gphoto2 error code * - * Adds @count entries to the list. Typically, this function is called by - * a camera driver when there is no way of retrieving the real name of a - * picture. In this case, when asked for a file list - * (see #CameraFilesystemListFunc), the list is populated with dummy + * Typically, this function is called by a camera driver when there is no way + * of retrieving the real name of a picture. In this case, when asked for a + * file list (see #CameraFilesystemListFunc), the list is populated with dummy * names generated by this function. * - * Return value: a gphoto2 error code **/ int gp_list_populate (CameraList *list, const char *format, int count) diff --git a/libgphoto2/gphoto2-list.h b/libgphoto2/gphoto2-list.h index 739d81da1..ae9fb7367 100644 --- a/libgphoto2/gphoto2-list.h +++ b/libgphoto2/gphoto2-list.h @@ -1,17 +1,22 @@ -/* gphoto2-list.h: Lists of files, folders, cameras, etc. +/** \file * - * Copyright © 2001 Scott Fritzinger + * Lists of files, folders, cameras, etc. * + * \author Copyright 2001 Scott Fritzinger + * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-result.c b/libgphoto2/gphoto2-result.c index d9bb88b4e..812bf4896 100644 --- a/libgphoto2/gphoto2-result.c +++ b/libgphoto2/gphoto2-result.c @@ -1,6 +1,6 @@ /* gphoto2-result.c * - * Copyright © 2000 Scott Fritzinger + * Copyright 2000 Scott Fritzinger * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gphoto2-result.h b/libgphoto2/gphoto2-result.h index 9bb7d11de..56781a7cc 100644 --- a/libgphoto2/gphoto2-result.h +++ b/libgphoto2/gphoto2-result.h @@ -1,17 +1,20 @@ -/* gphoto2-result.h +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-setting.c b/libgphoto2/gphoto2-setting.c index 7593ddbcc..b028a3f68 100644 --- a/libgphoto2/gphoto2-setting.c +++ b/libgphoto2/gphoto2-setting.c @@ -1,6 +1,6 @@ /* gphoto2-setting.c * - * Copyright © 2000 Scott Fritzinger + * Copyright 2000 Scott Fritzinger * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gphoto2-setting.h b/libgphoto2/gphoto2-setting.h index 8afa9f843..cbf27f8c0 100644 --- a/libgphoto2/gphoto2-setting.h +++ b/libgphoto2/gphoto2-setting.h @@ -1,17 +1,20 @@ -/* gphoto2-setting.h +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-version.c b/libgphoto2/gphoto2-version.c index 357154150..8051a201b 100644 --- a/libgphoto2/gphoto2-version.c +++ b/libgphoto2/gphoto2-version.c @@ -1,6 +1,6 @@ /* gphoto2-version.c * - * Copyright © 2002 Hans Ulrich Niedermann <gp@n-dimensional.de + * Copyright 2002 Hans Ulrich Niedermann <gp@n-dimensional.de * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/libgphoto2/gphoto2-version.h b/libgphoto2/gphoto2-version.h index b6f36617c..c7a68ec21 100644 --- a/libgphoto2/gphoto2-version.h +++ b/libgphoto2/gphoto2-version.h @@ -1,17 +1,20 @@ -/* gphoto2-version.h +/** \file * - * Copyright © 2002 Hans Ulrich Niedermann <gp@n-dimensional.de> + * \author Copyright 2002 Hans Ulrich Niedermann <gp@n-dimensional.de> * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2-widget.c b/libgphoto2/gphoto2-widget.c index 3a6bc0562..f03474eea 100644 --- a/libgphoto2/gphoto2-widget.c +++ b/libgphoto2/gphoto2-widget.c @@ -1,17 +1,20 @@ -/* gphoto2-widget.c +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, @@ -74,15 +77,14 @@ struct _CameraWidget { }; /** - * gp_widget_new: - * @type: the type - * @label: the label - * @widget: - * * The function creates a new #CameraWidget of specified type and with * given label. * - * Return value: a gphoto2 error code. + * @param type the type + * @param label the label + * @param widget + * @return a gphoto2 error code. + * **/ int gp_widget_new (CameraWidgetType type, const char *label, @@ -120,12 +122,11 @@ gp_widget_new (CameraWidgetType type, const char *label, } /** - * gp_widget_free: - * @widget: the #CameraWidget to be freed - * - * Frees a #CameraWidget. + * Frees a #CameraWidget * - * Return value: a gphoto2 error code. + * @param widget the #CameraWidget to be freed + * @return a gphoto2 error code. + * **/ int gp_widget_free (CameraWidget *widget) @@ -149,12 +150,11 @@ gp_widget_free (CameraWidget *widget) } /** - * gp_widget_ref: - * @widget: a #CameraWidget you want to ref-count + * Increments the reference count for the #CameraWidget * - * Increments the reference count for the CameraWidget. + * @param widget a #CameraWidget you want to ref-count + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_ref (CameraWidget *widget) @@ -167,12 +167,11 @@ gp_widget_ref (CameraWidget *widget) } /** - * gp_widget_unref: - * @widget: a #CameraWidget you want to unref + * Decrements the reference count for the #CameraWidget * - * Decrements the reference count for the CameraWidget: + * @param widget a #CameraWidget you want to unref + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_unref (CameraWidget *widget) @@ -188,13 +187,12 @@ gp_widget_unref (CameraWidget *widget) } /** - * gp_widget_get_info: - * @widget: a #CameraWidget - * @info: + * Retrieves the information about the widget * - * Retrieves the information about the widget. + * @param widget a #CameraWidget + * @param info + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_info (CameraWidget *widget, const char **info) @@ -207,13 +205,12 @@ gp_widget_get_info (CameraWidget *widget, const char **info) /** - * gp_widget_set_info: - * @widget: a #CameraWidget - * @info: Information about above widget + * Sets the information about the widget * - * Sets the information about the widget. + * @param widget a #CameraWidget + * @param info Information about above widget + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_set_info (CameraWidget *widget, const char *info) @@ -225,13 +222,12 @@ gp_widget_set_info (CameraWidget *widget, const char *info) } /** - * gp_widget_get_name: - * @widget: a #CameraWidget - * @name: Name of above widget + * Gets the name of the widget * - * Gets the name of the widget. + * @param widget a #CameraWidget + * @param name Name of above widget + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_name (CameraWidget *widget, const char **name) @@ -243,13 +239,12 @@ gp_widget_get_name (CameraWidget *widget, const char **name) } /** - * gp_widget_set_name: - * @widget: a #CameraWidget - * @name: Name of above widget + * Sets the name of the widget * - * Sets the name of the widget. + * @param widget a #CameraWidget + * @param name Name of above widget + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_set_name (CameraWidget *widget, const char *name) @@ -263,13 +258,12 @@ gp_widget_set_name (CameraWidget *widget, const char *name) /** - * gp_widget_get_id: - * @widget: a #CameraWidget - * @id: + * Retrieves the unique id of the #CameraWidget * - * Retrieves the unique id of the CameraWidget. + * @param widget a #CameraWidget + * @param id + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_id (CameraWidget *widget, int *id) @@ -290,13 +284,12 @@ gp_widget_set_changed (CameraWidget *widget, int changed) } /** - * gp_widget_get_type: - * @widget: a #CameraWidget - * @type: + * Retrieves the type of the #CameraWidget * - * Retrieves the type of the CameraWidget. + * @param widget a #CameraWidget + * @param type + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_type (CameraWidget *widget, CameraWidgetType *type) @@ -308,13 +301,12 @@ gp_widget_get_type (CameraWidget *widget, CameraWidgetType *type) } /** - * gp_widget_get_label: - * @widget: a #CameraWidget - * @label: + * Retrieves the label of the #CameraWidget * - * Retrieves the label of the CameraWidget. + * @param widget a #CameraWidget + * @param label + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_label (CameraWidget *widget, const char **label) @@ -326,17 +318,18 @@ gp_widget_get_label (CameraWidget *widget, const char **label) } /** - * gp_widget_set_value: - * @widget: a #CameraWidget - * @value: + * Sets the value of the widget * - * Sets the value of the widget. Please pass + * @param widget a #CameraWidget + * @param value + * @return a gphoto2 error code. + * + * Please pass * (char*) for GP_WIDGET_MENU, GP_WIDGET_TEXT, * (float) for GP_WIDGET_RANGE, * (int) for GP_WIDGET_DATE, GP_WIDGET_TOGGLE, GP_WIDGET_RADIO, and * (CameraWidgetCallback) for GP_WIDGET_BUTTON. * - * Return value: a gphoto2 error code. **/ int gp_widget_set_value (CameraWidget *widget, const void *value) @@ -381,13 +374,12 @@ gp_widget_set_value (CameraWidget *widget, const void *value) } /** - * gp_widget_get_value: - * @widget: a #CameraWidget - * @value: + * Retrieves the value of the #CameraWidget * - * Retrieves the value of the CameraWidget. + * @param widget a #CameraWidget + * @param value + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_value (CameraWidget *widget, void *value) @@ -418,13 +410,12 @@ gp_widget_get_value (CameraWidget *widget, void *value) } /** - * gp_widget_append: - * @widget: a CameraWidget - * @child: the CameraWidget you would like to append to above + * Appends a #CameraWidget to a #CameraWidget * - * Appends a CameraWidget to a CameraWidget. + * @param widget a #CameraWidget + * @param child the #CameraWidget you would like to append to above + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_append (CameraWidget *widget, CameraWidget *child) @@ -445,13 +436,12 @@ gp_widget_append (CameraWidget *widget, CameraWidget *child) } /** - * gp_widget_prepend: - * @widget: a #CameraWidget - * @child: the CameraWidget you would like to prepend to above + * Prepends a #CameraWidget to a #CameraWidget * - * Prepends a CameraWidget to a CameraWidget. + * @param widget a #CameraWidget + * @param child the #CameraWidget you would like to prepend to above + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_prepend (CameraWidget *widget, CameraWidget *child) @@ -479,12 +469,11 @@ gp_widget_prepend (CameraWidget *widget, CameraWidget *child) } /** - * gp_widget_count_children: - * @widget: a #CameraWidget + * Counts the children of the #CameraWidget * - * Counts the children of the CameraWidget. + * @param widget a #CameraWidget + * @return a gphoto2 error code or number of children * - * Return value: a gphoto2 error code or number of children **/ int gp_widget_count_children (CameraWidget *widget) @@ -495,14 +484,13 @@ gp_widget_count_children (CameraWidget *widget) } /** - * gp_widget_get_child: - * @widget: a #CameraWidget - * @child_number: the number of the child - * @child: + * Retrieves the child number \c child_number of the parent * - * Retrieves the child number @child_number of the parent. + * @param widget a #CameraWidget + * @param child_number the number of the child + * @param child + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_child (CameraWidget *widget, int child_number, @@ -518,14 +506,13 @@ gp_widget_get_child (CameraWidget *widget, int child_number, } /** - * gp_widget_get_child_by_label: - * @widget: a #CameraWidget - * @label: the label of the child - * @child: + * Retrieves the child with label \c label of the #CameraWidget * - * Retrieves the child with label @label of the CameraWidget. + * @param widget a #CameraWidget + * @param label the label of the child + * @param child + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_child_by_label (CameraWidget *widget, const char *label, @@ -556,14 +543,13 @@ gp_widget_get_child_by_label (CameraWidget *widget, const char *label, } /** - * gp_widget_get_child_by_id: - * @widget: a #CameraWidget - * @id: the id of the child - * @child: + * Retrieves the child with id \c id of the widget * - * Retrieves the child with id @id of the widget. + * @param widget a #CameraWidget + * @param id the id of the child + * @param child + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_child_by_id (CameraWidget *widget, int id, CameraWidget **child) @@ -593,13 +579,12 @@ gp_widget_get_child_by_id (CameraWidget *widget, int id, CameraWidget **child) } /** - * gp_widget_get_child_by_name: - * @widget: a #CameraWidget - * @name: the name of the child + * Retrieves the child with name \c name of the widget * - * Retrieves the child with name @name of the widget. + * @param widget a #CameraWidget + * @param name the name of the child + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_child_by_name (CameraWidget *widget, const char *name, @@ -640,13 +625,12 @@ gp_widget_get_parent (CameraWidget *widget, CameraWidget **parent) } /** - * gp_widget_get_root: - * @widget: a #CameraWidget - * @root: + * Retrieves the root of the #CameraWidget * - * Retrieves the root of the CameraWidget. + * @param widget a #CameraWidget + * @param root + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_root (CameraWidget *widget, CameraWidget **root) @@ -662,15 +646,14 @@ gp_widget_get_root (CameraWidget *widget, CameraWidget **root) } /** - * gp_widget_set_range: - * @range: a CameraWidget of type GP_WIDGET_RANGE - * @min: - * @max: - * @increment: + * Sets some range parameters of the #CameraWidget * - * Sets some range parameters of the CameraWidget. + * @param range a #CameraWidget of type GP_WIDGET_RANGE + * @param min + * @param max + * @param increment + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_set_range (CameraWidget *range, float min, float max, float increment) @@ -688,15 +671,14 @@ gp_widget_set_range (CameraWidget *range, float min, float max, float increment) } /** - * gp_widget_get_range: - * @range: a #CameraWidget of type GP_WIDGET_RANGE - * @min: - * @max: - * @increment: + * Retrieves some range parameters of the #CameraWidget * - * Retrieves some range parameters of the CameraWidget. + * @param range a #CameraWidget of type GP_WIDGET_RANGE + * @param min + * @param max + * @param increment + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_get_range (CameraWidget *range, float *min, float *max, @@ -714,13 +696,12 @@ gp_widget_get_range (CameraWidget *range, float *min, float *max, } /** - * gp_widget_add_choice: - * @widget: a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU - * @choice: + * Adds a choice to the #CameraWidget * - * Adds a choice to the CameraWidget. + * @param widget a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU + * @param choice + * @return a gphoto2 error code. * - * Return value: a gphoto2 error code. **/ int gp_widget_add_choice (CameraWidget *widget, const char *choice) @@ -741,12 +722,11 @@ gp_widget_add_choice (CameraWidget *widget, const char *choice) } /** - * gp_widget_count_choices: - * @widget: a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU - * - * Counts the choices of the CameraWidget. + * Counts the choices of the #CameraWidget * - * Return value: a gphoto2 error code or number of choices. + * @param widget a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU + * @return a gphoto2 error code or number of choices. + * **/ int gp_widget_count_choices (CameraWidget *widget) @@ -760,14 +740,13 @@ gp_widget_count_choices (CameraWidget *widget) } /** - * gp_widget_get_choice: - * @widget: a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU - * @choice_number: - * @choice: + * Retrieves the choice number \c choice_number * - * Retrieves the choice number @choice_number. + * @param widget a #CameraWidget of type GP_WIDGET_RADIO or GP_WIDGET_MENU + * @param choice_number + * @param choice + * @return a gphoto2 error code * - * Return value: a gphoto2 error code **/ int gp_widget_get_choice (CameraWidget *widget, int choice_number, @@ -786,13 +765,14 @@ gp_widget_get_choice (CameraWidget *widget, int choice_number, } /** - * gp_widget_changed: - * @widget: a #CameraWidget + * Tells if the widget has been changed + * + * @param widget a #CameraWidget + * @return a gphoto2 error code or changed flag. * * Returns 1 if the state of the #CameraWidget has been changed or 0 if not. * In addition, it resets the changed flag to 0. * - * Return value: a gphoto2 error code or changed flag. **/ int gp_widget_changed (CameraWidget *widget) diff --git a/libgphoto2/gphoto2-widget.h b/libgphoto2/gphoto2-widget.h index cacab3f21..65570d0aa 100644 --- a/libgphoto2/gphoto2-widget.h +++ b/libgphoto2/gphoto2-widget.h @@ -1,17 +1,20 @@ -/* gphoto2-widget.h +/** \file * - * Copyright © 2000 Scott Fritzinger + * \author Copyright 2000 Scott Fritzinger * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/gphoto2.h b/libgphoto2/gphoto2.h index 613740e6d..fc881a656 100644 --- a/libgphoto2/gphoto2.h +++ b/libgphoto2/gphoto2.h @@ -1,17 +1,21 @@ -/* gphoto2.h: Convenience header for gphoto2 +/** \file + * Convenience header for gphoto2 * - * Copyright © 2001 Lutz Müller <lutz@users.sf.net> + * \author Copyright 2001 Lutz Müller <lutz@users.sf.net> * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, diff --git a/libgphoto2/jpeg.h b/libgphoto2/jpeg.h index b9c358ea7..b306b60cf 100644 --- a/libgphoto2/jpeg.h +++ b/libgphoto2/jpeg.h @@ -1,16 +1,20 @@ -/* jpeg.h - * This code was written by Nathan Stenzel for gphoto +/** \file + * + * \author This code was written by Nathan Stenzel for gphoto * + * \note * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * + * \note * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * + * \note * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |