From kde-devel  Sun Apr 30 20:28:08 2006
From: Michael Pyne <michael.pyne () kdemail ! net>
Date: Sun, 30 Apr 2006 20:28:08 +0000
To: kde-devel
Subject: Re: Developing at 10
Message-Id: <200604301628.14457.michael.pyne () kdemail ! net>
X-MARC-Message: https://marc.info/?l=kde-devel&m=114642894700939
MIME-Version: 1
Content-Type: multipart/mixed; boundary="--===============2077614466=="

--===============2077614466==
Content-Type: multipart/signed;
  boundary="nextPart1278035.nslOLohMyb";
  protocol="application/pgp-signature";
  micalg=pgp-sha1
Content-Transfer-Encoding: 7bit

--nextPart1278035.nslOLohMyb
Content-Type: text/plain;
  charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

On Sunday 30 April 2006 16:10, Allan Sadun wrote:
> Where is the documentation in the KDE SVN repository?

(CC'ing Allan as I'm not sure if you're subscribed)

There's two kinds of documentation.  One is the documentation on the KDE=20
library API (Application Programming Interface). i.e. "How do I use the KDE=
=20
libraries to make KDE programs?".  This is the documentation used by KDE=20
developers, and is likely the kind you will be writing if you are examining=
=20
the code.

You can see an example of the end result at http://tinyurl.com/ma3zl

This kind of documentation is located with the code in the KDE repository,=
=20
usually in the class definition itself.  For the example I just gave=20
(documentation for the KConfig class), you'd find the source at

/trunk/KDE/kdelibs/kdecore/kconfig.h

You can view the KDE SVN repository online at http://websvn.kde.org/

The kconfig.h file I just mentioned it viewable online this way=20
(http://tinyurl.com/q749s).

This kind of documentation is known as Doxygen format, since the doxygen=20
program is used to read the .h files and produce the API documentation.

The second kind of documentation is the user help guide, used in KHelpCente=
r=20
or directly from the Help menu of the KDE application.  It is located in=20
the /doc subdirectory of the module, and is written in the XML DocBook=20
format, although the documentation team will perform the conversion to XML=
=20
for you, so that all that has to be done is to type the documentation in=20
plain text.  This is a good way to start as well, and doesn't involve as mu=
ch=20
looking at source code.

=46or example, the user documentation for the JuK program (in the kdemultim=
edia=20
module) is in kdemultimedia/doc/juk

Also, when replying to a email, please go ahead and remove the parts of the=
=20
message that you're not replying to.  Then make your response under the par=
t=20
that you're replying to, as it is much easier for those of us who weren't i=
n=20
the initial conversation to understand what is being said.  Thanks! :)

Regards,
 - Michael Pyne

--nextPart1278035.nslOLohMyb
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.2 (GNU/Linux)

iD8DBQBEVR3eqjQYp5Omm0oRAr27AKCEng3Tjx0+h91yaGqH0AbCCAEgaQCgoS19
RQwo7f1l5KLV9Fd1WbfuI2E=
=a04B
-----END PGP SIGNATURE-----

--nextPart1278035.nslOLohMyb--

--===============2077614466==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

 
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<

--===============2077614466==--