Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run

Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run

−

<code bash>

+

<syntaxhighlight lang="bash">

% doxygen /path/to/Doxyfile

% doxygen /path/to/Doxyfile

−

</code>

+

</syntaxhighlight>

Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.

Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.

Line 213:

Line 212:

For example:

For example:

−

<code bash>

+

<syntaxhighlight lang="bash">

cs kdesupport # cs is not a typo

cs kdesupport # cs is not a typo

svn up

svn up

cb # cb is not a typo

cb # cb is not a typo

make install

make install

−

</code>

+

</syntaxhighlight>

Note: it is not necessary to run cmakekde for updates.

Note: it is not necessary to run cmakekde for updates.

Line 226:

Line 225:

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

−

<code>

+

<syntaxhighlight lang="text">

add_subdirectory(libkdegames)

add_subdirectory(libkdegames)

add_subdirectory(libkmahjongg)

add_subdirectory(libkmahjongg)

Line 233:

Line 232:

macro_optional_add_subdirectory(lskat)

macro_optional_add_subdirectory(lskat)

macro_optional_add_subdirectory(katomic)

macro_optional_add_subdirectory(katomic)

−

</code>

+

</syntaxhighlight>

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

Although the API documentation for KDE is available online at api.kde.org, it is sometimes useful to have it on your own disk, for example when you want to use KDevelop for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in kdelibs/doc/api, you need doxygen to be able to run it.

In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run svn up and make.

For example:

cs kdesupport # cs is not a typosvn up
cb # cb is not a typomakeinstall

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the kdegames CMakeLists.txt file lists:

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship: