Added inline documentation.
[platform/upstream/glib.git] / docs / reference / glib / glib-sections.txt
index f0ceaa8..763ad51 100644 (file)
@@ -1,4 +1,3 @@
-
 <INCLUDE>glib.h</INCLUDE>
 
 <SECTION>
@@ -41,12 +40,8 @@ gsize
 gssize
 
 <SUBSECTION Private>
+gstring
 gldouble
-
-# I don't really know where to put these.
-G_HAVE_WCHAR_H
-G_HAVE_WCTYPE_H
-GUTILS_C_VAR
 </SECTION>
 
 <SECTION>
@@ -54,14 +49,17 @@ GUTILS_C_VAR
 <FILE>limits</FILE>
 G_MININT
 G_MAXINT
+G_MAXUINT
 
 <SUBSECTION>
 G_MINSHORT
 G_MAXSHORT
+G_MAXUSHORT
 
 <SUBSECTION>
 G_MINLONG
 G_MAXLONG
+G_MAXULONG
 
 <SUBSECTION>
 G_MINFLOAT
@@ -80,6 +78,11 @@ GLIB_MINOR_VERSION
 GLIB_MICRO_VERSION
 
 <SUBSECTION>
+G_OS_WIN32
+G_OS_BEOS
+G_OS_UNIX
+
+<SUBSECTION>
 GLIB_CHECK_VERSION
 
 <SUBSECTION>
@@ -107,6 +110,13 @@ CLAMP
 G_STRUCT_MEMBER
 G_STRUCT_MEMBER_P
 G_STRUCT_OFFSET
+
+<SUBSECTION Private>
+glib_major_version
+glib_micro_version
+glib_minor_version
+glib_interface_age
+glib_binary_age
 </SECTION>
 
 <SECTION>
@@ -217,6 +227,26 @@ GUINT64_SWAP_LE_BE_X86
 </SECTION>
 
 <SECTION>
+<TITLE>Numerical Definitions</TITLE>
+<FILE>numerical</FILE>
+G_IEEE754_FLOAT_BIAS
+G_IEEE754_DOUBLE_BIAS
+GFloatIEEE754
+GDoubleIEEE754
+
+<SUBSECTION>
+<SUBSECTION>
+G_E
+G_LN2
+G_LN10
+G_PI
+G_PI_2
+G_PI_4
+G_SQRT2
+G_LOG_2_BASE_10
+</SECTION>
+
+<SECTION>
 <TITLE>Miscellaneous Macros</TITLE>
 <FILE>macros_misc</FILE>
 G_INLINE_FUNC
@@ -226,13 +256,24 @@ G_STMT_START
 G_STMT_END
 
 <SUBSECTION>
+G_BEGIN_DECLS
+G_END_DECLS
+
+<SUBSECTION>
+G_N_ELEMENTS
+
+<SUBSECTION>
 G_VA_COPY
 
 <SUBSECTION>
+G_STRINGIFY
+
+<SUBSECTION>
 G_GNUC_EXTENSION
 G_GNUC_CONST
 G_GNUC_NORETURN
 G_GNUC_UNUSED
+G_GNUC_PURE
 G_GNUC_PRINTF
 G_GNUC_SCANF
 G_GNUC_FORMAT
@@ -240,9 +281,19 @@ G_GNUC_FUNCTION
 G_GNUC_PRETTY_FUNCTION
 
 <SUBSECTION>
-g_string
+G_STRLOC
+
+<SUBSECTION>
+G_GINT16_FORMAT
+G_GUINT16_FORMAT
+G_GINT32_FORMAT
+G_GUINT32_FORMAT
+G_GINT64_FORMAT
+G_GUINT64_FORMAT
 
 <SUBSECTION Private>
+GLIB_VAR
+G_STRINGIFY_ARG
 G_HAVE_INLINE
 G_CAN_INLINE
 inline
@@ -251,6 +302,20 @@ G_HAVE___INLINE__
 </SECTION>
 
 <SECTION>
+<TITLE>Error Reporting</TITLE>
+<FILE>error_reporting</FILE>
+GError
+g_error_new
+g_error_new_literal
+g_error_free
+g_error_copy
+g_error_matches
+g_set_error
+g_propagate_error
+g_clear_error
+</SECTION>
+
+<SECTION>
 <TITLE>The Main Event Loop</TITLE>
 <FILE>main</FILE>
 GMainLoop
@@ -286,6 +351,7 @@ g_main_remove_poll
 
 <SUBSECTION>
 g_main_set_poll_func
+g_main_win32_get_poll_func
 GPollFunc
 
 <SUBSECTION>
@@ -298,6 +364,8 @@ g_source_remove_by_user_data
 
 <SUBSECTION Private>
 GLIB_HAVE_SYS_POLL_H
+GLIB_HAVE_ALLOCA_H
+alloca
 GLIB_SYSDEF_POLLERR
 GLIB_SYSDEF_POLLHUP
 GLIB_SYSDEF_POLLIN
@@ -315,15 +383,29 @@ G_WIN32_MSG_HANDLE
 G_THREADS_ENABLED
 G_THREADS_IMPL_POSIX
 G_THREADS_IMPL_SOLARIS
-G_THREADS_IMPL_NSPR
 G_THREADS_IMPL_NONE
 
 <SUBSECTION>
+G_THREAD_ERROR
+GThreadError
+
+<SUBSECTION>
 GThreadFunctions
 g_thread_init
 g_thread_supported
 
 <SUBSECTION>
+GThreadFunc
+GThreadPriority
+GThread
+g_thread_create
+g_thread_self
+g_thread_join
+g_thread_set_priority
+g_thread_yield
+g_thread_exit
+
+<SUBSECTION>
 GMutex
 g_mutex_new
 g_mutex_lock
@@ -348,6 +430,26 @@ G_TRYLOCK
 G_UNLOCK
 
 <SUBSECTION>
+GStaticRecMutex
+G_STATIC_REC_MUTEX_INIT
+g_static_rec_mutex_lock
+g_static_rec_mutex_trylock
+g_static_rec_mutex_unlock
+g_static_rec_mutex_lock_full
+g_static_rec_mutex_unlock_full
+
+<SUBSECTION>
+GStaticRWLock
+G_STATIC_RW_LOCK_INIT
+g_static_rw_lock_reader_lock
+g_static_rw_lock_reader_trylock
+g_static_rw_lock_reader_unlock
+g_static_rw_lock_writer_lock
+g_static_rw_lock_writer_trylock
+g_static_rw_lock_writer_unlock
+g_static_rw_lock_free
+
+<SUBSECTION>
 GCond
 g_cond_new
 g_cond_signal
@@ -366,14 +468,67 @@ g_private_set
 GStaticPrivate
 G_STATIC_PRIVATE_INIT
 g_static_private_get
+g_static_private_get_for_thread
 g_static_private_set
+g_static_private_set_for_thread
 
 <SUBSECTION Private>
+G_THREAD_ECF
 G_THREAD_CF
 G_THREAD_UF
 g_static_mutex_get_mutex_impl
+g_mutex_lock_with_debug_name
+g_mutex_trylock_with_debug_name
+g_mutex_unlock_with_debug_name
+G_MUTEX_DEBUG_MAGIC
+g_thread_init_with_errorcheck_mutexes
 G_LOCK_NAME
 glib_dummy_decl
+GSystemThread
+g_thread_error_quark
+g_thread_use_default_impl
+g_threads_got_initialized
+g_thread_functions_for_glib_use
+</SECTION>
+
+<SECTION>
+<TITLE>Thread Pools</TITLE>
+<FILE>thread_pools</FILE>
+GThreadPool
+g_thread_pool_new
+g_thread_pool_push
+g_thread_pool_set_max_threads
+g_thread_pool_get_max_threads
+g_thread_pool_get_num_threads
+g_thread_pool_unprocessed
+g_thread_pool_free
+g_thread_pool_set_max_unused_threads
+g_thread_pool_get_max_unused_threads
+g_thread_pool_get_num_unused_threads
+g_thread_pool_stop_unused_threads
+</SECTION>
+
+<SECTION>
+<TITLE>Asynchronous Queues</TITLE>
+<FILE>async_queues</FILE>
+GAsyncQueue
+g_async_queue_new
+g_async_queue_lock
+g_async_queue_unlock
+g_async_queue_ref
+g_async_queue_ref_unlocked
+g_async_queue_unref
+g_async_queue_unref_and_unlock
+g_async_queue_push
+g_async_queue_push_unlocked
+g_async_queue_pop
+g_async_queue_pop_unlocked
+g_async_queue_try_pop
+g_async_queue_try_pop_unlocked
+g_async_queue_timed_pop
+g_async_queue_timed_pop_unlocked
+g_async_queue_length
+g_async_queue_length_unlocked
 </SECTION>
 
 <SECTION>
@@ -410,14 +565,12 @@ GIOFunc
 GIOFuncs
 
 <SUBSECTION Private>
+g_io_channel_win32_new_fd
 g_io_channel_win32_new_messages
-g_io_channel_win32_new_pipe
-g_io_channel_win32_new_pipe_with_wakeups
 g_io_channel_win32_new_stream_socket
-
+g_io_channel_win32_poll
+g_io_channel_win32_make_pollfd
 g_io_channel_win32_get_fd
-g_io_channel_win32_pipe_readable
-g_io_channel_win32_pipe_request_wakeups
 </SECTION>
 
 <SECTION>
@@ -436,6 +589,9 @@ g_realloc
 g_free
 
 <SUBSECTION>
+g_alloca
+
+<SUBSECTION>
 g_memmove
 g_memdup
 
@@ -459,6 +615,8 @@ g_set_printerr_handler
 <SUBSECTION>
 g_return_if_fail
 g_return_val_if_fail
+g_return_if_reached
+g_return_val_if_reached
 
 <SUBSECTION>
 g_assert
@@ -488,6 +646,7 @@ g_log
 g_logv
 g_message
 g_warning
+g_critical
 g_error
 
 <SUBSECTION>
@@ -525,6 +684,10 @@ g_strndup
 g_strnfill
 
 <SUBSECTION>
+g_strlcpy
+g_strlcat
+
+<SUBSECTION>
 g_strdup_printf
 g_strdup_vprintf
 g_snprintf
@@ -552,6 +715,8 @@ g_strstrip
 g_strdelimit
 G_STR_DELIMITERS
 g_strescape
+g_strcompress
+g_strcanon
 g_strsplit
 g_strfreev
 g_strconcat
@@ -566,62 +731,80 @@ g_strsignal
 <SECTION>
 <TITLE>Date and Time Functions</TITLE>
 <FILE>date</FILE>
+G_USEC_PER_SEC
 GTimeVal
 g_get_current_time
+g_usleep
 
 <SUBSECTION>
-GTime
 GDate
+GTime
 GDateDMY
 GDateDay
 GDateMonth
-GDateWeekday
 GDateYear
+GDateWeekday
+
+<SUBSECTION>
 G_DATE_BAD_DAY
 G_DATE_BAD_JULIAN
 G_DATE_BAD_YEAR
+
+<SUBSECTION>
+g_date_new
+g_date_new_dmy
+g_date_new_julian
+g_date_clear
+g_date_free
+
+<SUBSECTION>
+g_date_set_day
+g_date_set_month
+g_date_set_year
+g_date_set_dmy
+g_date_set_julian
+g_date_set_time
+g_date_set_parse
+
+<SUBSECTION>
 g_date_add_days
+g_date_subtract_days
 g_date_add_months
+g_date_subtract_months
 g_date_add_years
-g_date_clear
+g_date_subtract_years
 g_date_compare
+
+<SUBSECTION>
 g_date_day
+g_date_month
+g_date_year
+g_date_julian
+g_date_weekday
 g_date_day_of_year
+
+<SUBSECTION>
 g_date_days_in_month
-g_date_free
 g_date_is_first_of_month
 g_date_is_last_of_month
 g_date_is_leap_year
-g_date_julian
 g_date_monday_week_of_year
 g_date_monday_weeks_in_year
-g_date_month
-g_date_new
-g_date_new_dmy
-g_date_new_julian
-g_date_set_day
-g_date_set_dmy
-g_date_set_julian
-g_date_set_month
-g_date_set_parse
-g_date_set_time
-g_date_set_year
-g_date_strftime
-g_date_subtract_days
-g_date_subtract_months
-g_date_subtract_years
 g_date_sunday_week_of_year
 g_date_sunday_weeks_in_year
+
+<SUBSECTION>
+g_date_strftime
 g_date_to_struct_tm
+
+<SUBSECTION>
 g_date_valid
 g_date_valid_day
+g_date_valid_month
+g_date_valid_year
 g_date_valid_dmy
 g_date_valid_julian
-g_date_valid_month
 g_date_valid_weekday
-g_date_valid_year
-g_date_weekday
-g_date_year
 </SECTION>
 
 <SECTION>
@@ -700,6 +883,10 @@ g_basename
 g_dirname
 g_path_is_absolute
 g_path_skip_root
+g_path_get_dirname
+g_path_get_basename
+g_filename_to_utf8
+g_filename_from_utf8
 
 <SUBSECTION>
 g_bit_nth_lsf
@@ -776,6 +963,7 @@ GTokenValue
 GErrorType
 G_CSET_a_2_z
 G_CSET_A_2_Z
+G_CSET_DIGITS
 G_CSET_LATINC
 G_CSET_LATINS
 
@@ -788,6 +976,7 @@ g_scanner_foreach_symbol
 <SECTION>
 <TITLE>Dynamic Loading of Modules</TITLE>
 <FILE>modules</FILE>
+<INCLUDE>gmodule.h</INCLUDE>
 GModule
 g_module_supported
 g_module_build_path
@@ -823,30 +1012,22 @@ g_completion_free
 <FILE>windows</FILE>
 MAXPATHLEN
 NAME_MAX
-getcwd
-getpid
 pid_t
-access
-open
-read
-write
-lseek
-close
 pipe
-popen
-pclose
-fdopen
 ftruncate
 opendir
 readdir
 rewinddir
 closedir
 
+g_win32_error_message
+g_win32_getlocale
+
 <SUBSECTION Private>
-gwin_ftruncate
-gwin_closedir
-gwin_opendir
-gwin_rewinddir
+g_win32_ftruncate
+g_win32_closedir
+g_win32_opendir
+g_win32_rewinddir
 
 </SECTION>
 
@@ -895,6 +1076,7 @@ g_list_insert
 g_list_insert_sorted
 g_list_remove
 g_list_remove_link
+g_list_delete_link
 g_list_free
 
 <SUBSECTION>
@@ -925,8 +1107,8 @@ g_list_position
 g_list_index
 
 <SUBSECTION>
-g_list_pop_allocator
 g_list_push_allocator
+g_list_pop_allocator
 </SECTION>
 
 <SECTION>
@@ -939,9 +1121,11 @@ g_slist_alloc
 g_slist_append
 g_slist_prepend
 g_slist_insert
+g_slist_insert_before
 g_slist_insert_sorted
 g_slist_remove
 g_slist_remove_link
+g_slist_delete_link
 g_slist_free
 g_slist_free_1
 
@@ -966,8 +1150,39 @@ g_slist_position
 g_slist_index
 
 <SUBSECTION>
-g_slist_pop_allocator
 g_slist_push_allocator
+g_slist_pop_allocator
+</SECTION>
+
+<SECTION>
+<TITLE>Double-ended Queues</TITLE>
+<FILE>queue</FILE>
+
+GQueue
+g_queue_new
+g_queue_free
+g_queue_push_head
+g_queue_push_tail
+g_queue_pop_head
+g_queue_pop_tail
+g_queue_is_empty
+g_queue_peek_head
+g_queue_peek_tail
+g_queue_push_head_link
+g_queue_push_tail_link
+g_queue_pop_head_link
+g_queue_pop_tail_link
+</SECTION>
+
+<SECTION>
+<TITLE>Trash Stacks</TITLE>
+<FILE>trash_stack</FILE>
+GTrashStack
+
+g_trash_stack_push
+g_trash_stack_pop
+g_trash_stack_peek
+g_trash_stack_height
 </SECTION>
 
 <SECTION>
@@ -1011,10 +1226,13 @@ g_string_sprintf
 g_string_sprintfa
 g_string_append
 g_string_append_c
+g_string_append_len
 g_string_prepend
 g_string_prepend_c
+g_string_prepend_len
 g_string_insert
 g_string_insert_c
+g_string_insert_len
 g_string_erase
 g_string_truncate
 g_string_free
@@ -1023,6 +1241,10 @@ g_string_free
 g_string_up
 g_string_down
 
+<SUBSECTION>
+g_string_hash
+g_string_equal
+
 </SECTION>
 
 <SECTION>
@@ -1041,6 +1263,7 @@ g_string_chunk_free
 <FILE>arrays</FILE>
 GArray
 g_array_new
+g_array_sized_new
 g_array_append_val
 g_array_append_vals
 g_array_prepend_val
@@ -1059,6 +1282,7 @@ g_array_free
 <FILE>arrays_pointer</FILE>
 GPtrArray
 g_ptr_array_new
+g_ptr_array_sized_new
 g_ptr_array_add
 g_ptr_array_remove
 g_ptr_array_remove_index
@@ -1075,6 +1299,7 @@ g_ptr_array_free
 <FILE>arrays_byte</FILE>
 GByteArray
 g_byte_array_new
+g_byte_array_sized_new
 g_byte_array_append
 g_byte_array_prepend
 g_byte_array_remove_index
@@ -1094,7 +1319,6 @@ g_tree_nnodes
 g_tree_height
 g_tree_lookup
 g_tree_search
-GSearchFunc
 g_tree_traverse
 GTraverseFunc
 GTraverseType
@@ -1107,10 +1331,12 @@ g_tree_destroy
 <FILE>trees-nary</FILE>
 GNode
 g_node_new
+g_node_copy
 
 <SUBSECTION>
 g_node_insert
 g_node_insert_before
+g_node_insert_after
 g_node_append
 g_node_prepend
 
@@ -1156,8 +1382,8 @@ g_node_unlink
 g_node_destroy
 
 <SUBSECTION>
-g_node_pop_allocator
 g_node_push_allocator
+g_node_pop_allocator
 </SECTION>
 
 
@@ -1275,3 +1501,79 @@ G_ALLOCATOR_LIST
 G_ALLOCATOR_NODE
 G_ALLOCATOR_SLIST
 </SECTION>
+
+<SECTION>
+<TITLE>Random Numbers</TITLE>
+<FILE>random_numbers</FILE>
+GRand
+g_rand_new_with_seed
+g_rand_new
+g_rand_free
+g_rand_set_seed
+g_rand_int
+g_rand_int_range
+g_rand_double
+g_rand_double_range
+g_random_set_seed
+g_random_int
+g_random_int_range
+g_random_double
+g_random_double_range
+</SECTION>
+
+<SECTION>
+<TITLE>Unicode Manipulation</TITLE>
+<FILE>unicode</FILE>
+gunichar
+gunichar2
+
+<SUBSECTION>
+g_get_charset
+
+<SUBSECTION>
+g_unichar_isalnum
+g_unichar_isalpha
+g_unichar_iscntrl
+g_unichar_isdigit
+g_unichar_isgraph
+g_unichar_islower
+g_unichar_isprint
+g_unichar_ispunct
+g_unichar_isspace
+g_unichar_isupper
+g_unichar_isxdigit
+g_unichar_istitle
+g_unichar_isdefined
+g_unichar_iswide
+g_unichar_toupper
+g_unichar_tolower
+g_unichar_totitle
+g_unichar_digit_value
+g_unichar_xdigit_value
+GUnicodeType
+g_unichar_type
+g_unicode_canonical_ordering
+g_unicode_canonical_decomposition
+
+<SUBSECTION>
+g_utf8_next_char
+g_utf8_get_char
+g_utf8_offset_to_pointer
+g_utf8_pointer_to_offset
+g_utf8_prev_char
+g_utf8_find_next_char
+g_utf8_find_prev_char
+g_utf8_strlen
+g_utf8_strncpy
+g_utf8_strchr
+g_utf8_strrchr
+
+<SUBSECTION>
+g_utf8_to_utf16
+g_utf8_to_ucs4
+g_utf16_to_ucs4
+g_utf16_to_utf8
+g_ucs4_to_utf16
+g_ucs4_to_utf8
+g_unichar_to_utf8
+</SECTION>