[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-core-devel
Subject: Update: Move to Doxygen
From: Peter Putzer <pputzer () edu ! uni-klu ! ac ! at>
Date: 2000-10-31 13:37:46
[Download RAW message or body]
Hi,
as promised I've got preliminary doxygen-rules (the dox.tgz archive) and
patches for kdelibs (some escaping of "illegal" chars (@page in DOM),
removal of one excessive "@libdoc" (in favor of a "@page"), change of
"@sect" to "@section").
I'm behind a firewall or I would put up the generated documentation, but I
could provide a tarball if there is interest.
regards,
Peter
["doxygen-doc.diff" (TEXT/PLAIN)]
Index: dcop/dcop-doc.h
===================================================================
RCS file: /home/kde/kdelibs/dcop/dcop-doc.h,v
retrieving revision 1.4
diff -u -3 -p -r1.4 dcop-doc.h
--- dcop/dcop-doc.h 2000/06/03 23:01:45 1.4
+++ dcop/dcop-doc.h 2000/10/31 13:30:28
@@ -13,7 +13,7 @@ beyond that it does not require any othe
it is extremely lightweight, enabling it to be linked into all KDE
applications with low overhead.
-@sect Model:
+@section dcop0 Model:
The model is simple. Each application using DCOP is a client. They
communicate to each other through a DCOP server, which functions like
@@ -35,7 +35,7 @@ has the additional benefit of type safet
The manual method is covered first, followed by the automatic IDL method.
-@sect Establishing the Connection:
+@section dcop1 Establishing the Connection:
KApplication has gained a method called "KApplication::dcopClient()"
which returns a pointer to a DCOPClient instance. The first time this
@@ -76,7 +76,7 @@ equal to kapp->name(). You can retrieve
by calling kapp->dcopClient().
-@sect Sending Data to a Remote Application:
+@section dcop2 Sending Data to a Remote Application:
To actually communicate, you have one of two choices. You may either
call the "send" or the "call" method. Both methods require three
@@ -143,7 +143,7 @@ else {
</pre>
-@sect Receiving Data via DCOP:
+@section dcop3 Receiving Data via DCOP:
Currently the only real way to receive data from DCOP is to multiply
inherit from the normal class that you are inheriting (usually some
@@ -181,7 +181,7 @@ bool BarObject::process(const QCString &
</pre>
-@sect Receiving Calls and processing them:
+@section dcop4 Receiving Calls and processing them:
If your applications is able to process incoming function calls
right away the above code is all you need. When your application
@@ -231,7 +231,7 @@ slotProcessingDone(DCOPClientTransaction
</pre>
-@sect Using the dcopidl compiler:
+@section dcop5 Using the dcopidl compiler:
dcopidl makes setting up a DCOP server easy. Instead of having to implement
the process() method and unmarshalling (retrieving from QByteArray) parameters
@@ -358,7 +358,7 @@ manually. To use a stub, add MyInterface
your Makefile.am. The stub class will then be called MyInterface_stub.
-@sect Inter-user communication:
+@section dcop6 Inter-user communication:
Sometimes it might be interesting to use DCOP between processes
belonging to different users, e.g. a frontend process running
@@ -392,7 +392,7 @@ NOTE: DCOP communication is not encrypte
pass important information around this way.
-@sect Conclusion:
+@section dcop7 Conclusion:
Hopefully this document will get you well on your way into the world of
inter-process communication with KDE! Please direct all comments and/or
Index: dcop/dcopglobal.h
===================================================================
RCS file: /home/kde/kdelibs/dcop/dcopglobal.h,v
retrieving revision 1.21
diff -u -3 -p -r1.21 dcopglobal.h
--- dcop/dcopglobal.h 2000/09/05 22:05:00 1.21
+++ dcop/dcopglobal.h 2000/10/31 13:30:28
@@ -54,11 +54,7 @@ extern "C" {
#define DCOPFind 7
/**
- * @libdoc
- *
- * DCOP Protocol description
- * ================
- *
+ * @page dcop_protocol DCOP Protocol Description
*
* A DCOPSend message does not expect any reply.
* data: << fromId << toId << objId << fun << dataSize + data[dataSize]
Index: kdecore/kmimesourcefactory.h
===================================================================
RCS file: /home/kde/kdelibs/kdecore/kmimesourcefactory.h,v
retrieving revision 1.5
diff -u -3 -p -r1.5 kmimesourcefactory.h
--- kdecore/kmimesourcefactory.h 2000/08/15 05:26:01 1.5
+++ kdecore/kmimesourcefactory.h 2000/10/31 13:30:31
@@ -58,10 +58,9 @@ public:
* To load an icon, prepend the @p category name before the @p icon name, in the style
* of <category>|<icon>.
*
- * Example:
- * <pre> "<img src=\"user|ksysv_start\"/>", "<img src="\desktop|trash\">", ...
- * </pre>
- *
+ * @b Example:
+ * "\<img src=\"user|ksysv_start\"/\>", "\<img src="\desktop|trash\"\>", ...
+ *
* @param abs_or_rel_name is the absolute or relative pathname.
* @param context is the path of the context object for the queried resource. Almost always empty.
*/
Index: kdecore/kprocess.h
===================================================================
RCS file: /home/kde/kdelibs/kdecore/kprocess.h,v
retrieving revision 1.35
diff -u -3 -p -r1.35 kprocess.h
--- kdecore/kprocess.h 2000/09/23 22:25:03 1.35
+++ kdecore/kprocess.h 2000/10/31 13:30:31
@@ -42,7 +42,7 @@ class KProcessPrivate;
/**
* Child process invocation, monitoring and control.
*
- * @sect General usage and features
+ * @section kprocess0 General usage and features
*
*This class allows a KDE application to start child processes without having
*to worry about UN*X signal handling issues and zombie process reaping.
@@ -91,7 +91,7 @@ class KProcessPrivate;
*
*When the child process exits, the respective Qt signal will be emitted.
*
- *@sect Communication with the child process
+ *@section kprocess1 Communication with the child process
*
*KProcess supports communication with the child process through
*stdin/stdout/stderr.
@@ -119,7 +119,7 @@ class KProcessPrivate;
*without a communication channel to stderr.
*
*
- *@sect QT signals:
+ *@section kprocess2 QT signals:
*
*@li void @ref receivedStdout(KProcess *proc, char *buffer, int buflen);
*@li void @ref receivedStderr(KProcess *proc, char *buffer, int buflen);
Index: kdecore/kstddirs.h
===================================================================
RCS file: /home/kde/kdelibs/kdecore/kstddirs.h,v
retrieving revision 1.73
diff -u -3 -p -r1.73 kstddirs.h
--- kdecore/kstddirs.h 2000/09/05 20:47:56 1.73
+++ kdecore/kstddirs.h 2000/10/31 13:30:32
@@ -67,7 +67,7 @@ class KStandardDirsPrivate;
* specific directories that aren't in his $HOME/.kde directory for,
* for example, icons.
*
-* @sect Standard resources that kdelibs allocates are:
+* @section kstddirs0 Standard resources that kdelibs allocates are:
*
* @li apps - Applications menu (.desktop files).
* @li cgi - CGIs to run from kdehelp.
@@ -97,7 +97,7 @@ class KStandardDirsPrivate;
* be "Kicker" instead of the applet's name. Therefore, for applets, you've got
* to work around this by using @ref locate("data", "appletname/filename").
*
-* @sect KStandardDirs supports the following environment variables:
+* @section kstddirs1 KStandardDirs supports the following environment variables:
*
* @li KDEDIRS: This may set an additional number of directory prefixes to
* search for resources. The directories should be seperated
Index: kdecore/kurl.h
===================================================================
RCS file: /home/kde/kdelibs/kdecore/kurl.h,v
retrieving revision 1.71
diff -u -3 -p -r1.71 kurl.h
--- kdecore/kurl.h 2000/10/15 22:43:22 1.71
+++ kdecore/kurl.h 2000/10/31 13:30:32
@@ -40,10 +40,10 @@ struct KURLPrivate;
* encoding. @ref KURL works internally with the decoded path and
* and encoded query. For example,
* <pre>
- * http://localhost/cgi-bin/test%20me.pl?cmd=Hello%20you
+ * http://localhost/cgi-bin/test\%20me.pl?cmd=Hello\%20you
* </pre>
* would result in a decoded path "/cgi-bin/test me.pl"
- * and in the encoded query "?cmd=Hello%20you".
+ * and in the encoded query "?cmd=Hello\%20you".
* Since path is internally always encoded you may @em not use
* "%00" in the path, although this is OK for the query.
*
@@ -75,9 +75,9 @@ public:
* part, "file:" is assumed.
* It is dangerous to feed unix filenames into this function,
* this will work most of the time but not always.
- * For example "/home/Torben%20Weis" will be considered a URL
+ * For example "/home/Torben\%20Weis" will be considered a URL
* pointing to the file "/home/Torben Weis" instead of to the
- * file "/home/Torben%20Weis".
+ * file "/home/Torben\%20Weis".
* This means that if you have a usual UNIX like path you
* should not use this constructor.
* Instead create an empty url and set the path by using
@@ -373,7 +373,7 @@ public:
/**
* @return The complete URL, with all escape sequences intact.
- * Example: http://localhost:8080/test.cgi?test=hello%20world&name=fred
+ * Example: http://localhost:8080/test.cgi?test=hello\%20world&name=fred
*
* @param _trailing This may be ( -1, 0 +1 ). -1 strips a trailing '/' from the path, +1 adds
* a trailing '/' if there is none yet and 0 returns the
Index: kdeui/kaccelmenu.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kaccelmenu.h,v
retrieving revision 1.10
diff -u -3 -p -r1.10 kaccelmenu.h
--- kdeui/kaccelmenu.h 2000/06/24 14:13:27 1.10
+++ kdeui/kaccelmenu.h 2000/10/31 13:30:33
@@ -38,7 +38,7 @@ class KAccelMenuPrivate;
* Previously: The quote key was required only for keys that
* are used for menu accelerators.
*
- * @sect Usage:
+ * @section kaccelmenu0 Usage:
* <pre>
* keys = new KAccel(this);
*
Index: kdeui/kaction.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kaction.h,v
retrieving revision 1.88
diff -u -3 -p -r1.88 kaction.h
--- kdeui/kaction.h 2000/10/09 07:42:22 1.88
+++ kdeui/kaction.h 2000/10/31 13:30:33
@@ -85,7 +85,7 @@ class KPopupMenu;
* one-to-one relationship between the "real" action and @p all
* GUI representations of it.
*
- * @sect General Usage:
+ * @section kaction0 General Usage:
*
* The steps to using actions are roughly as follows
*
@@ -95,7 +95,7 @@ class KPopupMenu;
* @li "Plug" the Action into whatever GUI element you want. Typically,
* this will be a menu or toolbar.
*
- * @sect Detailed Example:
+ * @section kaction1 Detailed Example:
*
* Here is an example of enabling a "New [document]" action
* <PRE>
@@ -136,7 +136,7 @@ class KPopupMenu;
* please use the methods in the @ref KStdAction class rather then
* defining your own.
*
- * @sect Usage Within the XML Framework:
+ * @section kaction2 Usage Within the XML Framework:
*
* If you are using KAction within the context of the XML menu and
* toolbar building framework, then there are a few tiny changes. The
Index: kdeui/kcolordialog.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kcolordialog.h,v
retrieving revision 1.33
diff -u -3 -p -r1.33 kcolordialog.h
--- kdeui/kcolordialog.h 2000/07/25 08:05:15 1.33
+++ kdeui/kcolordialog.h 2000/10/31 13:30:34
@@ -340,7 +340,7 @@ private:
/**
* The KColorDialog provides a dialog for color selection.
*
- * @sect Features:
+ * @section kcolordialog0 Features:
*
* @li Colour selection from a wide range of palettes.
* @li Colour selection from a palette of H vs S and V selectors (similar to windoze).
Index: kdeui/kcombobox.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kcombobox.h,v
retrieving revision 1.75
diff -u -3 -p -r1.75 kcombobox.h
--- kdeui/kcombobox.h 2000/10/09 21:47:10 1.75
+++ kdeui/kcombobox.h 2000/10/31 13:30:34
@@ -34,7 +34,7 @@ class KURL;
/**
* A combined button, line-edit and a popup list widget.
*
- * @sect Detail
+ * @section kcombobox0 Detail
*
* This widget inherits from @ref QComboBox and implements
* the following additional functionalities: a completion
@@ -78,7 +78,7 @@ class KURL;
* automatically select an item from the list by trying to match the pressed
* keycode with the first letter of the enteries in the combo box.
*
- * @sect Example
+ * @section kcombobox1 Example
*
* To enable the basic completion feature:
*
Index: kdeui/kdialogbase.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kdialogbase.h,v
retrieving revision 1.44
diff -u -3 -p -r1.44 kdialogbase.h
--- kdeui/kdialogbase.h 2000/07/19 04:10:03 1.44
+++ kdeui/kdialogbase.h 2000/10/31 13:30:34
@@ -87,7 +87,7 @@ class KDialogBaseTile : public QObject
* that contains
* copy/paste examples as well a screenshots on how to use this class.
*
- * @sect Standard buttons (action buttons):
+ * @section kdialogbase0 Standard buttons (action buttons):
*
* You select which buttons should be displayed, but you do not choose the
* order in which they are displayed. This ensures a standard interface in
@@ -117,7 +117,7 @@ class KDialogBaseTile : public QObject
* signals that are related to the standard action buttons will be used
* when you don't use these buttons.
*
- * @sect Dialog shapes:
+ * @section kdialogbase1 Dialog shapes:
*
* You can either use one of the prebuilt, easy to use, faces or
* define your own main widget. The dialog provides ready to use
@@ -130,7 +130,7 @@ class KDialogBaseTile : public QObject
* resize itself to fit this minimum size. The dialog is resizeable, but
* can not be made smaller than its minimum size.
*
- * @sect Layout:
+ * @section kdialogbase2 Layout:
* The dialog consists of a help area on top (becomes visible if you define
* a help path and use @ref enableLinkedHelp()), the main area which is
* the built-in dialog face or your own widget in the middle and by default
@@ -141,7 +141,7 @@ class KDialogBaseTile : public QObject
* is at the right edge). Normally you specify that you want a separator
* in the constructor, but you can use @ref enableButtonSeparator() as well.
*
- * @sect Standard compliance:
+ * @section kdialogbase3 Standard compliance:
*
* The class is derived from @ref KDialog, so you get automatic access to
* the @ref KDialog::marginHint(), @ref KDialog::spacingHint() and the
Index: kdeui/kled.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kled.h,v
retrieving revision 1.16
diff -u -3 -p -r1.16 kled.h
--- kdeui/kled.h 2000/09/07 17:12:04 1.16
+++ kdeui/kled.h 2000/10/31 13:30:35
@@ -74,7 +74,7 @@ public:
* because of the 3 shading circles and is
* most time consuming. Makes sense for LED > 15x15 pixels.
*
- * @sect Timings:
+ * @section kled0 Timings:
* ( AMD K5/133, Diamond Stealth 64 PCI Graphics, widgetsize 29x29 )
* @li flat Approximately 0.7 msec per paint
* @li round Approximately 2.9 msec per paint
Index: kdeui/klineedit.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/klineedit.h,v
retrieving revision 1.55
diff -u -3 -p -r1.55 klineedit.h
--- kdeui/klineedit.h 2000/10/09 21:47:10 1.55
+++ kdeui/klineedit.h 2000/10/31 13:30:35
@@ -37,7 +37,7 @@ class KURL;
/**
* An enhanced QLineEdit widget for inputting text.
*
- * @sect Detail
+ * @section klineedit0 Detail
*
* This widget inherits from @ref QLineEdit and implements the following
* additional functionalities: q completion object that provides both
@@ -82,7 +82,7 @@ class KURL;
* list. Hence, if the @p EchoMode is not @ref QLineEdit::Normal, the completion
* mode is automatically disabled.
*
- * @sect Examples
+ * @section klineedit1 Examples
*
* To enable the basic completion feature :
*
@@ -108,7 +108,7 @@ class KURL;
* when you don't need it anymore, or call
* setAutoDeleteCompletionObject( true );
*
- * @sect Miscellaneous function calls :
+ * @section klineedit2 Miscellaneous function calls :
*
* <pre>
* // Tell the widget not to handle completion and
Index: kdeui/kmainwindow.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kmainwindow.h,v
retrieving revision 1.10
diff -u -3 -p -r1.10 kmainwindow.h
--- kdeui/kmainwindow.h 2000/10/01 19:06:05 1.10
+++ kdeui/kmainwindow.h 2000/10/31 13:30:35
@@ -181,7 +181,7 @@ public:
KPopupMenu* customHelpMenu( bool showWhatsThis = TRUE );
/**
- * @sect Session Management
+ * @section kmainwindow0 Session Management
*
* Try to restore the toplevel widget as defined by the number (1..X).
*
Index: kdeui/kpanelapplet.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpanelapplet.h,v
retrieving revision 1.16
diff -u -3 -p -r1.16 kpanelapplet.h
--- kdeui/kpanelapplet.h 2000/10/11 18:43:36 1.16
+++ kdeui/kpanelapplet.h 2000/10/31 13:30:36
@@ -46,12 +46,12 @@ class KConfig;
* Besides standard keys like "Name", "Comment" and "Icon" there are
* two panel applet specific keys:
*
- * @sect X-KDE-Library
+ * @section kpanelapplet0 X-KDE-Library
*
* Used by the panel to locate the applet DSO (Dynamic Shared Object)
* Example: X-KDE-Library=libexampleapplet
*
- * @sect X-KDE-UniqueApplet
+ * @section kpanelapplet1 X-KDE-UniqueApplet
*
* Similar to @ref KApplication and @ref KUniqueApplication there are
* two types of panel appelts. Use unique applets when it makes no
Index: kdeui/kpanelextension.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpanelextension.h,v
retrieving revision 1.2
diff -u -3 -p -r1.2 kpanelextension.h
--- kdeui/kpanelextension.h 2000/10/27 15:18:25 1.2
+++ kdeui/kpanelextension.h 2000/10/31 13:30:36
@@ -47,12 +47,12 @@ class KPanelExtensionPrivate;
* Besides standard keys like "Name", "Comment" and "Icon" there are
* two panel extension specific keys:
*
- * @sect X-KDE-Library
+ * @section kpanelextension0 X-KDE-Library
*
* Used by the panel to locate the extension DSO (Dynamic Shared Object)
* Example: X-KDE-Library=libexampleextension
*
- * @sect X-KDE-UniqueExtension
+ * @section kpanelextension1 X-KDE-UniqueExtension
*
* Similar to @ref KApplication and @ref KUniqueApplication there are
* two types of panel extensions. Use unique extensions when it makes no
Index: kdeui/kpassdlg.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpassdlg.h,v
retrieving revision 1.8
diff -u -3 -p -r1.8 kpassdlg.h
--- kdeui/kpassdlg.h 2000/09/05 22:15:14 1.8
+++ kdeui/kpassdlg.h 2000/10/31 13:30:36
@@ -83,7 +83,7 @@ private:
* probably interested in are the static methods, @ref #getPassword() and
* @ref #getNewPassword().
*
- * @sect Usage example
+ * @section kpassdlg0 Usage example
*
* <pre>
* QCString password;
@@ -92,7 +92,7 @@ private:
* use(password);
* </pre>
*
- * @sect Security notes
+ * @section kpassdlg1 Security notes
*
* Keeping passwords in memory can be a potential security hole. You should
* handle this situation with care.
Index: kdeui/kpixmapio.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpixmapio.h,v
retrieving revision 1.6
diff -u -3 -p -r1.6 kpixmapio.h
--- kdeui/kpixmapio.h 2000/06/25 16:52:16 1.6
+++ kdeui/kpixmapio.h 2000/10/31 13:30:36
@@ -25,7 +25,7 @@ class KPixmapIOData;
* It uses the MIT-SHM shared memory extension for this. If this extension is
* not available, it will fall back to standard Qt methods.
*
- * @sect Typical usage
+ * @section kpixmapio0 Typical usage
*
* You can use KPixmapIO for load/saving pixmaps.
*
@@ -38,7 +38,7 @@ class KPixmapIOData;
* It also has functionality for partially updating/saving pixmaps, see
* @ref #putImage and @ref #getImage.
*
- * @sect KPixmapIO vs. Qt speed comparison
+ * @section kpixmapio1 KPixmapIO vs. Qt speed comparison
*
* Speed measurements were taken. These show that usage of KPixmapIO for
* images up to a certain threshold size, offers no speed advantage over
@@ -74,7 +74,7 @@ class KPixmapIOData;
* implementation of 16 bit RGB packing in Qt, while at 32 bpp we need to
* transfer more data, and thus gain more, than at 24 bpp.
*
- * @sect Conclusion
+ * @section kpixmapio2 Conclusion
*
* For large pixmaps, there's a definite speed improvement when using
* KPixmapIO. On the other hand, there's no speed improvement for small
Index: kdeui/kprogress.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kprogress.h,v
retrieving revision 1.18
diff -u -3 -p -r1.18 kprogress.h
--- kdeui/kprogress.h 2000/06/26 12:31:15 1.18
+++ kdeui/kprogress.h 2000/10/31 13:30:36
@@ -35,7 +35,7 @@
* is that @ref setValue() is now made a slot, so you can connect
* stuff to it.
*
- * @sect Details
+ * @section kprogress0 Details
*
* None of the constructors take line step and page step as arguments,
* so by default they're set to 1 and 10 respectively.
Index: kdeui/kstdaction.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kstdaction.h,v
retrieving revision 1.14
diff -u -3 -p -r1.14 kstdaction.h
--- kdeui/kstdaction.h 2000/08/17 11:15:18 1.14
+++ kdeui/kstdaction.h 2000/10/31 13:30:36
@@ -37,7 +37,7 @@ class KStdActionPrivate;
* also. When in doubt on how things work, check the @ref KAction
* documention first.
*
- * @sect Simple Example:
+ * @section kstdaction0 Simple Example:
*
* In general, using standard actions should be a drop in replacement
* for regular actions. For example, if you previously had:
@@ -55,7 +55,7 @@ class KStdActionPrivate;
* actionCollection());
* </PRE>
*
- * @sect Non-standard Usages
+ * @section kstdaction1 Non-standard Usages
*
* It is possible to use the standard actions in various
* non-recommended ways. Say, for instance, you wanted to have a
Index: khtml/dom/css_rule.h
===================================================================
RCS file: /home/kde/kdelibs/khtml/dom/css_rule.h,v
retrieving revision 1.5
diff -u -3 -p -r1.5 css_rule.h
--- khtml/dom/css_rule.h 2000/08/21 13:46:01 1.5
+++ khtml/dom/css_rule.h 2000/10/31 13:30:37
@@ -336,8 +336,8 @@ public:
class CSSPageRuleImpl;
/**
* The <code> CSSPageRule </code> interface represents a <a
- * href="http://www.w3.org/TR/REC-CSS2/page.html#page-box"> @page rule
- * </a> within a CSS style sheet. The <code> @page </code> rule is
+ * href="http://www.w3.org/TR/REC-CSS2/page.html#page-box"> \@page rule
+ * </a> within a CSS style sheet. The <code> \@page </code> rule is
* used to specify the dimensions, orientation, margins, etc. of a
* page box for paged media.
*
Index: kio/kimageio.h
===================================================================
RCS file: /home/kde/kdelibs/kio/kimageio.h,v
retrieving revision 1.3
diff -u -3 -p -r1.3 kimageio.h
--- kio/kimageio.h 2000/06/06 22:53:36 1.3
+++ kio/kimageio.h 2000/10/31 13:30:37
@@ -23,7 +23,7 @@
* with the @ref QImageIO handler format. The backends are loaded on demand
* when a particular format is requested.
*
- * @sect Formats
+ * @section kimageio0 Formats
*
* Currently supported formats include:
* @li JPEG <read>
@@ -34,12 +34,12 @@
* @li TIFF <read>
* @li KRL <read>
*
- * @sect Usage
+ * @section kimageio1 Usage
*
* Simply call the @ref KImageIO::registerFormats() static method declared
* in kimgageio.h.
*
- * @sect Example
+ * @section kimageio2 Example
*
* <pre>
#include<qpixmap.h>
Index: kio/ktrader.h
===================================================================
RCS file: /home/kde/kdelibs/kio/ktrader.h,v
retrieving revision 1.9
diff -u -3 -p -r1.9 ktrader.h
--- kio/ktrader.h 2000/10/10 00:52:23 1.9
+++ kio/ktrader.h 2000/10/31 13:30:39
@@ -32,7 +32,7 @@
* and/or path of the application. It is mostly used when you want to
* do complex queries that @ref KServiceTypeProfile can't handle.
*
- * @sect Examples
+ * @section ktrader0 Examples
*
* A few examples will make this a lot more clear.
*
Index: kio/kurifilter.h
===================================================================
RCS file: /home/kde/kdelibs/kio/kurifilter.h,v
retrieving revision 1.16
diff -u -3 -p -r1.16 kurifilter.h
--- kio/kurifilter.h 2000/09/09 20:08:18 1.16
+++ kio/kurifilter.h 2000/10/31 13:30:39
@@ -40,7 +40,7 @@ class KCModule;
* create an instance of this class and send it to @ref KURIFilter
* to have the filter plugins fill the necessary information.
*
-* @sect Example
+* @section kurifilter0 Example
* <pre>
* QString text = "kde.org";
* KURIFilterData d = text;
@@ -421,7 +421,7 @@ private:
* by doing @p KURIFilter::self() and use any of the public member
* functions to preform the filtering.
*
- * @sect Example
+ * @section kurifilter1 Example
*
* To simply filter a given string:
* <pre>
Index: kparts/part.h
===================================================================
RCS file: /home/kde/kdelibs/kparts/part.h,v
retrieving revision 1.78
diff -u -3 -p -r1.78 part.h
--- kparts/part.h 2000/09/01 04:54:58 1.78
+++ kparts/part.h 2000/10/31 13:30:41
@@ -105,14 +105,14 @@ private:
* @li GUI elements that will be merged in the "host" user interface
* (menubars, toolbars... ).
*
- * @sect About the widget
+ * @section part0 About the widget
* Note that @ref KParts::Part does not inherit @ref QWidget.
* This is due to the fact that the "visual representation"
* will probably not be a mere @ref QWidget, but an elaborate one.
* That's why when implementing your @ref KParts::Part (or derived)
* you should call @ref KParts::Part::setWidget() in your constructor.
*
- * @sect About the GUI elements
+ * @section part1 About the GUI elements
* Those elements trigger actions, defined by the part (@ref action()).
* The layout of the actions in the GUI is defined by an XML file (@ref setXMLFile()).
*
Index: kspell/ksconfig.h
===================================================================
RCS file: /home/kde/kdelibs/kspell/ksconfig.h,v
retrieving revision 1.27
diff -u -3 -p -r1.27 ksconfig.h
--- kspell/ksconfig.h 2000/10/20 17:39:38 1.27
+++ kspell/ksconfig.h 2000/10/31 13:30:41
@@ -95,7 +95,7 @@ class KSpellConfig : public QWidget
void operator= (const KSpellConfig &ksc);
/**
- * @sect Options setting routines.
+ * @section ksconfig0 Options setting routines.
**/
/**
["dox.tgz" (APPLICATION/octet-stream)]
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic