Changeset 2822

Show
Ignore:
Timestamp:
06/06/06 00:14:42
Author:
chipx86
Message:

Add some gtk-doc documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/libnotify

    • Property svn:ignore changed from ABOUT-NLS Doxyfile Makefile.in Makefile aclocal.m4 autom4te*.cache confdefs.h config.cache config.guess config.h config.h.in config.log config.status config.sub configure depcomp install-sh intl libnotify.pc libnotify.spec libtool ltconfig ltmain.sh m4 missing mkinstalldirs stamp-h stamp-h1 stamp-h.in tags .todo.* .*.swp .*.swo *.patch *.diff *.tar.gz to ABOUT-NLS Doxyfile Makefile.in Makefile aclocal.m4 autom4te*.cache confdefs.h config.cache config.guess config.h config.h.in config.log config.status config.sub configure depcomp gtk-doc.make install-sh intl libnotify.pc libnotify.spec libtool ltconfig ltmain.sh m4 missing mkinstalldirs stamp-h stamp-h1 stamp-h.in tags .todo.* .*.swp .*.swo *.patch *.diff *.tar.gz

  • trunk/libnotify/ChangeLog

    r2821 r2822  
     1Tue Jun 06 00:14:00 PDT 2006  Christian Hammond <chipx86@chipx86.com> 
     2 
     3    A docs/reference/libnotify-docs.sgml: 
     4    A docs/reference/libnotify-overrides.txt: 
     5    A docs/reference/libnotify-sections.txt: 
     6    A docs/reference/tmpl: 
     7    A docs/reference/tmpl/libnotify-docs.sgml: 
     8    A docs/reference/tmpl/libnotify-unused.sgml: 
     9    A docs/reference/tmpl/notification.sgml: 
     10    A docs/reference/tmpl/notify.sgml: 
     11    A docs/reference/Makefile.am: 
     12    A docs/Makefile.am: 
     13    * libnotify/notification.c: 
     14    * libnotify/notification.h: 
     15    * libnotify/notify.c: 
     16    D Doxyfile.in: 
     17    * Makefile.am: 
     18    * autogen.sh: 
     19    * configure.ac: 
     20      - Add some gtk-doc documentation. 
     21 
    122Sun Jun 04 17:44:27 PDT 2006  Christian Hammond <chipx86@chipx86.com> 
    223 

  • trunk/libnotify/Makefile.am

    r2286 r2822  
    1 SUBDIRS = libnotify tools tests 
     1SUBDIRS = libnotify docs tools tests 
    22 
    33pcdata_DATA = libnotify.pc 
    …… 
    2323    @echo "Running doxygen..." 
    2424    @doxygen Doxyfile 
     25 
     26DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc 

  • trunk/libnotify/autogen.sh

    r2286 r2822  
    3232} 
    3333 
     34(gtkdocize --version) < /dev/null > /dev/null 2>&1 || { 
     35    echo 
     36    echo "You must have gtkdocize installed to compile $PACKAGE." 
     37    echo "Download the appropriate package for your distribution," 
     38    echo "or get the source tarball at ftp://ftp.gnome.org/pub/gnome/sources/gtk-doc" 
     39} 
     40 
    3441[ $DIE -eq 1 ] && exit 1; 
    3542 
    …… 
    3845echo "  aclocal $ACLOCAL_FLAGS" 
    3946aclocal $ACLOCAL_FLAGS 
     47echo "  gtkdocize" 
     48gtkdocize 
    4049echo "  autoheader" 
    4150autoheader 

  • trunk/libnotify/configure.ac

    r2819 r2822  
    2121 
    2222if test "x$LIBGALAGO_DEVEL_VERSION" != "x0"; then 
    23     if test "x$LIBGALAGO_MICRO_VERSION" = "x0"; then 
    24         LIBGALAGO_MICRO_VERSION=$LIBGALAGO_DEVEL_VERSION 
    25         LIBGALAGO_VERSION=$LIBGALAGO_MAJOR_VERSION.$LIBGALAGO_MINOR_VERSION.$LIBGALAGO_DEVEL_VERSION 
    26     else 
    27         LIBGALAGO_VERSION=$LIBGALAGO_VERSION.$LIBGALAGO_DEVEL_VERSION 
    28     fi 
     23    LIBGALAGO_VERSION=$LIBGALAGO_VERSION.$LIBGALAGO_DEVEL_VERSION 
    2924fi 
    3025 
    …… 
    115110AC_DEFINE_UNQUOTED(DBUS_API_SUBJECT_TO_CHANGE, ,DBUS API is subject to change) 
    116111 
     112 
     113dnl ################################################################ 
     114dnl # Set up gtk-doc 
     115dnl ################################################################ 
     116GTK_DOC_CHECK([1.4]) 
     117 
     118 
    117119dnl # Use wall if we have GCC 
    118120if test "x$GCC" = "xyes"; then 
    …… 
    126128dnl ################################################################ 
    127129AC_CONFIG_FILES([ 
    128 Doxyfile 
    129130Makefile 
     131docs/Makefile 
     132docs/reference/Makefile 
    130133libnotify.pc 
    131134libnotify/Makefile 
    …… 
    143146echo "Then su to root and type: make install" 
    144147echo 
    145  

  • trunk/libnotify/docs

    • Property svn:ignore set to Makefile Makefile.in *.dvi *.out *.log *.txt *.ps *.pdf *.aux .*.swp

  • trunk/libnotify/libnotify/notification.c

    r2821 r2822  
    461461#endif 
    462462 
     463/** 
     464 * notify_notification_new: 
     465 * @summary: The required summary text. 
     466 * @body: The optional body text. 
     467 * @icon: The optional icon theme icon name or filename. 
     468 * @attach: The optional widget to attach to. 
     469 * 
     470 * Creates a new #NotifyNotification. The summary text is required, but 
     471 * all other parameters are optional. 
     472 * 
     473 * Returns: The new #NotifyNotification. 
     474 */ 
    463475NotifyNotification * 
    464476notify_notification_new(const gchar *summary, const gchar *body, 
    …… 
    476488 
    477489#ifdef HAVE_STATUS_ICON 
     490/** 
     491 * notify_notification_new_with_status_icon: 
     492 * @summary: The required summary text. 
     493 * @body: The optional body text. 
     494 * @icon: The optional icon theme icon name or filename. 
     495 * @status_icon: The required #GtkStatusIcon. 
     496 * 
     497 * Creates a new #NotifyNotification and attaches to a #GtkStatusIcon. 
     498 * The summary text and @status_icon is required, but all other parameters 
     499 * are optional. 
     500 * 
     501 * Returns: The new #NotifyNotification. 
     502 * 
     503 * Since: 0.4.1 
     504 */ 
    478505NotifyNotification * 
    479506notify_notification_new_with_status_icon(const gchar *summary, 
    …… 
    482509                                         GtkStatusIcon *status_icon) 
    483510{ 
    484     g_return_val_if_fail(status_icon == NULL || GTK_IS_STATUS_ICON(status_icon), NULL); 
     511    g_return_val_if_fail(status_icon == NULL, NULL); 
     512    g_return_val_if_fail(GTK_IS_STATUS_ICON(status_icon), NULL); 
    485513 
    486514    return g_object_new(NOTIFY_TYPE_NOTIFICATION, 
    …… 
    493521#endif /* HAVE_STATUS_ICON */ 
    494522 
     523/** 
     524 * notify_notification_update: 
     525 * @notification: The notification to update. 
     526 * @summary: The new required summary text. 
     527 * @body: The optional body text. 
     528 * @icon: The optional icon theme icon name or filename. 
     529 * 
     530 * Updates the notification text and icon. This won't send the update out 
     531 * and display it on the screen. For that, you will need to call 
     532 * notify_notification_show(). 
     533 * 
     534 * Returns: %TRUE, unless an invalid parameter was passed. 
     535 */ 
    495536gboolean 
    496537notify_notification_update(NotifyNotification *notification, 
    …… 
    530571} 
    531572 
     573/** 
     574 * notify_notification_attach_to_widget: 
     575 * @notification: The notification. 
     576 * @attach: The widget to attach to, or %NULL. 
     577 * 
     578 * Attaches the notification to a widget. This will set hints on the 
     579 * notification requesting that the notification point to the widget's 
     580 * location. If @attach is %NULL, the widget will be unset. 
     581 */ 
    532582void 
    533583notify_notification_attach_to_widget(NotifyNotification *notification, 
    …… 
    549599 
    550600#ifdef HAVE_STATUS_ICON 
     601/** 
     602 * notify_notification_attach_to_status_icon: 
     603 * @notification: The notification. 
     604 * @status_icon: The #GtkStatusIcon to attach to, or %NULL. 
     605 * 
     606 * Attaches the notification to a #GtkStatusIcon. This will set hints on the 
     607 * notification requesting that the notification point to the status icon's 
     608 * location. If @status_icon is %NULL, the status icon will be unset. 
     609 * 
     610 * Since: 0.4.1 
     611 */ 
    551612void 
    552613notify_notification_attach_to_status_icon(NotifyNotification *notification, 
    …… 
    592653    notify_notification_set_hint_int32(notification, "x", rect->x); 
    593654    notify_notification_set_hint_int32(notification, "y", rect->y); 
    594     notify_notification_set_hint_int32(notification, "width", rect->width); 
    595     notify_notification_set_hint_int32(notification, "height", rect->height); 
    596655 
    597656    display_name = gdk_screen_make_display_name(screen); 

  • trunk/libnotify/libnotify/notification.h

    r2821 r2822  
    8585 
    8686NotifyNotification *notify_notification_new(const gchar *summary, 
    87                                             const gchar *message, 
     87                                            const gchar *body, 
    8888                                            const gchar *icon, 
    8989                                            GtkWidget *attach); 
    9090#if GTK_CHECK_VERSION(2, 9, 2) 
    9191NotifyNotification *notify_notification_new_with_status_icon( 
    92     const gchar *summary, const gchar *message, 
     92    const gchar *summary, const gchar *body, 
    9393    const gchar *icon, GtkStatusIcon *status_icon); 
    9494#endif 
    …… 
    9696gboolean notify_notification_update(NotifyNotification *notification, 
    9797                                    const gchar *summary, 
    98                                     const gchar *message, 
     98                                    const gchar *body, 
    9999                                    const gchar *icon); 
    100100 

  • trunk/libnotify/libnotify/notify.c

    r2820 r2822  
    4040#endif 
    4141 
     42/** 
     43 * notify_init: 
     44 * @app_name: The name of the application initializing libnotify. 
     45 * 
     46 * Initialized libnotify. This must be called before any other functions. 
     47 * 
     48 * Returns: %TRUE if successful, or %FALSE on error. 
     49 */ 
    4250gboolean 
    4351notify_init(const char *app_name) 
    …… 
    8997} 
    9098 
     99/** 
     100 * notify_get_app_name: 
     101 * 
     102 * Gets the application name registered. 
     103 * 
     104 * Returns: The registered application name, passed to notify_init(). 
     105 */ 
    91106const gchar * 
    92107notify_get_app_name(void) 
    …… 
    95110} 
    96111 
     112/** 
     113 * notify_uninit: 
     114 * 
     115 * Uninitialized libnotify. 
     116 * 
     117 * This should be called when the program no longer needs libnotify for 
     118 * the rest of its lifecycle, typically just before exitting. 
     119 */ 
    97120void 
    98121notify_uninit(void) 
    …… 
    120143} 
    121144 
     145/** 
     146 * notify_is_initted: 
     147 * 
     148 * Gets whether or not libnotify is initialized. 
     149 * 
     150 * Returns: %TRUE if libnotify is initialized, or %FALSE otherwise. 
     151 */ 
    122152gboolean 
    123153notify_is_initted(void) 
    …… 
    138168} 
    139169 
     170/** 
     171 * notify_get_server_caps: 
     172 * 
     173 * Queries the server for its capabilities and returns them in a #GList. 
     174 * 
     175 * Returns: A #GList of server capability strings. 
     176 */ 
    140177GList * 
    141178notify_get_server_caps(void) 
    …… 
    167204} 
    168205 
     206/** 
     207 * notify_get_server_info: 
     208 * @ret_name: The resulting server name. 
     209 * @ret_vendor: The resulting server vendor. 
     210 * @ret_version: The resulting server version. 
     211 * @ret_spec_version: The resulting version of the specification the server is 
     212 *                    compliant with. 
     213 * 
     214 * Queries the server for its information, specifically, the name, vendor, 
     215 * server version, and the version of the notifications specification that it 
     216 * is compliant with. 
     217 * 
     218 * Returns: %TRUE if successful, and the variables passed will be set. %FALSE 
     219 *          on failure. 
     220 */ 
    169221gboolean 
    170222notify_get_server_info(char **ret_name, char **ret_vendor,