1_03_GLib库入门与实践_GLib库帮助文档简介

GLib官方帮助文档可以从GNOME官网在线预览，也可以从源码目录获取。
源码目录下的glib-2.56.4/docs/reference/glib/html为全部的帮助文档， 此文档使用gtk-doc生成。里面有一个inde.html，是为索引页，通过索引页可以很方便地跳转到其他页面。

GLib库索引页帮助文档简介

打开index.html，可以看到GLib的帮助文档包括以下9部分，其中核心应用支持、工具集和数据类型是最重要的三部分。

• GLib Overview // 概览
• GLib Fundamentals // 基础
• GLib Core Application Support // 核心应用支持
• GLib Utilities // 工具集
• GLib Data Types // 数据类型
• Deprecated APIs // 已废弃接口
• GLib Tools // 附属工具
• Index // 索引
• Annotation Glossary // 注释术语表

下面是GLib文档各部分包含的子项，后续会选择其中的部分章节详细展开。

GLib Overview // 概览
    Compiling the GLib package //编译GLib库
    Cross-compiling the GLib package // 交叉编译GLib库
    Writing GLib Applications // 编写引用GLib库的程序
    Compiling GLib Applications // 编译引用GLib库的程序
    Running GLib Applications // 运行引用GLib库的程序
    Changes to GLib // GLib库版本兼容性问题
    Mailing lists and bug reports // 邮件列表和错误报告

GLib Fundamentals  // 基础
    Version Information // GLib版本
    Basic Types // 可移植的一些基本类型
    Standard Macros // 常用的宏
    Type Conversion Macros // 类型转换宏
    Byte Order Macros // 字节序转换宏
    Bounds-checking integer arithmetic // 带溢出检查功能的整型运算
    Numerical Definitions // 数学常数定义
    Miscellaneous Macros // 常用的宏
    Atomic Operations // 原子操作

GLib Core Application Support  // 核心应用支持
    The Main Event Loop // 主循环
    Threads // 线程
    Thread Pools // 线程池
    Asynchronous Queues // 异步队列
    Dynamic Loading of Modules // 可移植的动态链接库加载
    Memory Allocation // 内存分配
    Memory Slices // 内存切片
    IO Channels // IO通道
    Error Reporting // 错误系统
    Warnings and Assertions // 告警和断言
    Message Output and Debugging Functions // 日志和调试

GLib Utilities  // 工具集
    String Utility Functions // 字符串处理函数
    Character Set Conversion // 字符集转换函数
    Unicode Manipulation // Unicode相关函数
    Base64 Encoding // Base64编解码
    Data Checksums // 数据校验和
    Secure HMAC Digests // HMAC校验
    Internationalization // 国际化
    Date and Time Functions // 日期和时间函数
    GTimeZone // 时区
    GDateTime // 时间和日期
    Random Numbers // 随机数生成器
    Hook Functions // 钩子函数
    Miscellaneous Utility Functions // 多种通用工具
    Lexical Scanner // 词法扫描器
    Timers // 计时器
    Spawning Processes // 进程创建
    File Utilities // 文件操作
    URI Functions // URI操作
    Hostname Utilities // Hostname相关函数
    Shell-related Utilities // shell相关的命令行解析
    Commandline option parser // 命令行解析器
    Glob-style pattern matching // Glob样式通配符匹配器
    Perl-compatible regular expressions // PCRE正则表达式
    Regular expression syntax // 正则表达式语法（无代码）
    Simple XML Subset Parser //XML解析器
    Key-value file parser // Key-Value风格文件解析器（类似于ini文件）
    Bookmark file parser // 书签解析器
    Testing // GLib测试框架
    UNIX-specific utilities and integration // Unix专有的管道和信号
    Windows Compatibility Functions // 跨平台兼容性函数
    GUuid // 随机UUID生成器

GLib Data Types  // 数据类型
    Doubly-Linked Lists // 双向链表
    Singly-Linked Lists //  单向链表
    Double-ended Queues // 双端队列
    Sequences // 序列
    Trash Stacks // 已分配未使用内存管理器
    Hash Tables // 哈希表
    Strings // 字符串对象
    String Chunks // 字符串块
    Arrays // 普通数组
    Pointer Arrays // 指针数组
    Byte Arrays // 字节数组
    Balanced Binary Trees // 平衡二叉树
    N-ary Trees // N维树
    Quarks // 夸克
    Keyed Data Lists // 键值列表
    Datasets // 数据集
    GVariantType // 泛型系统
    GVariant // 泛型
    GVariant Format Strings // 泛型格式字符串
    GVariant Text Format // 泛型文本格式

Deprecated APIs  // 已废弃接口
    Deprecated thread API // 已废弃的线程接口
    Caches // 缓存
    Relations and Tuples // 关系和元组
    Automatic String Completion // 字符串自动补齐

GLib Tools  // 附属工具
    glib-gettextize // 国际化
    gtester // 测试框架相关
    gtester-report // 测试报告相关

Index  // 索引
Annotation Glossary  // 注释术语表

功能模块帮助文档简介

索引页的每一项都是一个超链接，该链接指向各具体功能模块帮助文档页面。一个功能模块帮助文档大概分为以下几小节：

• 函数列表
• 数据类型和宏定义
• 需包含头文件
• 功能描述
• 函数功能用法

函数列表一节罗列了本模块的所有外部函数，凡是在这里列举出的函数均可被外部调用。数据类型和宏定义一节描述了本模块数据组织形式及定义的一些宏，如链表节点、队列元素等。需包含头文件一节指如果想使用本功能，则需要引用该头文件，不过实际使用时，只需要引用<glib.h>即可。功能描述一节讲解了本节提供的功能介绍，本功能模块提供哪些方法，如何使用等。函数功能用法一节对函数列表中的各函数进行了一一详解，包括函数功能描述，各参数介绍，返回值介绍。