luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 11:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add GChecksum public API.

Browse Source 
2007-12-04  Emmanuele Bassi  <ebassi@gnome.org>

	* glib/glib-sections.txt: Add GChecksum public API.

	* glib/tmpl/checksum.sgml:
	* glib/glib-docs.sgml: Add the checksums API page.

svn path=/trunk/; revision=6044
This commit is contained in:
Emmanuele Bassi 2007-12-04 16:34:00 +00:00 committed by Emmanuele Bassi
parent d013d46b98
commit d0bca4a65a
4 changed files with 153 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/ChangeLog
View File

@ -1,3 +1,10 @@
2007-12-04 Emmanuele Bassi <ebassi@gnome.org>
* glib/glib-sections.txt: Add GChecksum public API.
* glib/tmpl/checksum.sgml:
* glib/glib-docs.sgml: Add the checksums API page.
2007-11-29 Behdad Esfahbod <behdad@gnome.org>
Bug 500361 – Improve docs for g_array_free() and g_ptr_array_free()

2
docs/reference/glib/glib-docs.sgml
View File

@ -60,6 +60,7 @@
<!ENTITY glib-Keyfile SYSTEM "xml/keyfile.xml">
<!ENTITY glib-Bookmarkfile SYSTEM "xml/bookmarkfile.xml">
<!ENTITY glib-Base64 SYSTEM "xml/base64.xml">
<!ENTITY glib-Checksum SYSTEM "xml/checksum.xml">
<!ENTITY glib-i18n SYSTEM "xml/i18n.xml">
<!ENTITY glib-Regex SYSTEM "xml/gregex.xml">
<!ENTITY glib-Version SYSTEM "xml/version.xml">
@ -142,6 +143,7 @@ synchronize their operation.
&glib-Character-Set-Conversion;
&glib-Unicode-Manipulation;
&glib-Base64;
&glib-Checksum;
&glib-i18n;
&glib-Date-and-Time-Functions;
&glib-Random-Numbers;

16
docs/reference/glib/glib-sections.txt
View File

@ -2518,3 +2518,19 @@ g_uri_get_scheme
g_uri_unescape_segment
g_uri_unescape_string
</SECTION>
<SECTION>
<TITLE>Data Checksums</TITLE>
<FILE>checksum</FILE>
GChecksumType
GChecksum
g_checksum_new
g_checksum_copy
g_checksum_free
g_checksum_update
g_checksum_get_string
g_checksum_get_digest
<SUBSECTION>
g_compute_checksum_for_data
g_compute_checksum_for_string
</SECTION>

128
docs/reference/glib/tmpl/checksum.sgml Normal file
View File

@ -0,0 +1,128 @@
<!-- ##### SECTION Title ##### -->
Data Checksums
<!-- ##### SECTION Short_Description ##### -->
Computes the checksum for data
<!-- ##### SECTION Long_Description ##### -->
<para>
GLib provides a generic API for computing checksums (or "digests") for a
sequence of arbitrary bytes, using various hashing algorithms like MD5,
SHA-1 and SHA-256. Checksums are commonly used in various environments and
specifications.
</para>
<para>
GLib supports incremental checksums using the GChecksum data structure, by
calling g_checksum_update() as long as there's data available and then using
g_checksum_get_string() or g_checksum_get_digest() to compute the checksum
and return it either as a string in hexadecimal form, or as a raw sequence
of bytes. To compute the checksum for binary blobs and NUL-terminated strings
in one go, use the convenience functions g_compute_checksum_for_data() and
g_compute_checksum_for_string(), respectively.
</para>
<para>
Support for checksums has been added in GLib 2.16
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GChecksumType ##### -->
<para>
</para>
@G_CHECKSUM_MD5:
@G_CHECKSUM_SHA1:
@G_CHECKSUM_SHA256:
<!-- ##### STRUCT GChecksum ##### -->
<para>
</para>
<!-- ##### FUNCTION g_checksum_new ##### -->
<para>
</para>
@checksum_type:
@Returns:
<!-- ##### FUNCTION g_checksum_copy ##### -->
<para>
</para>
@checksum:
@Returns:
<!-- ##### FUNCTION g_checksum_free ##### -->
<para>
</para>
@checksum:
<!-- ##### FUNCTION g_checksum_update ##### -->
<para>
</para>
@checksum:
@data:
@length:
<!-- ##### FUNCTION g_checksum_get_string ##### -->
<para>
</para>
@checksum:
@Returns:
<!-- ##### FUNCTION g_checksum_get_digest ##### -->
<para>
</para>
@checksum:
@digest:
@digest_len:
<!-- ##### FUNCTION g_compute_checksum_for_data ##### -->
<para>
</para>
@checksum_type:
@data:
@length:
@Returns:
<!-- ##### FUNCTION g_compute_checksum_for_string ##### -->
<para>
</para>
@checksum_type:
@str:
@length:
@Returns: