You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
3 years ago | |
---|---|---|
.. | ||
1.png | 8 years ago | |
2.png | 8 years ago | |
3.png | 8 years ago | |
4.png | 8 years ago | |
5.png | 8 years ago | |
6.png | 8 years ago | |
7.png | 8 years ago | |
8.png | 8 years ago | |
9.png | 8 years ago | |
10.png | 8 years ago | |
CMakeLists.txt | 11 years ago | |
Doxyfile.global | 4 years ago | |
Makefile.am | 11 years ago | |
README.Doxygen | 6 years ago | |
appheader.html | 15 years ago | |
artistic-license.html | 12 years ago | |
block_title_bottom.png | 8 years ago | |
block_title_mid.png | 8 years ago | |
block_title_top.png | 8 years ago | |
bottom-left.png | 8 years ago | |
bottom-middle.png | 10 years ago | |
bottom-right.png | 8 years ago | |
bottom1.png | 8 years ago | |
bottom2.png | 8 years ago | |
bsd-license.html | 12 years ago | |
docheadergears.png | 8 years ago | |
doctop1.png | 8 years ago | |
doctop1a-online.png | 8 years ago | |
doctop1a.png | 8 years ago | |
doctop1b.png | 8 years ago | |
doctop2-online.png | 8 years ago | |
doctop2.png | 8 years ago | |
doxygen.css | 3 years ago | |
favicon.ico | 14 years ago | |
fdl-license | 14 years ago | |
fdl-license.html | 12 years ago | |
fdl-notice.html | 15 years ago | |
flat.css | 15 years ago | |
footer.html | 3 years ago | |
gpl-license | 14 years ago | |
gpl-license.html | 12 years ago | |
grad.png | 8 years ago | |
header.html | 3 years ago | |
headerbg.png | 8 years ago | |
kde_gear_64.png | 14 years ago | |
kde_logo.png | 8 years ago | |
kde_logo_bg.png | 8 years ago | |
kmenu.png | 8 years ago | |
lgpl-license | 14 years ago | |
lgpl-license.html | 12 years ago | |
mainfooter.html | 3 years ago | |
mainheader.html | 3 years ago | |
print.css | 15 years ago | |
qpl-license.html | 12 years ago | |
shadow.png | 8 years ago | |
tabs.css | 15 years ago | |
tde-common.css | 12 years ago | |
tde-default.css | 12 years ago | |
tde-docs.css | 11 years ago | |
tde-localised.css.template | 12 years ago | |
tde-web.css | 12 years ago | |
tde.css | 12 years ago | |
top-left.jpg | 15 years ago | |
top-left.png | 8 years ago | |
top-middle.png | 8 years ago | |
top-right-konqueror.png | 8 years ago | |
top-right.jpg | 15 years ago | |
top-right.png | 8 years ago | |
top-trinity.jpg | 14 years ago | |
top.jpg | 15 years ago | |
web-docbottom.png | 8 years ago | |
web-doctop.png | 8 years ago | |
x11-license.html | 12 years ago | |
xml.dcl | 15 years ago |
README.Doxygen
*** *** README for KDE's Doxygen tools *** This directory contains tools and data files for Doxygen generation. These are the GENERIC files; any module may override them by putting specific replacements in doc/api/ . This allows modules to customize their appearance as desired. The files that may be overridden are: - doxygen.css Stylesheet. - mainheader.html Header for front page of dox. This should not be terribly different from header.html. It might contain special CSS for the footer. - mainfooter.html Footer for front page of dox. This should at least credit Doxygen [1] and point to the dox guidelines [2]. - header.html Header file for regular pages. - footer.html Footer file for regular pages. - Doxyfile.global The global (brief) Doxyfile. For a long-style Doxyfile, see KDE PIM's doc/api/Doxyfile.pim. The tool for generating dox lives in admin/ : - doxygen.sh Script that does all the dox generation work. See below for usage information. In a configured build directory, you can use "make apidox" to generate the API dox for the module -- assuming it has any, of course. Writing dox is beyond the scope of this README -- see the notes at http://techbase.kde.org/Policies/Library_Documentation_Policy . You can generate dox by hand -- without even having a configured build directory -- as explained below. There is also documentation for the special tags you can enter in Makefile.am anywhere in a module to modify dox generation. *** *** Tool usage. *** Usage: doxygen.sh [--recurse] [--modulename] [--doxdatadir=<dir>] [--installdir=<dir>] <top_srcdir> [<subdir>] --recurse Also generate dox in subdirs of the given <subdir>. If no <subdir> is given, --recurse is the default and can be turned off with --no-recurse. --modulename By default, apidox are generated in a subdirectory <modulename>-apidocs/ . You can use --no-modulename to suppress the <modulename> and generate the apidox in a subdirectory apidocs/ . Modulename is the last part of the <top_srcdir> (usually a KDE SVN module name). --doxdatadir=<dir> Locate the HTML header files and support graphics. In tdelibs, the subdirectory doc/common/ contains these files (and this README). In an installed KDE system, $TDEDIR/share/doc/tde/HTML/en/common/ contains a copy. This argument is mandatory if doxygen.sh can't guess where the doxdata lives. --installdir=<dir> Locate the directory where apidox from other modules is installed. Subdirectories named *-apidocs/ under the named <dir> are searched for tag files, for cross-module cross-referencing. How to generate dox manually: <TODO> Plan to fit these tools into ../Doxyfile.am: <TODO> Differences with current dox: <TODO> # A shell script that builds dox without all the tedious mucking about with # autoconf and configure. Run it in the "top builddir" with one argument, # the "top srcdir". Something like this: # # cd /mnt/build/tdepim # sh /mnt/src/tdepim/doc/api/doxygen.sh /mnt/src/tdepim # # You can also build single subdirs (for instance, after updating some # dox and you don't want to rebuild for the enitre module) by giving the # subdirectory _relative to the top srcdir_ as a second argument: # # sh /mnt/src/tdepim/doc/api/doxygen.sh /mnt/src/tdepim kpilot/lib # # When generating dox for tdelibs, a tag file for Qt is also created. # The location of Qt is specified indirectly through $TQTDOCDIR or, # if that is not set, $TQTDIR, or otherwise guessed. You may explicitly # set the location of a pre-generated tag file with $TQTDOCTAG. One # typical approach might be: # # TQTDOCTAG=$TQTDIR/doc/qt.tag TQTDOCDIR=http://doc.trolltech.com/3.3/ # # Finally, there is a --no-recurse option for top-level generation # that avoids generating all the subdirectories as well. It also # suppresses cleaning up (rm -rf) of the dox direction beforehand. # # Post-finally, there is a --no-modulename option that builds the # dox in "apidocs/" instead of "modulename-apidocs". The former is # compatible with the KDE 3.4 build system, the latter is more convenient # for the installed dox. # # A shell script to post-process doxy-generated files; the purpose # is to make the menu on the left in the file match the actually # generated files (ie. leave out namespaces if there are none). # # Usage: doxyndex.sh <toplevel-apidocs-dir> <relative-html-output-directory> # # Typically, this means $(top_builddir)/apidocs and something like # libfoo/html for the output. For the top-level dig, set relative-html # to "." . In non-top directories, both <!-- menu --> and <!-- gmenu --> # are calculated and replaced. Top directories get an empty <!-- menu --> # if any.