chiark / gitweb /
doxygen
authorrjk@greenend.org.uk <>
Mon, 24 Sep 2007 11:31:03 +0000 (12:31 +0100)
committerrjk@greenend.org.uk <>
Mon, 24 Sep 2007 11:31:03 +0000 (12:31 +0100)
Doxyfile
lib/speaker-protocol.c
lib/speaker-protocol.h

index 9c6da8a..3c5bb5b 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.
 
-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 
@@ -573,13 +573,13 @@ STRIP_CODE_COMMENTS    = NO
 # 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.
 
-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
index a362b90..1c5199a 100644 (file)
 #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 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;
index 2002d0b..b7f27e7 100644 (file)
@@ -17,7 +17,7 @@
  * 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