[Gtk-gnutella-devel] Re: [PATCH] More Doxygen

Daichi Kawahata Mon, 04 Apr 2005 13:23:18 -0700

Hi,

I've modified gtkg-apidoc.main (front page), files in core directory
to be grouped (I hope I never use version dependent tag anyway), for
instance in src/core/alive.c at 26-30, I've modified it from


    /**
     * @file
     *
     * Alive status checking ping/pongs.
     */

to

    /**
     * @file
     * @ingroup core
     * @brief Alive status checking ping/pongs.
     */

it's added ingroup and brief tag, I'd think latter tag is redundant,
causes hard to read for those who are reading source code directory,
but without this tag, generated html lacks brief summary of file ...

Also, in src/core/hashtree.c I've used more detailed tag (you can
see what I did at attached hashtree_8c.html), actually these copy-
right holder/year, your embedded revision tag and initial comment/
summary can be managed in doxygen formatted comment box.

At the same time, I'd like to respect author's style of course, so
could you tell me more suitable commenting style if it exists anything
else? I'm willing to rewrite or discard ...

Regards,
-- 
Daichi

Index: .cvsignore
===================================================================
RCS file: /cvsroot/gtk-gnutella/gtk-gnutella-current/doc/api/.cvsignore,v
retrieving revision 1.1
diff -u -r1.1 .cvsignore
--- .cvsignore	22 Feb 2005 13:41:03 -0000	1.1
+++ .cvsignore	4 Apr 2005 19:41:22 -0000
@@ -1,2 +1,5 @@
 gtkg-apidoc.warn
 html
+latex
+man
+rtf
Index: gtkg-apidoc.cfg
===================================================================
RCS file: /cvsroot/gtk-gnutella/gtk-gnutella-current/doc/api/gtkg-apidoc.cfg,v
retrieving revision 1.4
diff -u -r1.4 gtkg-apidoc.cfg
--- gtkg-apidoc.cfg	8 Jan 2005 02:05:13 -0000	1.4
+++ gtkg-apidoc.cfg	4 Apr 2005 19:41:22 -0000
@@ -170,7 +170,7 @@
 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE               = 8
+TAB_SIZE               = 4
 
 # This tag can be used to specify a number of aliases that acts 
 # as commands in the documentation. An alias has the form "name=value". 
Index: gtkg-apidoc.main
===================================================================
RCS file: /cvsroot/gtk-gnutella/gtk-gnutella-current/doc/api/gtkg-apidoc.main,v
retrieving revision 1.1
diff -u -r1.1 gtkg-apidoc.main
--- gtkg-apidoc.main	8 Jan 2005 01:17:16 -0000	1.1
+++ gtkg-apidoc.main	4 Apr 2005 19:41:22 -0000
@@ -37,16 +37,36 @@
  *  The following sections are the broad categories into which the
  *  various modules belong.
  *
- *  - @ref core
- *  - @ref lib
- *  - @ref gui
+ * @section Core
+ *	- @ref core
+ *
+ * @section Libraries
+ *	- @ref lib
+ *
+ * @section Interface
+ *	- @ref gtk
  *
  * @section Miscellaneous
- *  - @ref undoc
+ *	- @ref undoc
+ */
+
+/**
+ * @defgroup core Core Module
+ */
+
+/**
+ * @defgroup lib Common Libraries
  */
 
-/** @defgroup core Core Module */
-/** @defgroup lib Common Library */
-/** @defgroup gui User Interface */
+/**
+ * @defgroup ui User Interface
+ */
 
-/** @defgroup undoc Undocumented */
+/**
+ * @defgroup gtk GTK+
+ * @ingroup ui
+ */
+
+/**
+ * @defgroup undoc Undocumented
+ */

doxygen_core.patch.gz
Description: GNU Zip compressed data

Title: Gtk-Gnutella: Gtk-Gnutella

Gtk-Gnutella

0.96u

Introduction

Gtk-Gnutella is a GUI based Gnutella servent, which features:

Share files on the gnutella network (LimeWire, BearShare, Xolox, Gnucleus, Shareaza, Morpheus ...)
Compressed Gnet connections
Simultaneous downloading of files from multiple hosts (swarming)
Passive searches
Searching by urn:sha1: and magnet:
Automatic aquisition of additional sources via download mesh and watching searches
Powerful filtering engine
Bandwidth management/limiting
A lot of settings
A lot of statistics
Compliant to:
- HTTP/1.1
- Gnutella 0.6 (Vendor Code GTKG and soon GNTD)
- Gnet compression
- BYE packet
- GWebCache Proposal
- HUGE (Hash/URN Gnutella Extensions)
- Ping/Pong reduction
- PARQ (Passive/Active Remote Queueing)
- PFSP (Partial File Sharing Protocol)
- Vendor Messages
- Ultrapeers
- QRP (Query Routing Proposal)
- Push Proxies