first batch of license fixes (boring)

[oweals/gnunet.git] / src / include / gnunet_speaker_lib.h

diff --git a/src/include/gnunet_speaker_lib.h b/src/include/gnunet_speaker_lib.h
index 567b984e09acf57989b6efa1069a4a645ce28d62..4ec2483934f32ccad78ab8a588b824fdf14cae83 100644 (file)
--- a/src/include/gnunet_speaker_lib.h
+++ b/src/include/gnunet_speaker_lib.h
@@ -1,29 +1,29 @@
 /*
   This file is part of GNUnet
-  (C) 2013 Christian Grothoff (and other contributing authors)
-  
-  GNUnet is free software; you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published
-  by the Free Software Foundation; either version 3, or (at your
-  option) any later version.
-  
+  Copyright (C) 2013 GNUnet e.V.
+
+  GNUnet is free software: you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published
+  by the Free Software Foundation, either version 3 of the License,
+  or (at your option) any later version.
+
   GNUnet 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
-  General Public License for more details.
-  
-  You should have received a copy of the GNU General Public License
-  along with GNUnet; see the file COPYING.  If not, write to the
-  Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-  Boston, MA 02111-1307, USA.
+  Affero General Public License for more details.
  */
 
 /**
- * @file include/gnunet_speaker_lib.h
- * @brief API to access an audio speaker; provides access to hardware speakers
  * @author Simon Dieterle
  * @author Andreas Fuchs
  * @author Christian Grothoff
+ *
+ * @file
+ * API to access an audio speaker; provides access to hardware speakers
+ *
+ * @defgroup speaker  Speaker service
+ * Access hardware audio speakers.
+ * @{
  */
 #ifndef GNUNET_SPEAKER_SERVICE_H
 #define GNUNET_SPEAKER_SERVICE_H
@@ -36,31 +36,34 @@ extern "C"
 #endif
 #endif
 
+#include "gnunet_util_lib.h"
+
 /**
  * Function that enables a speaker.
  *
- * @param cls clsoure
+ * @param cls closure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
-typedef void (*GNUNET_SPEAKER_EnableCallback)(void *cls);
+typedef int (*GNUNET_SPEAKER_EnableCallback)(void *cls);
 
 /**
  * Function that disables a speaker.
  *
- * @param cls clsoure
+ * @param cls closure
  */
 typedef void (*GNUNET_SPEAKER_DisableCallback)(void *cls);
 
 /**
  * Function to destroy a speaker.
  *
- * @param cls clsoure
+ * @param cls closure
  */
 typedef void (*GNUNET_SPEAKER_DestroyCallback)(void *cls);
 
 /**
  * Function to cause a speaker to play audio data.
  *
- * @param cls clsoure
+ * @param cls closure
  * @param data_size number of bytes in @a data
  * @param data audio data to play, format is
  *        opaque to the API but should be OPUS.
@@ -132,4 +135,7 @@ GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker);
 #endif
 
 #endif
+
+/** @} */ /* end of group */
+
 /* end of gnunet_speaker_lib.h */