diff options
| author | Havoc Pennington <hp@redhat.com> | 2003-02-19 03:53:24 +0000 |
|---|---|---|
| committer | Havoc Pennington <hp@redhat.com> | 2003-02-19 03:53:24 +0000 |
| commit | c21511c01ab56d75f3aa4643761e9fd096a7f8be (patch) | |
| tree | 7a0542dd8d02b8fd8e98e42409b1bf42564d32c0 /dbus/dbus-auth-script.c | |
| parent | 78e16e99e753175fa49e787eab256932eefaa03f (diff) | |
2003-02-19 Havoc Pennington <hp@pobox.com>
Throughout: mop up all the Doxygen warnings and undocumented
stuff.
* dbus/dbus-sysdeps.c (do_exec): do not use execvp, we don't want
to search any paths.
* dbus/dbus-threads.c: move global mutex initializers to
dbus-internals.h, multiple prototypes was confusing doxygen
besides being kind of ugly
* Doxyfile (PREDEFINED): have Doxygen define
DOXYGEN_SHOULD_SKIP_THIS so we can exclude things from
docs with #ifndef DOXYGEN_SHOULD_SKIP_THIS
(do not abuse the feature! it's for stuff like the autogenerated
macros in dbus-md5.c, not just for things you don't feel like
documenting...)
Diffstat (limited to 'dbus/dbus-auth-script.c')
| -rw-r--r-- | dbus/dbus-auth-script.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/dbus/dbus-auth-script.c b/dbus/dbus-auth-script.c index 21a9f996..4dccfe9f 100644 --- a/dbus/dbus-auth-script.c +++ b/dbus/dbus-auth-script.c @@ -170,6 +170,16 @@ auth_state_to_string (DBusAuthState state) return "unknown"; } +/** + * Runs an "auth script" which is a script for testing the + * authentication protocol. Scripts send and receive data, and then + * include assertions about the state of both ends of the connection + * after processing the data. A script succeeds if these assertions + * hold. + * + * @param filename the file containing the script to run + * @returns #TRUE if the script succeeds, #FALSE otherwise + */ dbus_bool_t _dbus_auth_script_run (const DBusString *filename) { |