doxygen

diff --git a/Doxyfile b/Doxyfile
index 9c6da8ae19ec79f623deb11674f2b696d0eaa093..3c5bb5b560f11f77ba09fef3a107fbf28c2a6f6c 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -301,7 +301,7 @@ CASE_SENSE_NAMES       = YES
 # will show members with their full class and namespace scopes in the 
 # documentation. If set to YES the scope will be hidden.
 
 # will show members with their full class and namespace scopes in the 
 # documentation. If set to YES the scope will be hidden.
 

-HIDE_SCOPE_NAMES       = NO
+HIDE_SCOPE_NAMES       = YES

 
 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
 # will put a list of the files that are included by a file in the documentation 
 
 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
 # will put a list of the files that are included by a file in the documentation 


@@ -573,13 +573,13 @@ STRIP_CODE_COMMENTS    = NO
 # then for each documented function all documented 
 # functions referencing it will be listed.
 
 # then for each documented function all documented 
 # functions referencing it will be listed.
 

-REFERENCED_BY_RELATION = YES
+REFERENCED_BY_RELATION = NO

 
 # If the REFERENCES_RELATION tag is set to YES (the default) 
 # then for each documented function all documented entities 
 # called/used by that function will be listed.
 
 
 # If the REFERENCES_RELATION tag is set to YES (the default) 
 # then for each documented function all documented entities 
 # called/used by that function will be listed.
 

-REFERENCES_RELATION    = YES
+REFERENCES_RELATION    = NO

 
 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
 
 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

diff --git a/lib/speaker-protocol.c b/lib/speaker-protocol.c
index a362b9030b4b73e361d21e8bf87378ebf0474422..1c5199aa9ec9c736d3ef7dd50fc785078cbbf06b 100644 (file)
--- a/lib/speaker-protocol.c
+++ b/lib/speaker-protocol.c
@@ -32,10 +32,12 @@
 #include "speaker-protocol.h"
 #include "log.h"
 
 #include "speaker-protocol.h"
 #include "log.h"
 

-/** @brief Send a speaker messages
+/** @brief Send a speaker message

  * @param fd File descriptor to send to
  * @param sm Pointer to message
  * @param fd File descriptor to send to
  * @param sm Pointer to message

- * @param datafd File descriptor to pass with message or -1
+ * @param datafd File descriptoxr to pass with message or -1
+ *
+ * @p datafd will be the output from some decoder.

  */
 void speaker_send(int fd, const struct speaker_message *sm, int datafd) {
   struct msghdr m;
  */
 void speaker_send(int fd, const struct speaker_message *sm, int datafd) {
   struct msghdr m;

diff --git a/lib/speaker-protocol.h b/lib/speaker-protocol.h
index 2002d0bf17b3b422f2400a190f2fc08c623dce0a..b7f27e797110d3d18f55999d282aa8d3cf184044 100644 (file)
--- a/lib/speaker-protocol.h
+++ b/lib/speaker-protocol.h
@@ -17,7 +17,7 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */

-/** @file lib/speaker-protocol.c
+/** @file lib/speaker-protocol.h

  * @brief Speaker/server protocol support
  *
  * This file defines the protocol by which the main server and the speaker
  * @brief Speaker/server protocol support
  *
  * This file defines the protocol by which the main server and the speaker