Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions devel-docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ EXTRA_DIST = \
$(DOC_OVERRIDES)

DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
$(srcdir)/sgml.stamp $(srcdir)/html.stamp

SCANOBJ_FILES = \
$(DOC_MODULE).args \
Expand Down Expand Up @@ -104,19 +104,19 @@ scan-build.stamp: $(HFILE_GLOB)
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@true

#### templates ####

tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
@echo '*** Rebuilding template files ***'
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
touch tmpl-build.stamp

tmpl.stamp: tmpl-build.stamp
@true
# #### templates ####
#
# tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
# @echo '*** Rebuilding template files ***'
# cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
# touch tmpl-build.stamp
#
# tmpl.stamp: tmpl-build.stamp
# @true

#### sgml ####

sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(wildcard $(srcdir)/tmpl/*.sgml)
sgml-build.stamp: $(CFILE_GLOB) $(wildcard $(srcdir)/tmpl/*.sgml)
@echo '*** Building XML ***'
cd $(srcdir) && \
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(MKDB_OPTIONS)
Expand All @@ -133,7 +133,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@echo '-- Fixing Crossreferences'
cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
cd $(srcdir) && gtkdoc-fixxref --module=libenca --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
touch html-build.stamp
endif

Expand Down
24 changes: 12 additions & 12 deletions devel-docs/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ EXTRA_DIST = \
$(DOC_OVERRIDES)

DOC_STAMPS = scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
$(srcdir)/sgml.stamp $(srcdir)/html.stamp

SCANOBJ_FILES = \
$(DOC_MODULE).args \
Expand Down Expand Up @@ -575,19 +575,19 @@ uninstall-am: uninstall-local
@ENABLE_GTK_DOC_TRUE@$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@ENABLE_GTK_DOC_TRUE@ @true

#### templates ####

@ENABLE_GTK_DOC_TRUE@tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
@ENABLE_GTK_DOC_TRUE@ @echo '*** Rebuilding template files ***'
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
@ENABLE_GTK_DOC_TRUE@ touch tmpl-build.stamp

@ENABLE_GTK_DOC_TRUE@tmpl.stamp: tmpl-build.stamp
@ENABLE_GTK_DOC_TRUE@ @true
# #### templates ####
#
# tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
# @echo '*** Rebuilding template files ***'
# cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
# touch tmpl-build.stamp
#
# tmpl.stamp: tmpl-build.stamp
# @true

#### sgml ####

@ENABLE_GTK_DOC_TRUE@sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(wildcard $(srcdir)/tmpl/*.sgml)
@ENABLE_GTK_DOC_TRUE@sgml-build.stamp: $(CFILE_GLOB) $(wildcard $(srcdir)/tmpl/*.sgml)
@ENABLE_GTK_DOC_TRUE@ @echo '*** Building XML ***'
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && \
@ENABLE_GTK_DOC_TRUE@ gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(MKDB_OPTIONS)
Expand All @@ -604,7 +604,7 @@ uninstall-am: uninstall-local
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
@ENABLE_GTK_DOC_TRUE@ test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@ENABLE_GTK_DOC_TRUE@ @echo '-- Fixing Crossreferences'
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-fixxref --module=libenca --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
@ENABLE_GTK_DOC_TRUE@ touch html-build.stamp

##############
Expand Down
8 changes: 4 additions & 4 deletions devel-docs/html/ch01.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Enca Library API: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="up" href="index.html" title="Enca Library Reference Manual">
<link rel="prev" href="index.html" title="Enca Library Reference Manual">
<link rel="next" href="libenca-Analyser.html" title="Analyser">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Expand All @@ -33,11 +33,11 @@
<span class="refentrytitle"><a href="libenca-Charsets-and-Surfaces.html">Charsets and Surfaces</a></span><span class="refpurpose"> — Functions and macros for getting something sensible from <span class="type">EncaEncoding</span>.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span>
<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary Functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span>
</dt>
</dl></div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
Binary file modified devel-docs/html/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions devel-docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Enca Library Reference Manual: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="next" href="ch01.html" title="Enca Library API">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Expand All @@ -28,12 +28,12 @@
<span class="refentrytitle"><a href="libenca-Charsets-and-Surfaces.html">Charsets and Surfaces</a></span><span class="refpurpose"> — Functions and macros for getting something sensible from <span class="type">EncaEncoding</span>.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span>
<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary Functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span>
</dt>
</dl></dd>
</dl></div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
Binary file modified devel-docs/html/left-insensitive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified devel-docs/html/left.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 28 additions & 45 deletions devel-docs/html/libenca-Analyser.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Analyser: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="up" href="ch01.html" title="Enca Library API">
<link rel="prev" href="ch01.html" title="Enca Library API">
<link rel="next" href="libenca-Typedefs-and-Constants.html" title="Typedefs and Constants">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Expand All @@ -33,20 +33,14 @@ <h2><span class="refentrytitle"><a name="libenca-Analyser.top_of_page"></a>Analy
</tr></table></div>
<div class="refsect1">
<a name="libenca-Analyser.description"></a><h2>Description</h2>
<p>
Basically you want to allocate an analyser with <code class="function">enca_analyser_alloc()</code> for some
<p>Basically you want to allocate an analyser with <code class="function">enca_analyser_alloc()</code> for some
language, use <code class="function">enca_analyse()</code> (or <code class="function">enca_analyse_const()</code>) on a buffer to find its
encoding, and interpret the results with something like <code class="function">enca_charset_name()</code>.
The analyser then can be used for another buffer. Once you no longer need
it, call <code class="function">enca_analyser_free()</code> to release it.
</p>
<p>
A single working example is better than a hundred pages of reference manual.
</p>
<div class="example">
<a name="id-1.2.2.3.4"></a><p class="title"><b>Example 1. A minimal Enca library application – Czech encoding
detector.</b></p>
<div class="example-contents">
A single working example is better than a hundred pages of reference manual.</p>
<p>A minimal Enca library application – Czech encoding detector.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
Expand All @@ -66,50 +60,39 @@ <h2><span class="refentrytitle"><a name="libenca-Analyser.top_of_page"></a>Analy
14
15
16
17</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include &lt;stdio.h&gt;</span>
<span class="gtkdoc ppc">#include &lt;enca.h&gt;</span>
<span class="gtkdoc kwb">int</span>
<span class="function">main</span><span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
EncaAnalyser analyser<span class="gtkdoc opt">;</span>
EncaEncoding encoding<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">unsigned char</span> buffer<span class="gtkdoc opt">[</span><span class="number">4096</span><span class="gtkdoc opt">];</span>
<span class="gtkdoc kwb">size_t</span> buflen<span class="gtkdoc opt">;</span>
buflen <span class="gtkdoc opt">=</span> <span class="function">fread</span><span class="gtkdoc opt">(</span>buffer<span class="gtkdoc opt">,</span> <span class="number">1</span><span class="gtkdoc opt">,</span> <span class="number">4096</span><span class="gtkdoc opt">,</span> stdin<span class="gtkdoc opt">);</span>
analyser <span class="gtkdoc opt">=</span> <span class="function">enca_analyser_alloc</span><span class="gtkdoc opt">(</span><span class="string">&quot;cs&quot;</span><span class="gtkdoc opt">);</span>
encoding <span class="gtkdoc opt">=</span> <span class="function">enca_analyse</span><span class="gtkdoc opt">(</span>analyser<span class="gtkdoc opt">,</span> buffer<span class="gtkdoc opt">,</span> buflen<span class="gtkdoc opt">);</span>
<span class="function">printf</span><span class="gtkdoc opt">(</span><span class="string">&quot;Charset: %%s</span><span class="gtkdoc esc">\n</span><span class="string">&quot;</span><span class="gtkdoc opt">,</span> <span class="function">enca_charset_name</span><span class="gtkdoc opt">(</span>encoding<span class="gtkdoc opt">.</span>charset<span class="gtkdoc opt">,</span>
ENCA_NAME_STYLE_HUMAN<span class="gtkdoc opt">));</span>
<span class="function">enca_analyser_free</span><span class="gtkdoc opt">(</span>analyser<span class="gtkdoc opt">);</span>
<span class="keyword">return</span> <span class="number">0</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span></pre></td>
17
18</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdio.h&gt;</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;enca.h&gt;</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">EncaAnalyser</span><span class="w"> </span><span class="n">analyser</span><span class="p">;</span>
<span class="n">EncaEncoding</span><span class="w"> </span><span class="n">encoding</span><span class="p">;</span>
<span class="kt">unsigned</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">buffer</span><span class="p">[</span><span class="mi">4096</span><span class="p">];</span>
<span class="kt">size_t</span><span class="w"> </span><span class="n">buflen</span><span class="p">;</span>

<span class="n">buflen</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fread</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">4096</span><span class="p">,</span><span class="w"> </span><span class="n">stdin</span><span class="p">);</span>
<span class="n">analyser</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">enca_analyser_alloc</span><span class="p">(</span><span class="s">&quot;cs&quot;</span><span class="p">);</span>
<span class="n">encoding</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">enca_analyse</span><span class="p">(</span><span class="n">analyser</span><span class="p">,</span><span class="w"> </span><span class="n">buffer</span><span class="p">,</span><span class="w"> </span><span class="n">buflen</span><span class="p">);</span>
<span class="n">printf</span><span class="p">(</span><span class="s">&quot;Charset: %s</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">enca_charset_name</span><span class="p">(</span><span class="n">encoding</span><span class="p">.</span><span class="n">charset</span><span class="p">,</span>
<span class="w"> </span><span class="n">ENCA_NAME_STYLE_HUMAN</span><span class="p">));</span>
<span class="n">enca_analyser_free</span><span class="p">(</span><span class="n">analyser</span><span class="p">);</span>

<span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="p">}</span></pre></td>
</tr>
</tbody>
</table>
</div>

</div>
<br class="example-break"><p>
The analyser has plenty of options, but generally you don't need to fiddle
with them, except <code class="function">enca_set_termination_strictness()</code>.
</p>
<p>
All names prefixed with <code class="function">ENCA_</code>,
<code class="function">Enca</code>, <code class="function">_Enca</code>,
or <code class="function">enca_</code> should be treated as reserved and not used for
application function/variable/type/macro names.
</p>
<p></p>
</div>
<div class="refsect1">
<a name="libenca-Analyser.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="libenca-Analyser.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
17 changes: 6 additions & 11 deletions devel-docs/html/libenca-Auxiliary-Functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Auxiliary functions: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<title>Auxiliary Functions: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="up" href="ch01.html" title="Enca Library API">
<link rel="prev" href="libenca-Charsets-and-Surfaces.html" title="Charsets and Surfaces">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Expand All @@ -25,25 +25,20 @@
<a name="libenca-Auxiliary-Functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libenca-Auxiliary-Functions.top_of_page"></a>Auxiliary functions</span></h2>
<p>Auxiliary functions — Variouis auxiliary functions and informations about libenca.</p>
<h2><span class="refentrytitle"><a name="libenca-Auxiliary-Functions.top_of_page"></a>Auxiliary Functions</span></h2>
<p>Auxiliary Functions — Variouis auxiliary functions and informations about libenca.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libenca-Auxiliary-Functions.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libenca-Auxiliary-Functions.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="libenca-Auxiliary-Functions.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
13 changes: 4 additions & 9 deletions devel-docs/html/libenca-Charsets-and-Surfaces.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Charsets and Surfaces: Enca Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="up" href="ch01.html" title="Enca Library API">
<link rel="prev" href="libenca-Typedefs-and-Constants.html" title="Typedefs and Constants">
<link rel="next" href="libenca-Auxiliary-Functions.html" title="Auxiliary functions">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="next" href="libenca-Auxiliary-Functions.html" title="Auxiliary Functions">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Expand All @@ -33,18 +33,13 @@ <h2><span class="refentrytitle"><a name="libenca-Charsets-and-Surfaces.top_of_pa
</tr></table></div>
<div class="refsect1">
<a name="libenca-Charsets-and-Surfaces.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libenca-Charsets-and-Surfaces.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="libenca-Charsets-and-Surfaces.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
Loading
Loading