From: P. F. Chimento Date: Tue, 19 Apr 2011 15:49:52 +0000 (+0200) Subject: Document all incomplete symbols X-Git-Tag: v0.9~106 X-Git-Url: https://git.stderr.nl/gitweb?a=commitdiff_plain;h=ccdf27a4b419d4819545905b4a782b2f967a4fa8;p=projects%2Fchimara%2Fchimara.git Document all incomplete symbols Documentation is now fully complete! --- diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c index 04d2687..69a0a8d 100644 --- a/libchimara/chimara-glk.c +++ b/libchimara/chimara-glk.c @@ -813,7 +813,7 @@ chimara_glk_class_init(ChimaraGlkClass *klass) _chimara_marshal_VOID__UINT_STRING, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); /** - * ChimaraGlk::iliad-update-screen: + * ChimaraGlk::iliad-screen-update: * @self: The widget that received the signal * @typing: Whether to perform a typing or full screen update * diff --git a/libchimara/doc.c b/libchimara/doc.c index 3c04ce3..8a6c1ae 100644 --- a/libchimara/doc.c +++ b/libchimara/doc.c @@ -1140,6 +1140,8 @@ * @short_description: Converting from timestamps to date structures and back * @include: libchimara/glk.h * + * This section describes functions for converting timestamps to more + * human-readable date structures and back. */ /** @@ -1399,6 +1401,20 @@ * functions and data types described in this section. */ +/** + * GLK_MODULE_LINE_ECHO: + * + * If this preprocessor symbol is defined, so is glk_set_echo_line_event(). If + * not, not. + */ + +/** + * GLK_MODULE_LINE_TERMINATORS: + * + * If this preprocessor symbol is defined, so is + * glk_set_terminators_line_event(). If not, not. + */ + /** * winid_t: * @@ -2872,9 +2888,30 @@ * Margin images are not implemented yet. */ +/** + * glkdate_t: + * @year: The full (four-digit) year + * @month: The month number, ranging from 1-12, 1 is January + * @day: The day of the month, ranging from 1-31 + * @weekday: The day of the week, ranging from 0-6, 0 is Sunday + * @hour: The hour of the day, ranging from 0-23 + * @minute: The minute of the hour, ranging from 0-59 + * @second: The second of the minute, ranging from 0-59; may be 60 during a leap + * second + * @microsec: The fraction of the second in microseconds, ranging from 0-999999 + * + * This structure represents a human-readable date in a specific timezone. + */ + /** * glktimeval_t: + * @high_sec: The most significant 32 bits of the timestamp in seconds. + * @low_sec: The least significant 32 bits of the timestamp in seconds. + * @microsec: The fraction of the timestamp, in microseconds, ranging from + * 0-999999. * + * This structure represents the Unix timestamp, i.e. the number of seconds + * since January 1, 1970. */ /*---------- TYPES, FUNCTIONS AND CONSTANTS FROM GI_DISPA.H ------------------*/ @@ -2892,7 +2929,19 @@ * * Returns: Number of opaque object classes used by the library. */ - + +/** + * gidispatch_get_class: + * @index: Unique integer index of the class. + * + * Returns a structure describing an opaque class that the library exports. + * @index can range from 0 to N - + * 1N - 1, where N is the value + * returned by gidispatch_count_classes(). + * + * Returns: A #gidispatch_intconst_t structure describing the class. + */ + /** * gidispatch_count_intconst: * diff --git a/libchimara/garglk.h b/libchimara/garglk.h index 9e4d68b..91c4364 100644 --- a/libchimara/garglk.h +++ b/libchimara/garglk.h @@ -10,8 +10,7 @@ * * Chimara * Currently, in Chimara, the functions are defined, but a few of them - * (garglk_set_line_terminators(), - * garglk_unput_string(), and garglk_unput_string_uni()) are not implemented. + * (garglk_unput_string() and garglk_unput_string_uni()) are not implemented. * You can call them, but they will have no effect except to print a warning * to the console. *