[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: kdesupport/qt-dbus
From: Brad Hards <bradh () frogmouth ! net>
Date: 2006-06-05 11:12:07
Message-ID: 1149505927.300099.12516.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 548351 by bhards:
More API documentation conversion from qdoc to
doxygen. Also start to link in the examples.
M +5 -3 Doxyfile
A examples.doxy
M +1 -2 src/qdbusabstractadaptor.cpp
M +2 -1 src/qdbusabstractinterface.cpp
M +4 -4 src/qdbuserror.cpp
M +4 -6 src/qdbusmessage.cpp
M +15 -21 src/qdbusutil.cpp
--- trunk/kdesupport/qt-dbus/Doxyfile #548350:548351
@@ -30,7 +30,7 @@
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = doc/api
+OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -179,7 +179,8 @@
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
-ALIASES = "value=\li \a"
+ALIASES = "value=\li \a" \
+ "threadsafe=\note This function is thread-safe."
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
@@ -459,7 +460,7 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = src
+INPUT = src .
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -469,6 +470,7 @@
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
FILE_PATTERNS = *.cpp \
+ *.doxy \
*.h
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
--- trunk/kdesupport/qt-dbus/src/qdbusabstractadaptor.cpp #548350:548351
@@ -88,8 +88,7 @@
}
/*!
- \page usingannotations.html
- \title Using annotations in adaptors
+ \page usingannotations.html Using annotations in adaptors
It is currently not possible to specify arbitrary annotations in adaptors.
*/
--- trunk/kdesupport/qt-dbus/src/qdbusabstractinterface.cpp #548350:548351
@@ -185,7 +185,6 @@
}
/*!
- \threadsafe
Places a call to the remote method specified by \a method on this interface, using \a args as
arguments. This function returns the message that was received as a reply, which can be a normal
QDBusMessage::ReplyMessage (indicating success) or QDBusMessage::ErrorMessage (if the call
@@ -199,6 +198,8 @@
\warning If you use \c UseEventLoop, your code must be prepared to deal with any reentrancy:
other method calls and signals may be delivered before this function returns, as well
as other Qt queued signals and events.
+
+ \threadsafe
*/
QDBusMessage QDBusAbstractInterface::callWithArgs(const QString& method, const QList<QVariant>& args,
CallMode mode)
--- trunk/kdesupport/qt-dbus/src/qdbuserror.cpp #548350:548351
@@ -135,11 +135,11 @@
pre-defined values (\c org.freedesktop.DBus.Error.LimitsExceeded)
\value AccessDenied The call/operation tried to access a resource it isn't allowed to
(\c org.freedesktop.DBus.Error.AccessDenied)
- \value NoServer \i{Documentation doesn't say what this is for}
+ \value NoServer \e {Documentation doesn't say what this is for}
(\c org.freedesktop.DBus.Error.NoServer)
- \value Timeout \i{Documentation doesn't say what this is for or how it's used}
+ \value Timeout \e {Documentation doesn't say what this is for or how it's used}
(\c org.freedesktop.DBus.Error.Timeout)
- \value NoNetwork \i{Documentation doesn't say what this is for}
+ \value NoNetwork \e {Documentation doesn't say what this is for}
(\c org.freedesktop.DBus.Error.NoNetwork)
\value AddressInUse QDBusServer tried to bind to an address that is already in use
(\c org.freedesktop.DBus.Error.AddressInUse)
@@ -149,7 +149,7 @@
(\c org.freedesktop.DBus.Error.InvalidArgs)
\value UnknownMethod The method called was not found in this object/interface with the
given parameters (\c org.freedesktop.DBus.Error.UnknownMethod)
- \value TimedOut \i{Documentation doesn't say...}
+ \value TimedOut \e {Documentation doesn't say...}
(\c org.freedesktop.DBus.Error.TimedOut)
\value InvalidSignature The type signature is not valid or compatible
(\c org.freedesktop.DBus.Error.InvalidSignature)
--- trunk/kdesupport/qt-dbus/src/qdbusmessage.cpp #548350:548351
@@ -55,12 +55,10 @@
This object can represent any of four different types of messages possible on the bus
(see MessageType)
- \list
- \o Method calls
- \o Method return values
- \o Signal emissions
- \o Error codes
- \endlist
+ - Method calls
+ - Method return values
+ - Signal emissions
+ - Error codes
Objects of this type are created with the four static functions signal, methodCall,
methodReply and error.
--- trunk/kdesupport/qt-dbus/src/qdbusutil.cpp #548350:548351
@@ -42,13 +42,11 @@
Returns true if this is \a ifaceName is a valid interface name.
Valid interface names must:
- \list
- \o not be empty
- \o not exceed 255 characters in length
- \o be composed of dot-separated string components that contain only ASCII letters, digits
- and the underscore ("_") character
- \o contain at least two such components
- \endlist
+ - not be empty
+ - not exceed 255 characters in length
+ - be composed of dot-separated string components that contain only ASCII letters, digits
+ and the underscore ("_") character
+ - contain at least two such components
*/
bool isValidInterfaceName(const QString& ifaceName)
{
@@ -96,13 +94,11 @@
Returns true if \a busName is a valid bus name.
A valid bus name is either a valid unique connection name or follows the rules:
- \list
- \o is not empty
- \o does not exceed 255 characters in length
- \o be composed of dot-separated string components that contain only ASCII letters, digits,
- hyphens or underscores ("_"), but don't start with a digit
- \o contains at least two such elements
- \endlist
+ - is not empty
+ - does not exceed 255 characters in length
+ - be composed of dot-separated string components that contain only ASCII letters, digits,
+ hyphens or underscores ("_"), but don't start with a digit
+ - contains at least two such elements
\sa isValidUniqueConnectionName()
*/
@@ -156,13 +152,11 @@
Returns true if \a path is valid object path.
Valid object paths follow the rules:
- \list
- \o start with the slash character ("/")
- \o do not end in a slash, unless the path is just the initial slash
- \o do not contain any two slashes in sequence
- \o contain slash-separated parts, each of which is composed of ASCII letters, digits and
- underscores ("_")
- \endlist
+ - start with the slash character ("/")
+ - do not end in a slash, unless the path is just the initial slash
+ - do not contain any two slashes in sequence
+ - contain slash-separated parts, each of which is composed of ASCII letters, digits and
+ underscores ("_")
*/
bool isValidObjectPath(const QString &path)
{
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic