Mercurial > pidgin
changeset 11501:9563b768e8e2
[gaim-migrate @ 13746]
Doxygen fixes.
committer: Tailor Script <tailor@pidgin.im>
| author | Richard Laager <rlaager@wiktel.com> |
|---|---|
| date | Sun, 11 Sep 2005 03:58:13 +0000 |
| parents | 9fc7d0153332 |
| children | b858f992b566 |
| files | doc/PERL-HOWTO.dox src/dbus-bindings.h src/dbus-server.h src/dnssrv.h src/notify.h src/stun.h src/upnp.h src/util.h |
| diffstat | 8 files changed, 18 insertions(+), 26 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/PERL-HOWTO.dox Sun Sep 11 02:58:03 2005 +0000 +++ b/doc/PERL-HOWTO.dox Sun Sep 11 03:58:13 2005 +0000 @@ -3,7 +3,7 @@ @section Introduction Gaim Perl Plugins are setup very similarly to their C counterparts. Most of the API calls are implemented and are divided into pacakges. There are some significant differences between the Perl and C API. Much like the C API, the best place to seek guidances is the source located in the plugins/perl/common directory. The tutorial that follows will be example based and attempt to touch on the salient features of the embedded perl interpreter. It is also important to note that some of the C API is missing in Gaim's perl API. -It is possible to get Gtk2-Perl to work with Gaim's perl API, however you must not load the module with @c use but with @require. If you are uninterested in using Gtk with your perl plugins than this still has bearing on you if you would like to use certain perl modules that are dynamically loaded. By always using @c require instead of @c use the problem is avoided. +It is possible to get Gtk2-Perl to work with Gaim's perl API, however you must not load the module with @c use but with @c require. If you are uninterested in using Gtk with your perl plugins than this still has bearing on you if you would like to use certain perl modules that are dynamically loaded. By always using @c require instead of @c use the problem is avoided. @section first-script Writing your first script @@ -340,7 +340,6 @@ The @c Gaim::Request package allows for plugins to have interactive dialog boxes without the need for creating them in Gtk creating a seperation between the user interfaace and the plugin. The portion of the Request API available to perl scripts is listed below followed by an example illustrating their use. These arguments are the same for each of the three request types: -@args @arg @em handle - The plugin handle. @arg @em title - String title for the dialog. @arg @em primary - The first sub-heading. @@ -355,7 +354,6 @@ @arg @em hint - See source for more information - can be left blank. @arg @em filename - String defualt file name value. @arg @em savedialog - Boolean where true indicates use as a save file dialog and false indicates an open file dialog. -@args @code # Create a simple text input box
--- a/src/dbus-bindings.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/dbus-bindings.h Sun Sep 11 03:58:13 2005 +0000 @@ -1,5 +1,5 @@ /** - * @file dbus-server.h Gaim DBUS Server + * @file dbus-bindings.h Gaim DBUS Bindings * @ingroup core * * gaim
--- a/src/dbus-server.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/dbus-server.h Sun Sep 11 03:58:13 2005 +0000 @@ -38,11 +38,11 @@ proper as well as introduce their own types that will not conflict with those introduced by other plugins. - The structure GaimDbusType has only one element #parent, which - contains a pointer to the parent type, or #NULL if the type has no - parent. Parent means the same as the base class is object oriented + The structure GaimDbusType has only one element (GaimDBusType::parent), a + contains a pointer to the parent type, or @c NULL if the type has no + parent. Parent means the same as the base class in object oriented programming. - */ +*/ typedef struct _GaimDBusType GaimDBusType; @@ -147,9 +147,9 @@ /** Macro #DBUS_EXPORT expands to nothing. It is used to indicate to the - #dbus-analize-functions.py script that the given function should be + dbus-analize-functions.py script that the given function should be available to other applications through DBUS. If - #dbus-analize-functions.py is run without the "--export-only" option, + dbus-analize-functions.py is run without the "--export-only" option, this prefix is ignored. */
--- a/src/dnssrv.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/dnssrv.h Sun Sep 11 03:58:13 2005 +0000 @@ -38,7 +38,8 @@ * @param protocol Name of the protocol (e.g. "sip") * @param transport Name of the transport ("tcp" or "udp") * @param domain Domainname to query (e.g. "blubb.com") - * @cb A callback which will be called with the results + * @param cb A callback which will be called with the results + * @param extradata Extra data to be passed to the callback */ void gaim_srv_resolve(const char *protocol, const char *transport, const char *domain, SRVCallback cb, gpointer extradata);
--- a/src/notify.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/notify.h Sun Sep 11 03:58:13 2005 +0000 @@ -211,7 +211,7 @@ * Adds a new column to the search result object. * * @param results The result object to which the column will be added. - * @param columnt The column that will be added to the result object. + * @param column The column that will be added to the result object. */ void gaim_notify_searchresults_column_add(GaimNotifySearchResults *results, GaimNotifySearchColumn *column);
--- a/src/stun.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/stun.h Sun Sep 11 03:58:13 2005 +0000 @@ -64,7 +64,7 @@ * is already done. Otherwise the callback is called when the discovery is over * and NULL is returned. * - * @param A callback + * @param cb A callback * * @return a struct stun_nattype which includes the public IP and the type * of NAT or NULL is discovery would block
--- a/src/upnp.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/upnp.h Sun Sep 11 03:58:13 2005 +0000 @@ -48,8 +48,6 @@ * contains the WANIPConnection service that will allow us to recieve the * public IP address of the IGD, and control it for forwarding ports. * - * @param void - * * @return The control URL for the IGD we'll use to use the IGD services */ GaimUPnPControlInfo* gaim_upnp_discover(void); @@ -61,7 +59,7 @@ * network, so when getting the network IP, instead of returning the * local network IP, the public IP is retrieved. * - * @param controlURL The control URL retrieved from gaim_upnp_discover. + * @param controlInfo The control URL retrieved from gaim_upnp_discover. * * @return The IP address of the network, or NULL if something went wrong */ @@ -73,7 +71,7 @@ * this gaim client. Essentially, this function takes care of the port * forwarding so things like file transfers can work behind NAT firewalls * - * @param controlURL The control URL retrieved from gaim_upnp_discover. + * @param controlInfo The control URL retrieved from gaim_upnp_discover. * @param portMap The port to map to this client * @param protocol The protocol to map, either "TCP" or "UDP" * @@ -89,14 +87,14 @@ * port forwarding after they have completed a connection so another client on * the local network can take advantage of the port forwarding * - * @param controlURL The control URL retrieved from gaim_upnp_discover. + * @param controlInfo The control URL retrieved from gaim_upnp_discover. * @param portMap The port to delete the mapping for * @param protocol The protocol to map to. Either "TCP" or "UDP" * * @return TRUE if success, FALSE if something went wrong. */ gboolean -gaim_upnp_remove_port_mapping(const GaimUPnPControlInfo* controlURL, +gaim_upnp_remove_port_mapping(const GaimUPnPControlInfo* controlInfo, unsigned short portMap, const gchar* protocol); /*@}*/
--- a/src/util.h Sun Sep 11 02:58:03 2005 +0000 +++ b/src/util.h Sun Sep 11 03:58:13 2005 +0000 @@ -125,14 +125,9 @@ * explanation. Also see RFC 2045. * * @param str The quoted printable ASCII string to convert to raw data. - * @param ret_str The returned, readable string. - * @param ret_len The length of the returned data. You can - * pass in NULL if you're sure that you know - * the length of the decoded data, or if you - * know you'll be able to use strlen to - * determine the length, etc. + * @param ret_len The length of the returned data. * - * @return The raw data. Must be g_free'd when no longer needed. + * @return The readable string. Must be g_free'd when no longer needed. */ guchar *gaim_quotedp_decode(const char *str, gsize *ret_len);