39 lines
1.2 KiB
Plaintext
39 lines
1.2 KiB
Plaintext
/// ***************************************************************************
|
|
/// @mainpage MicroIRC library
|
|
///
|
|
/// Simple and lightweight IRC protocol helper
|
|
///
|
|
/// # Getting started
|
|
/// The core functionality of the library is in the assembers and tokenizers
|
|
///
|
|
/// ## Tokenizers
|
|
/// - \ref uirc_tokenizer_message
|
|
/// - \ref uirc_tokenizer_user
|
|
/// - \ref uirc_tokenizer_tag
|
|
/// - \ref uirc_tokenizer_tag_list
|
|
///
|
|
/// ## Assemblers
|
|
/// - \ref uirc_assembler_message
|
|
/// - \ref uirc_assembler_user
|
|
/// - \ref uirc_assembler_tag
|
|
/// - \ref uirc_assembler_tag_list
|
|
///
|
|
/// # Going deeper
|
|
/// This library manages memory mostly by itself but still requires you to
|
|
/// clean up after it. Here are the memory management functions
|
|
///
|
|
/// ## Struct memory management
|
|
/// - \ref uirc_struct_free
|
|
/// - \ref uirc_struct_assm_message
|
|
/// - \ref uirc_struct_assm_user
|
|
/// - \ref uirc_struct_assm_tag
|
|
/// - \ref uirc_struct_assm_capability
|
|
/// - \ref uirc_struct_assm_buffer
|
|
/// - \ref uirc_struct_assm_network
|
|
///
|
|
/// ## List memory management
|
|
/// - \ref uirc_list_append
|
|
/// - \ref uirc_list_free
|
|
///
|
|
/// ***************************************************************************
|