Fwd: Re: KDE API

Benjamin Meyer ben at meyerhome.net
Thu Jul 3 12:10:37 BST 2003


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi there, can someone with enough karma to modify kde-common/admin make a 
change to the Doxyfile.global file.  I have inquired to Gordon and gotten his 
permission.  Thanks

- -Benjamin Meyer

@@ -85,7 +85,7 @@ HIDE_UNDOC_CLASSES     = YES
 # the file and class documentation (similar to JavaDoc).
 # Set to NO to disable this.

- -BRIEF_MEMBER_DESC      = YES
+BRIEF_MEMBER_DESC      = NO

 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
 # the brief description of a member or function before the detailed 
description.


Original e-mail from Gordon
Hi Benjamin,

Am Dienstag, 1. Juli 2003 17:17 schrieben Sie:
> 1) I  recently changed:
>
> - BRIEF_MEMBER_DESC      = YES
> +BRIEF_MEMBER_DESC      = NO
>
> in the doxygen.global file on my local machine.  Many of the docs have
> quite a number of entries and with the mini comments directly below the
> function it makes it very hard to quickly scan for the function that one is
> looking for. Also this matches with what kdoc currently generates.  Also
> YES was the default value that it came with (i.e. someone else didn't turn
> it on... that I know).

Yes, this change makes sense IMO. I'm using the same layout in the API 
documentation of my little project, which you can find at 
http://ksetiwatch.sf.net/docs/ksetiwatch-api/index.php .
[snip]
Regards, Gordon
- -- 
Public Key: http://www.csh.rit.edu/~benjamin/public_key.asc
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: For info see http://www.gnupg.org

iD8DBQE/BA8t1rZ3LTw38vIRAj4dAKC2osSxGLpt8Ftp6iKNDMZX08hmJACeIvkZ
OgYTbr8PMJLjCJ3HnEZwf5c=
=/Bdn
-----END PGP SIGNATURE-----





More information about the kde-core-devel mailing list