gtkdoc-rebase \
gtkdoc-scan \
gtkdoc-scangobj \
- gtkdoc-scanobj \
gtkdocize
if HAVE_PYTHON
tools/gtk-doc.el \
COPYING-DOCS
+CLEANFILES = \
+ gtk-doc.flat.make \
+ gtk-doc.notmpl-flat.make
+
MAINTAINERCLEANFILES = \
+ build-aux \
$(srcdir)/INSTALL \
$(srcdir)/COPYING \
$(srcdir)/aclocal.m4 \
GITIGNOREFILES = \
RELNOTES.txt \
- ChangeLog-?.??
+ ChangeLog-?.?? \
+ gtk-doc-*.tar.xz
-include $(top_srcdir)/git.mk
$(srcdir)/gtkdoc-mkhtml.in $(srcdir)/gtkdoc-mkman.in \
$(srcdir)/gtkdoc-mkpdf.in $(srcdir)/gtkdoc-mktmpl.in \
$(srcdir)/gtkdoc-rebase.in $(srcdir)/gtkdoc-scan.in \
- $(srcdir)/gtkdoc-scangobj.in $(srcdir)/gtkdoc-scanobj.in \
- $(srcdir)/gtkdocize.in $(top_srcdir)/configure AUTHORS COPYING \
- ChangeLog INSTALL NEWS TODO build-aux/config.guess \
- build-aux/config.sub build-aux/depcomp build-aux/install-sh \
- build-aux/ltmain.sh build-aux/missing
+ $(srcdir)/gtkdoc-scangobj.in $(srcdir)/gtkdocize.in \
+ $(top_srcdir)/configure AUTHORS COPYING ChangeLog INSTALL NEWS \
+ TODO build-aux/config.guess build-aux/config.sub \
+ build-aux/depcomp build-aux/install-sh build-aux/ltmain.sh \
+ build-aux/missing
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/gtkdoc_jh_check_xml_catalog.m4 \
$(top_srcdir)/m4/gtkdoc_jh_path_xml_catalog.m4 \
gtkdoc-common.pl gtkdoc-check gtkdoc-depscan gtkdoc-fixxref \
gtkdoc-mkdb gtkdoc-mkhtml gtkdoc-mkman gtkdoc-mkpdf \
gtkdoc-mktmpl gtkdoc-rebase gtkdoc-scan gtkdoc-scangobj \
- gtkdoc-scanobj gtkdocize
+ gtkdocize
CONFIG_CLEAN_VPATH_FILES =
am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`;
am__vpath_adj = case $$p in \
SUBDIRS = help tests
bin_SCRIPTS = gtkdoc-check gtkdoc-fixxref gtkdoc-mkdb gtkdoc-mkhtml \
gtkdoc-mkman gtkdoc-mkpdf gtkdoc-mktmpl gtkdoc-rebase \
- gtkdoc-scan gtkdoc-scangobj gtkdoc-scanobj gtkdocize \
- $(am__append_1)
+ gtkdoc-scan gtkdoc-scangobj gtkdocize $(am__append_1)
gtkdocdatadir = $(datadir)/gtk-doc/data
gtkdocdata_DATA = \
gtkdoc-common.pl \
tools/gtk-doc.el \
COPYING-DOCS
+CLEANFILES = \
+ gtk-doc.flat.make \
+ gtk-doc.notmpl-flat.make
+
MAINTAINERCLEANFILES = \
+ build-aux \
$(srcdir)/INSTALL \
$(srcdir)/COPYING \
$(srcdir)/aclocal.m4 \
GITIGNOREFILES = \
RELNOTES.txt \
- ChangeLog-?.??
+ ChangeLog-?.?? \
+ gtk-doc-*.tar.xz
all: all-recursive
cd $(top_builddir) && $(SHELL) ./config.status $@
gtkdoc-scangobj: $(top_builddir)/config.status $(srcdir)/gtkdoc-scangobj.in
cd $(top_builddir) && $(SHELL) ./config.status $@
-gtkdoc-scanobj: $(top_builddir)/config.status $(srcdir)/gtkdoc-scanobj.in
- cd $(top_builddir) && $(SHELL) ./config.status $@
gtkdocize: $(top_builddir)/config.status $(srcdir)/gtkdocize.in
cd $(top_builddir) && $(SHELL) ./config.status $@
install-binSCRIPTS: $(bin_SCRIPTS)
mostlyclean-generic:
clean-generic:
+ -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
+GTK-Doc 1.21 (Jul 17 2014)
+============
+
+ Important notice - starting with the next release these long deprecated
+ features will be removed, please write to gtk-doc-list@gnome.org and tell us
+ your concerns:
+ o gtkdoc-mktmpl - please move all the comments into the sources.
+ o generating html via sgml tools (jade/openjade), using xsltproc and
+ docbook-xslt is pretty common and preferred since version 1.6
+
+ Changes
+
+ o 170860 : gtk-doc should have definitions for stability
+ o 644111 : one cannot specify against which libs gtkdoc-fixxref should resolve links (problematic with multiple versions)
+ o 657444 : " enum foo { ... } " ; not recognized
+ o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
+ o 678094 : the word " returns " in a function description can be parsed as the " Returns: " section
+ o 722621 : gtk-doc tarball was created with 32bit uid/gid, unusable with mingw/msys tar
+ o 724739 : Self-test fail: gtkdoc-mkdb misusing perl datatype
+ o 725505 : new syntax highlighting for code is weird
+ o 725663 : configure: non POSIX test usage
+ o 730658 : Deprecation warning for non-deprecated type GParamFlags
+ o 730777 : Add support for nullable and optional annotations
+
+ Contributors
+
+ Christophe Fergeau
+ Damon Chaplin
+ Daniel Macks
+ Daniel Mustieles
+ Emmanuele Bassi
+ maria thukididu
+ Naohiro Aota
+ Philip Withnall
+ Rafael Ferreira
+ Stefan Sauer
+ Thomas Wood
+ William Jon McCann
+
GTK-Doc 1.20 (Feb 16 2014)
============
* need to check if we can pass the style-sheet class as a parameter (--stringparam gtkdoc.stylesheet=(chunk|docbook))
* we might also need to reflow some things, as gtk-doc.xsl also runs the devhelp/devhelp2 generation
- but then the urls in the devhelp file, refer to the chunked html anyway
-* rtf
- ~/download/fop-0.94/fop -fo tester-docs.fo -rtf tester-docs.rtf
- * unrtf
- unrtf -t ps tester-docs.rtf >tester-docs.ps
- unrtf -t latex tester-docs.rtf >tester-docs.tex
- - bad output
-
= Warnings =
Bugzilla has some requests for extra warnings. We should support a common
from the symbol.
- possible xrefs (e.g. adding a # or () would make it a successful xref)
-
-= Markup =
-* protected scope
- * we can have /* < protected > */ in classes
- * we can have <SUBSECTION Protected> in -section.txt
- * ideally we have Scope: {Public, Protected, Private} supported in doc comments
- * there is a bg for gir, https://bugzilla.gnome.org/show_bug.cgi?id=594125
-
= GIR =
== scanning ==
* ideas
* need to get existing python/~mm docs to use it, gtk-doc could output
language=C for own docs
-== installation ==
+=== installation ===
* need to install each book with a prefix
* would be good to have a language attribute in book tag to allow filter by language
* look at /usr/share/gtk-doc/html/pygobject/index.html
-= docbook xml =
-Its tedious to write large amounts of docbook.
-
-== more macros ==
+= external processors =
We need parametric, user definable macros.
|[ ... ]| - programlistings
|macro(arg1,arg2,...)[ ... ]| - call macro
- get output on stdout or file
- and replace the macro with it
The changes could be made in gtkdoc-mkdb::ExpandAbbreviations()
-=== example macros ===
+== example macros ==
|highlight(c)[...]| - highlight source code for a specific language (c)
- what will this output? preformatted html to be xincluded?
- we could have macros for each format, the docbook xml macro would leave
|ditta(svg)[...]| - parse ascii art and include result as mediaobject (in svg format)
- we need to generate a filename for the image or use anoter parameter
-=== where to define macros ===
+== where to define macros ==
* system wide and with the package, <prefix>/share/gtk-doc/macros, $(srcdir)
* prefix for custom macros?
* we could require stdin for input and stdout for output, the wrapper for the
actual tool can ensure the convention
-== asciidoc as a frontend ==
-Can we offer integration with asciidoc (http://www.methods.co.nz/asciidoc/)?
-This way the master document could be written much easier. It would be cool if
-we could use the asciidoc markup in source-comments also.
-
-== extract other bits and pieces ==
-=== library api ==
-gtkdoc-scan could be obsoleted and gtkdoc-mkdb would build docbook fragemnts for
-api docs and their indexes
-=== DBUs Interfaces ===
-http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html
-http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus
-=== GConf schemas ===
-
-=== Wiki imports ===
-
-
= styling =
-== source code examples==
-http://bugzilla.gnome.org/show_bug.cgi?id=536928
-We could also run a postprocessing script in gtkdoc-mkhtml/gtkdoc-fixxref
-
-tools:
- source-highlight (/usr/bin/source-highlight)
- source-highlight -itests/gobject/examples/gobject.c -o$HOME/temp/gobject.html -n -t4 -sc
- source-highlight -itests/gobject/examples/gobject.c -o$HOME/temp/gobject.html -n -t4 -sc -cstyle.css --no-doc
- source-highlight -itests/gobject/examples/gobject.c -o$HOME/temp/gobject.xml -n -t4 -sc -f docbook
-
- highlight -itests/gobject/examples/gobject.c -o$HOME/temp/gobject.xml -l -X -f -j2
-
-some tips about styling code listings in html
-http://www.tjkdesign.com/articles/how_to_style_a_code_listing.asp
-
-=== process docbook ===
-if we highlight to docbook, we just get emphasis (bold)
=== process html ===
if we highlight to html we get colors, we need to check what tags we should process though:
<pre class="programlisting"> is used for all code boxes.
could we do that using javascript and some other magic?
-= syntax =
+= Markup =
+== tags ==
+* to document the api-life cycle we have: since, deprecated and stability:
+* other things we might want to specify:
+ * multi-threading safety: mt-safe, use-with-lock <lock>
+
+== protected scope ==
+* we can have /* < protected > */ in classes
+* we can have <SUBSECTION Protected> in -section.txt
+* ideally we have Scope: {Public, Protected, Private} supported in doc comments
+* there is a bug for gir, https://bugzilla.gnome.org/show_bug.cgi?id=594125
+
== wildcards in symbol names ==
-Somtimes one defines a set of function and macros with very simillar purpose, e.g.
+Sometimes one defines a set of function and macros with very similar purpose, e.g.
READ_INT8, READ_INT16, READ_INT32. It would be great to allow documenting a symbol
READ_INT* instead of 3 docs which are copy'n'pasted anyway. In the output we will have
all matching declarations in one source listing. Multiple wildcards are okay.
* structure
* docbook markup (part/chapter structure)
* structure
- Sugested structure for api-docs.
+ Suggested structure for api-docs.
Idea is to have more content that api reference. It would be good to have a
gnome-platform document in devhelp, so that we could xref that instead of
explaining 100 times how to use pkg-config.
#! /bin/sh
# Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.68 for gtk-doc 1.20.
+# Generated by GNU Autoconf 2.68 for gtk-doc 1.21.
#
# Report bugs to <http://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc>.
#
# Identity of this package.
PACKAGE_NAME='gtk-doc'
PACKAGE_TARNAME='gtk-doc'
-PACKAGE_VERSION='1.20'
-PACKAGE_STRING='gtk-doc 1.20'
+PACKAGE_VERSION='1.21'
+PACKAGE_STRING='gtk-doc 1.21'
PACKAGE_BUGREPORT='http://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc'
PACKAGE_URL=''
# Omit some internal or obsolete options to make the list less imposing.
# This message is too long to be a string in the A/UX 3.1 sh.
cat <<_ACEOF
-\`configure' configures gtk-doc 1.20 to adapt to many kinds of systems.
+\`configure' configures gtk-doc 1.21 to adapt to many kinds of systems.
Usage: $0 [OPTION]... [VAR=VALUE]...
if test -n "$ac_init_help"; then
case $ac_init_help in
- short | recursive ) echo "Configuration of gtk-doc 1.20:";;
+ short | recursive ) echo "Configuration of gtk-doc 1.21:";;
esac
cat <<\_ACEOF
test -n "$ac_init_help" && exit $ac_status
if $ac_init_version; then
cat <<\_ACEOF
-gtk-doc configure 1.20
+gtk-doc configure 1.21
generated by GNU Autoconf 2.68
Copyright (C) 2010 Free Software Foundation, Inc.
This file contains any messages produced by compilers while
running configure, to aid debugging if configure makes a mistake.
-It was created by gtk-doc $as_me 1.20, which was
+It was created by gtk-doc $as_me 1.21, which was
generated by GNU Autoconf 2.68. Invocation command line was
$ $0 $@
# Define the identity of the package.
PACKAGE='gtk-doc'
- VERSION='1.20'
+ VERSION='1.21'
cat >>confdefs.h <<_ACEOF
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether date can output nanoseconds" >&5
$as_echo_n "checking whether date can output nanoseconds... " >&6; }
-date +%s.%N | grep -q '%N'
-if test "$?" == "1"; then
+date +%s.%N | grep -q 'N'
+if test "$?" = "1"; then
TS_FMT="+%s.%N"
ELAPSED_FMT="+%H:%M:%S.%N"
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether date can format dates" >&5
$as_echo_n "checking whether date can format dates... " >&6; }
date >/dev/null 2>&1 --utc --date @1.1 $ELAPSED_FMT
-if test "$?" == "0"; then
+if test "$?" = "0"; then
DATE_FMT_CMD="date --utc $ELAPSED_FMT --date @0"
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5
$as_echo "yes" >&6; }
ac_config_files="$ac_config_files gtkdoc-scangobj"
-ac_config_files="$ac_config_files gtkdoc-scanobj"
-
ac_config_files="$ac_config_files gtkdocize"
ac_config_files="$ac_config_files tests/tools.sh"
# report actual input values of CONFIG_FILES etc. instead of their
# values after options handling.
ac_log="
-This file was extended by gtk-doc $as_me 1.20, which was
+This file was extended by gtk-doc $as_me 1.21, which was
generated by GNU Autoconf 2.68. Invocation command line was
CONFIG_FILES = $CONFIG_FILES
cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
ac_cs_version="\\
-gtk-doc config.status 1.20
+gtk-doc config.status 1.21
configured by $0, generated by GNU Autoconf 2.68,
with options \\"\$ac_cs_config\\"
"gtkdoc-rebase") CONFIG_FILES="$CONFIG_FILES gtkdoc-rebase" ;;
"gtkdoc-scan") CONFIG_FILES="$CONFIG_FILES gtkdoc-scan" ;;
"gtkdoc-scangobj") CONFIG_FILES="$CONFIG_FILES gtkdoc-scangobj" ;;
- "gtkdoc-scanobj") CONFIG_FILES="$CONFIG_FILES gtkdoc-scanobj" ;;
"gtkdocize") CONFIG_FILES="$CONFIG_FILES gtkdocize" ;;
"tests/tools.sh") CONFIG_FILES="$CONFIG_FILES tests/tools.sh" ;;
"gtkdoc-rebase":F) chmod +x gtkdoc-rebase ;;
"gtkdoc-scan":F) chmod +x gtkdoc-scan ;;
"gtkdoc-scangobj":F) chmod +x gtkdoc-scangobj ;;
- "gtkdoc-scanobj":F) chmod +x gtkdoc-scanobj ;;
"gtkdocize":F) chmod +x gtkdocize ;;
"tests/tools.sh":F) chmod +x tests/tools.sh ;;
dnl Makefile can only cope with that, i.e. use 1.1, 1.2, 1.3 ... 9.9.
dnl FIXME: I can't see anything failing (1.14.1), lets try to use a three digit
dnl number for the development version
-m4_define(gtk_doc_version, 1.20)
+m4_define(gtk_doc_version, 1.21)
AC_INIT([gtk-doc],[gtk_doc_version],[http://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc],[gtk-doc])
AC_SUBST(TRACE)
dnl check what date format we can use for the makefile tracing in tests
+dnl this is mostly to detect the date command on macosx that is quite cripled
+dnl and broken too
AC_MSG_CHECKING(whether date can output nanoseconds)
-date +%s.%N | grep -q '%N'
-if test "$?" == "1"; then
+date +%s.%N | grep -q 'N'
+if test "$?" = "1"; then
TS_FMT="+%s.%N"
ELAPSED_FMT="+%H:%M:%S.%N"
AC_MSG_RESULT(yes)
AC_MSG_CHECKING(whether date can format dates)
date >/dev/null 2>&1 --utc --date @1.1 $ELAPSED_FMT
-if test "$?" == "0"; then
+if test "$?" = "0"; then
DATE_FMT_CMD="date --utc $ELAPSED_FMT --date @0"
AC_MSG_RESULT(yes)
else
AC_CONFIG_FILES([gtkdoc-rebase], [chmod +x gtkdoc-rebase])
AC_CONFIG_FILES([gtkdoc-scan], [chmod +x gtkdoc-scan])
AC_CONFIG_FILES([gtkdoc-scangobj], [chmod +x gtkdoc-scangobj])
-AC_CONFIG_FILES([gtkdoc-scanobj], [chmod +x gtkdoc-scanobj])
AC_CONFIG_FILES([gtkdocize], [chmod +x gtkdocize])
AC_CONFIG_FILES([tests/tools.sh], [chmod +x tests/tools.sh])
AC_OUTPUT
Summary: GTK+ DocBook Documentation Generator
Name: gtk-doc
-Version: 1.20
+Version: 1.21
Release: 1
License: GPL
Group: Utilities/Text
<xsl:if test="$suppress.navigation = '0' and $home != .">
<table class="navigation" id="top" width="100%"
- summary = "Navigation header" cellpadding="2" cellspacing="10">
+ summary = "Navigation header" cellpadding="2" cellspacing="5">
<tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<!--<xsl:if test="name()='refentry'"-->
<xsl:when test="count($refsections) > 0">
<a href="#" class="shortcut">Top</a>
<xsl:if test="count($sect_desc) > 0">
- <span id="nav_description"> <span class="dim">|</span> 
+ <span id="nav_description">  <span class="dim">|</span> 
<a href="#{$section_id}.description" class="shortcut">
<xsl:value-of select="./refsect1[@role='desc']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_object_hierarchy) > 0">
- <span id="nav_hierarchy"> <span class="dim">|</span> 
+ <span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#{$section_id}.object-hierarchy" class="shortcut">
<xsl:value-of select="./refsect1[@role='object_hierarchy']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_impl_interfaces) > 0">
- <span id="nav_interfaces"> <span class="dim">|</span> 
+ <span id="nav_interfaces">  <span class="dim">|</span> 
<a href="#{$section_id}.implemented-interfaces" class="shortcut">
<xsl:value-of select="./refsect1[@role='impl_interfaces']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_prerequisites) > 0">
- <span id="nav_prerequisites"> <span class="dim">|</span> 
+ <span id="nav_prerequisites">  <span class="dim">|</span> 
<a href="#{$section_id}.prerequisites" class="shortcut">
<xsl:value-of select="./refsect1[@role='prerequisites']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_derived_interfaces) > 0">
- <span id="nav_derived_interfaces"> <span class="dim">|</span> 
+ <span id="nav_derived_interfaces">  <span class="dim">|</span> 
<a href="#{$section_id}.derived-interfaces" class="shortcut">
<xsl:value-of select="./refsect1[@role='derived_interfaces']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_implementations) > 0">
- <span id="nav_implementations"> <span class="dim">|</span> 
+ <span id="nav_implementations">  <span class="dim">|</span> 
<a href="#{$section_id}.implementations" class="shortcut">
<xsl:value-of select="./refsect1[@role='implementations']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_properties) > 0">
- <span id="nav_properties"> <span class="dim">|</span> 
+ <span id="nav_properties">  <span class="dim">|</span> 
<a href="#{$section_id}.properties" class="shortcut">
<xsl:value-of select="./refsect1[@role='properties']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_child_properties) > 0">
- <span id="nav_child_properties"> <span class="dim">|</span> 
+ <span id="nav_child_properties">  <span class="dim">|</span> 
<a href="#{$section_id}.child-properties" class="shortcut">
<xsl:value-of select="./refsect1[@role='child_properties']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_style_properties) > 0">
- <span id="nav_style_properties"> <span class="dim">|</span> 
+ <span id="nav_style_properties">  <span class="dim">|</span> 
<a href="#{$section_id}.style-properties" class="shortcut">
<xsl:value-of select="./refsect1[@role='style_properties']/title"/>
</a></span>
</xsl:if>
<xsl:if test="count($sect_signal_proto) > 0">
- <span id="nav_signals"> <span class="dim">|</span> 
+ <span id="nav_signals">  <span class="dim">|</span> 
<a href="#{$section_id}.signals" class="shortcut">
<xsl:value-of select="./refsect1[@role='signal_proto']/title"/>
</a></span>
<span class="extralinks">
<xsl:for-each select="../ulink[@role='extralinks']">
<xsl:if test="position() = 1">[ </xsl:if>
- <xsl:if test="position() > 1"> <span class="dim">|</span> </xsl:if>
+ <xsl:if test="position() > 1">  <span class="dim">|</span> </xsl:if>
<a>
<xsl:attribute name="href"><xsl:value-of select="@url"/></xsl:attribute>
<xsl:copy-of select="text()" />
</a>
- <xsl:if test="position() = last()"> ]</xsl:if>
+ <xsl:if test="position() = last()">  ]</xsl:if>
</xsl:for-each>
</span>
</xsl:if>
# This contains all the entities and their relative URLs.
my %Links;
-# This hold the path entries we already scanned
-my @VisitedPaths;
# failing link targets we don't warn about even once
my %NoLinks = (
$dir = $dir . "/share/gtk-doc/html";
if (-d $dir && $dir ne $HTML_DIR) {
@TRACE@("Scanning GLib directory: $dir");
+
+ # Some predefined link targets to get links into type hierarchies as these
+ # have no targets. These are always absolute for now.
+ $Links{'GBoxed'} = "$dir/gobject/gobject-Boxed-Types.html";
+ $Links{'GEnum'} = "$dir/gobject/gobject-Enumeration-and-Flag-Types.html";
+ $Links{'GFlags'} = "$dir/gobject/gobject-Enumeration-and-Flag-Types.html";
+ $Links{'GInterface'} = "$dir/gobject/GTypeModule.html";
+
if ($dir !~ m%^\Q$path_prefix\E/%) {
&ScanIndices ($dir, 1);
} else {
&ScanIndices ($dir, 0);
}
- push (@VisitedPaths, $dir);
}
if (defined ($ENV{"GNOME2_PATH"})) {
} else {
&ScanIndices ($dir, 0);
}
- push (@VisitedPaths, $dir);
}
# ubuntu started to compress this as index.sgml.gz :/
# https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138
@TRACE@("Scanning HTML_DIR directory: $HTML_DIR");
&ScanIndices ($HTML_DIR, 0);
-push (@VisitedPaths, $HTML_DIR);
@TRACE@("Scanning HTML_DIR directory: $MODULE_DIR");
&ScanIndices ($MODULE_DIR, 0);
-push (@VisitedPaths, $MODULE_DIR);
# check all extra dirs, but skip already scanned dirs or subdirs of those
foreach my $dir (@EXTRA_DIRS) {
my $vdir;
- my $skip = 0;
-
- foreach $vdir (@VisitedPaths) {
- if ($dir eq $vdir || $dir =~ m%^\Q$vdir\E/%) {
- @TRACE@("Skipping EXTRA_DIR directory: $dir");
- $skip=1;
- }
- }
- next if $skip;
@TRACE@("Scanning EXTRA_DIR directory: $dir");
- push (@VisitedPaths, $dir);
# If the --extra-dir option is not relative and is not sharing the same
# prefix as the target directory of the docs, we need to use absolute
sub ScanIndices {
my ($scan_dir, $use_absolute_links) = @_;
-
+
@TRACE@("Scanning source directory: $scan_dir absolute: $use_absolute_links");
# This array holds any subdirectories found.
# Now recursively scan the subdirectories.
my $dir;
- foreach $dir (@subdirs) {
+ foreach $dir (sort(@subdirs)) {
&ScanIndices ("$scan_dir/$dir", $use_absolute_links);
}
}
$OUTPUT_FORMAT = lc($OUTPUT_FORMAT);
}
-#print "DEBUG: output-format: [$OUTPUT_FORMAT]\n";
+@TRACE@(" output-format: [$OUTPUT_FORMAT]\n");
if ($OUTPUT_FORMAT eq "xml") {
if (!$MAIN_SGML_FILE) {
# remember used annotation (to write minimal glossary)
my %AnnotationsUsed;
-# the annotations are defined at:
-# https://live.gnome.org/GObjectIntrospection/Annotations
my %AnnotationDefinition = (
- 'allow-none' => "NULL is ok, both for passing and for returning.",
+ # the GObjectIntrospection annotations are defined at:
+ # https://live.gnome.org/GObjectIntrospection/Annotations
+ 'allow-none' => "NULL is OK, both for passing and for returning.",
+ 'nullable' => "NULL may be passed as the value in, out, in-out; or as a return value.",
+ 'optional' => "NULL may be passed instead of a pointer to a location.",
'array' => "Parameter points to an array of items.",
'attribute' => "Deprecated free-form custom annotation, replaced by (attributes) annotation.",
'attributes' => "Free-form key-value pairs.",
'type' => "Override the parsed C type with given type.",
'unref-func' => "The specified function is used to unref a struct, must be a GTypeInstance.",
'virtual' => "This is the invoker for a virtual method.",
- 'value' => "The specified value overrides the evaluated value of the constant."
+ 'value' => "The specified value overrides the evaluated value of the constant.",
+ # Stability Level definition
+ # https://bugzilla.gnome.org/show_bug.cgi?id=170860
+ 'Stable' => <<EOF,
+The intention of a Stable interface is to enable arbitrary third parties to
+develop applications to these interfaces, release them, and have confidence that
+they will run on all minor releases of the product (after the one in which the
+interface was introduced, and within the same major release). Even at a major
+release, incompatible changes are expected to be rare, and to have strong
+justifications.
+EOF
+ 'Unstable' => <<EOF,
+Unstable interfaces are experimental or transitional. They are typically used to
+give outside developers early access to new or rapidly changing technology, or
+to provide an interim solution to a problem where a more general solution is
+anticipated. No claims are made about either source or binary compatibility from
+one minor release to the next.
+
+The Unstable interface level is a warning that these interfaces are subject to
+change without warning and should not be used in unbundled products.
+
+Given such caveats, customer impact need not be a factor when considering
+incompatible changes to an Unstable interface in a major or minor release.
+Nonetheless, when such changes are introduced, the changes should still be
+mentioned in the release notes for the affected release.
+EOF
+ 'Private' => <<EOF
+An interface that can be used within the GNOME stack itself, but that is not
+documented for end-users. Such functions should only be used in specified and
+documented ways.
+EOF
);
# Elements to consider non-block items in MarkDown parsing
sub OutputSGML {
my ($file) = @_;
- #print "Reading: $file\n";
+ @TRACE@("Reading: $file\n");
open (INPUT, $file)
|| die "Can't open $file: $!";
my $filename = "";
} elsif (m/^<TITLE>(.*)<\/TITLE>/) {
$title = $1;
- #print "Section: $title\n";
+ @TRACE@("Section: $title\n");
# We don't want warnings if object & class structs aren't used.
$DeclarationOutput{$title} = 1;
}
} elsif (m/^<\/SECTION>/) {
- #print "End of section: $title\n";
+ @TRACE@("End of section: $title\n");
if ($num_symbols > 0) {
# collect documents
if ($OUTPUT_FORMAT eq "xml") {
EOF
}
- $hierarchy_str = &AddTreeLineArt(\@hierarchy) . "\n";
+ $hierarchy_str = &AddTreeLineArt(\@hierarchy);
if ($hierarchy_str ne "") {
$hierarchy_str = <<EOF;
<refsect1 id="$section_id.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
-<screen>$hierarchy_str</screen>
+<screen>$hierarchy_str
+</screen>
</refsect1>
EOF
}
print (OUTPUT "$header<indexdiv>\n");
- #print "generate $basename index (".%apiindex." entries)\n";
+ @TRACE@("generate $basename index (".%apiindex." entries)\n");
# do a case insensitive sort while chopping off the prefix
foreach my $hash (
$symbol_type = lc($DeclarationTypes{$symbol});
}
if ($symbol_type eq "") {
- #print "trying symbol $symbol\n";
+ @TRACE@("trying symbol $symbol\n");
if ($symbol =~ m/(.*)::(.*)/) {
my $oname = $1;
my $osym = $2;
my $i;
- #print " trying object signal ${oname}:$osym in ".$#SignalNames." signals\n";
+ @TRACE@(" trying object signal ${oname}:$osym in ".$#SignalNames." signals\n");
for ($i = 0; $i <= $#SignalNames; $i++) {
if ($SignalNames[$i] eq $osym) {
$symbol_type = "object signal";
my $oname = $1;
my $osym = $2;
my $i;
- #print " trying object property ${oname}::$osym in ".$#ArgNames." properties\n";
+ @TRACE@(" trying object property ${oname}::$osym in ".$#ArgNames." properties\n");
for ($i = 0; $i <= $#ArgNames; $i++) {
- #print " ".$ArgNames[$i]."\n";
+ @TRACE@(" ".$ArgNames[$i]."\n");
if ($ArgNames[$i] eq $osym) {
$symbol_type = "object property";
if (defined($SymbolSection{$oname})) {
my $curletter = uc(substr($short_symbol,0,1));
my $id = $apiindex{$symbol};
- #print " add symbol $symbol with $id to index in section $curletter\n";
+ @TRACE@(" add symbol $symbol with $id to index in section $curletter\n");
if ($curletter ne $lastletter) {
$lastletter = $curletter;
my @sinces = keys %{{ map { $_ => 1 } values %Since }};
foreach my $version (@sinces) {
- #print "Since : [$version]\n";
+ @TRACE@("Since : [$version]\n");
# TODO make filtered hash
#my %index = grep { $Since{$_} eq $version } %IndexEntriesSince;
my %index = map { $_ => $IndexEntriesSince{$_} } grep { $Since{$_} eq $version } keys %IndexEntriesSince;
<title>Annotation Glossary</title>
EOF
- foreach my $annotation (sort(keys(%AnnotationsUsed))) {
+ foreach my $annotation (sort({lc $a cmp lc $b} keys(%AnnotationsUsed))) {
if(defined($AnnotationDefinition{$annotation})) {
my $def = $AnnotationDefinition{$annotation};
my $curletter = uc(substr($annotation,0,1));
my $subsection = "";
- #print "Reading: $file\n";
+ @TRACE@("Reading: $file\n");
open (INPUT, $file)
|| die "Can't open $file: $!";
$desc .= "<para role=\"since\">Since $Since{$symbol}</para>";
}
if (exists $StabilityLevel{$symbol}) {
- $desc .= "<para role=\"stability\">Stability Level: $StabilityLevel{$symbol}</para>";
+ my $stability = $StabilityLevel{$symbol};
+ $AnnotationsUsed{$stability} = 1;
+ $desc .= "<para role=\"stability\">Stability Level: <acronym>$stability</acronym></para>";
}
return $desc;
}
$desc .= &MakeDeprecationNote($symbol);
my $parameters = &OutputParamDescriptions ("MACRO", $symbol, @fields);
- my $parameters_output = 0;
if (defined ($SymbolDocs{$symbol})) {
my $symbol_docs = &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
-
- # Try to insert the parameter table at the author's desired position.
- # Otherwise we need to tag it onto the end.
- if ($symbol_docs =~ s/<!--PARAMETERS-->/$parameters/) {
- $parameters_output = 1;
- }
$desc .= $symbol_docs;
}
- if ($parameters_output == 0) {
- $desc .= $parameters;
- }
-
+ $desc .= $parameters;
$desc .= OutputSymbolTraits ($symbol);
$desc .= "</refsect2>\n";
return ($synop, $desc);
my $is_gtype = 0;
my $default_to_public = 1;
if (&CheckIsObject ($symbol)) {
- #print "Found struct gtype: $symbol\n";
+ @TRACE@("Found struct gtype: $symbol\n");
$is_gtype = 1;
$default_to_public = $ObjectRoots{$symbol} eq 'GBoxed';
}
my $decl_out = "";
if ($declaration =~ m/^\s*$/) {
- #print "Found opaque struct: $symbol\n";
+ @TRACE@("Found opaque struct: $symbol\n");
$decl_out = "typedef struct _$symbol $symbol;";
} elsif ($declaration =~ m/^\s*struct\s+\w+\s*;\s*$/) {
- #print "Found opaque struct: $symbol\n";
+ @TRACE@("Found opaque struct: $symbol\n");
$decl_out = "struct $symbol;";
} else {
my $public = $default_to_public;
my $struct_contents = $2;
foreach $decl_line (split (/\n/, $struct_contents)) {
- #print "Struct line: $decl_line\n";
+ @TRACE@("Struct line: $decl_line\n");
if ($decl_line =~ m%/\*\s*<\s*public\s*>\s*\*/%) {
$public = 1;
} elsif ($decl_line =~ m%/\*\s*<\s*(private|protected)\s*>\s*\*/%) {
my $is_gtype = 0;
if (&CheckIsObject ($symbol)) {
- #print "Found enum gtype: $symbol\n";
+ @TRACE@("Found enum gtype: $symbol\n");
$is_gtype = 1;
}
$desc .= &MakeDeprecationNote($symbol);
my $parameters = &OutputParamDescriptions ("FUNCTION", $symbol, @fields);
- my $parameters_output = 0;
if (defined ($SymbolDocs{$symbol})) {
my $symbol_docs = &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
-
- # Try to insert the parameter table at the author's desired position.
- # Otherwise we need to tag it onto the end.
- # FIXME: document that in the user manual and make it useable for other
- # types too
- if ($symbol_docs =~ s/<!--PARAMETERS-->/$parameters/) {
- $parameters_output = 1;
- }
$desc .= $symbol_docs;
}
- if ($parameters_output == 0) {
- $desc .= $parameters;
- }
-
+ $desc .= $parameters;
$desc .= OutputSymbolTraits ($symbol);
$desc .= "</refsect2>\n";
return ($synop, $desc);
if ($param_name eq "Returns") {
$returns = "$param_desc\n<para>$param_annotations</para>";
} elsif ($param_name eq "void") {
- #print "!!!! void in params for $symbol?\n";
+ # FIXME: &LogWarning()?
+ @TRACE@("!!!! void in params for $symbol?\n");
} else {
if (@fields) {
if (!defined $field_descrs{$param_name}) {
sub OutputSGMLFile {
my ($file, $title, $section_id, $includes, $functions_synop, $other_synop, $functions_details, $other_details, $signals_synop, $signals_desc, $args_synop, $args_desc, $hierarchy, $interfaces, $implementations, $prerequisites, $derived, $file_objects) = @_;
- #print "Output sgml for file $file with title '$title'\n";
+ @TRACE@("Output sgml for file $file with title '$title'\n");
# The edited title overrides the one from the sections file.
my $new_title = $SymbolDocs{"$TMPL_DIR/$file:Title"};
if (defined ($new_title) && $new_title !~ m/^\s*$/) {
$title = $new_title;
- #print "Found title: $title\n";
+ @TRACE@("Found title: $title\n");
}
my $short_desc = $SymbolDocs{"$TMPL_DIR/$file:Short_Description"};
if (!defined ($short_desc) || $short_desc =~ m/^\s*$/) {
# Don't use ConvertMarkDown here for now since we don't want blocks
$short_desc = &ExpandAbbreviations("$title:Short_description",
$short_desc);
- #print "Found short_desc: $short_desc";
+ @TRACE@("Found short_desc: $short_desc");
}
my $long_desc = $SymbolDocs{"$TMPL_DIR/$file:Long_Description"};
if (!defined ($long_desc) || $long_desc =~ m/^\s*$/) {
} else {
$long_desc = &ConvertMarkDown("$title:Long_description",
$long_desc);
- #print "Found long_desc: $long_desc";
+ @TRACE@("Found long_desc: $long_desc");
}
my $see_also = $SymbolDocs{"$TMPL_DIR/$file:See_Also"};
if (!defined ($see_also) || $see_also =~ m%^\s*(<para>)?\s*(</para>)?\s*$%) {
$see_also = "";
} else {
$see_also = &ConvertMarkDown("$title:See_Also", $see_also);
- #print "Found see_also: $see_also";
+ @TRACE@("Found see_also: $see_also");
}
if ($see_also) {
$see_also = "<refsect1 id=\"$section_id.see-also\">\n<title>See Also</title>\n$see_also\n</refsect1>\n";
$stability = "";
} else {
$stability = &ParseStabilityLevel($stability, $file, $., "Section stability level");
- #print "Found stability: $stability";
+ @TRACE@("Found stability: $stability");
}
if ($stability) {
- $stability = "<refsect1 id=\"$section_id.stability-level\">\n<title>Stability Level</title>\n$stability, unless otherwise indicated\n</refsect1>\n";
+ $AnnotationsUsed{$stability} = 1;
+ $stability = "<refsect1 id=\"$section_id.stability-level\">\n<title>Stability Level</title>\n<acronym>$stability</acronym>, unless otherwise indicated\n</refsect1>\n";
} elsif ($DEFAULT_STABILITY) {
- $stability = "<refsect1 id=\"$section_id.stability-level\">\n<title>Stability Level</title>\n$DEFAULT_STABILITY, unless otherwise indicated\n</refsect1>\n";
+ $AnnotationsUsed{$DEFAULT_STABILITY} = 1;
+ $stability = "<refsect1 id=\"$section_id.stability-level\">\n<title>Stability Level</title>\n<acronym>$DEFAULT_STABILITY</acronym>, unless otherwise indicated\n</refsect1>\n";
}
my $image = $SymbolDocs{"$TMPL_DIR/$file:Image"};
foreach my $object (@$file_objects) {
next if ($object eq $section_id);
my $id = CreateValidSGMLID($object);
- #print "Debug: Adding anchor for $object\n";
+ @TRACE@("Adding anchor for $object\n");
$object_anchors .= "<anchor id=\"$id\"$empty_element_end";
}
\&ConvertSGMLCharsCallback);
} else {
# For the simple non-sgml mode, convert to entities everywhere.
- $text =~ s/&/&/g; # Do this first, or the others get messed up.
+
+ # First, convert freestanding & to &
+ $text =~ s/&(?![a-zA-Z#]+;)/&/g;
$text =~ s/</</g;
- $text =~ s/>/>/g;
+ # Allow ">" at beginning of string for blockquote markdown
+ $text =~ s/(?<=[^\w\n"'\/-])>/>/g;
+
return $text;
}
}
return "$text";
}
- #print "Getting type link for $symbol -> $text\n";
+ @TRACE@("Getting type link for $symbol -> $text\n");
my $symbol_id = &CreateValidSGMLID ($symbol);
return "<link linkend=\"$symbol_id\">$text</link>";
my $cond = $desc;
$cond =~ s/\"/"/g;
$desc=" condition=\"".$cond."\"";
- #print "condition for '$symbol' = '$desc'\n";
+ @TRACE@("condition for '$symbol' = '$desc'\n");
}
return $desc;
}
# Walk up the hierarchy, pushing ancestors onto the ancestors array.
my @ancestors = ();
push (@ancestors, $object);
- #print "Level: $level\n";
+ @TRACE@("Level: $level\n");
while ($level > 1) {
$j--;
if ($ObjectLevels[$j] < $level) {
push (@ancestors, $Objects[$j]);
$level = $ObjectLevels[$j];
- #print "Level: $level\n";
+ @TRACE@("Level: $level\n");
}
}
my $i;
for ($i = 0; $i <= $#SignalObjects; $i++) {
if ($SignalObjects[$i] eq $object) {
- #print "Found signal: $SignalNames[$i]\n";
+ @TRACE@("Found signal: $SignalNames[$i]\n");
my $name = $SignalNames[$i];
my $symbol = "${object}::${name}";
my $id = &CreateValidSGMLID ("$object-$name");
$synop .= "<row><entry role=\"signal_type\">${ret_type_output}</entry><entry role=\"signal_name\"><link linkend=\"$id\">${name}</link></entry><entry role=\"signal_flags\">${flags_string}</entry></row>\n";
my $parameters = &OutputParamDescriptions ("SIGNAL", $symbol);
- my $parameters_output = 0;
$AllSymbols{$symbol} = 1;
if (defined ($SymbolDocs{$symbol})) {
my $symbol_docs = &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
- # Try to insert the parameter table at the author's desired
- # position. Otherwise we need to tag it onto the end.
- if ($symbol_docs =~ s/<!--PARAMETERS-->/$parameters/) {
- $parameters_output = 1;
- }
$desc .= $symbol_docs;
if (!IsEmptyDoc($SymbolDocs{$symbol})) {
}
$desc .= &MakeDeprecationNote($symbol);
- if ($parameters_output == 0) {
- $desc .= $parameters;
- }
+ $desc .= $parameters;
if ($flags_string) {
$desc .= "<para>Flags: $flags_string</para>\n";
}
my $i;
for ($i = 0; $i <= $#ArgObjects; $i++) {
if ($ArgObjects[$i] eq $object) {
- #print "Found arg: $ArgNames[$i]\n";
+ @TRACE@("Found arg: $ArgNames[$i]\n");
my $name = $ArgNames[$i];
my $flags = $ArgFlags[$i];
my $flags_string = "";
if (defined($SymbolDocs{$symbol}) &&
!IsEmptyDoc($SymbolDocs{$symbol})) {
$blurb = &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
- #print ".. [$SymbolDocs{$symbol}][$blurb]\n";
+ @TRACE@(".. [$SymbolDocs{$symbol}][$blurb]\n");
$AllDocumentedSymbols{$symbol} = 1;
}
else {
$AllDocumentedSymbols{$symbol} = 1;
} else {
# FIXME: print a warning?
- #print ".. no description\n";
+ @TRACE@(".. no description\n");
}
$blurb = "<para>" . &CreateValidSGML ($ArgBlurbs[$i]) . "</para>";
}
my $in_comment_block = 0;
my $symbol;
my $in_part = "";
- my ($description, $return_desc, $return_start, $return_style);
+ my ($description, $return_desc);
my ($since_desc, $stability_desc, $deprecated_desc);
my $current_param;
- my $ignore_broken_returns;
my @params;
while (<SRCFILE>) {
# Look for the start of a comment block.
if (m%^\s*/\*.*\*/%) {
#one-line comment - not gtkdoc
} elsif (m%^\s*/\*\*\s%) {
- #print "Found comment block start\n";
+ @TRACE@("Found comment block start\n");
$in_comment_block = 1;
$in_part = "";
$description = "";
$return_desc = "";
- $return_style = "";
$since_desc = "";
$deprecated_desc = "";
$stability_desc = "";
$current_param = -1;
- $ignore_broken_returns = 0;
@params = ();
}
next;
} else {
# Add the return value description onto the end of the params.
if ($return_desc) {
+ # TODO(ensonic): check for duplicated Return docs
+ # &LogWarning ($file, $., "Multiple Returns for $symbol.");
push (@params, "Returns");
push (@params, $return_desc);
- if ($return_style eq 'broken') {
- &LogWarning ($file, $., "Free-form return value description in $symbol. Use `Returns:' to avoid ambiguities.");
- }
}
# Convert special SGML characters
$description = &ConvertSGMLChars ($symbol, $description);
}
}
- #print "SECTION DOCS found in source for : '$real_symbol'\n";
- $ignore_broken_returns = 1;
+ @TRACE@("SECTION DOCS found in source for : '$real_symbol'\n");
for ($k = 0; $k <= $#params; $k += $PARAM_FIELD_COUNT) {
- #print " '".$params[$k]."'\n";
+ @TRACE@(" '".$params[$k]."'\n");
$params[$k] = "\L$params[$k]";
undef $key;
if ($params[$k] eq "short_description") {
$SourceSymbolSourceLine{"$TMPL_DIR/$real_symbol:Long_Description"} = $.;
#$SourceSymbolTypes{$symbol} = "SECTION";
} else {
- #print "SYMBOL DOCS found in source for : '$symbol' ",length($description), "\n";
+ @TRACE@("SYMBOL DOCS found in source for : '$symbol' ",length($description), "\n");
$SourceSymbolDocs{$symbol} = $description;
$SourceSymbolParams{$symbol} = [ @params ];
# FIXME $SourceSymbolTypes{$symbol} = "STRUCT,SIGNAL,ARG,FUNCTION,MACRO";
($since_desc, my @extra_lines) = split ("\n", $since_desc);
$since_desc =~ s/^\s+//;
$since_desc =~ s/\s+$//;
- #print "Since($symbol) : [$since_desc]\n";
+ @TRACE@("Since($symbol) : [$since_desc]\n");
$Since{$symbol} = &ConvertSGMLChars ($symbol, $since_desc);
if(scalar @extra_lines) {
&LogWarning ($file, $., "multi-line since docs found");
if (!$_) {
$_ = "\n";
}
- #print "DEBUG: scanning :$_";
+ @TRACE@("scanning :$_");
# If we haven't found the symbol name yet, look for it.
if (!$symbol) {
if (m%^\s*(SECTION:\s*\S+)%) {
$symbol = $1;
- #print "SECTION DOCS found in source for : '$symbol'\n";
- $ignore_broken_returns = 1;
+ @TRACE@("SECTION DOCS found in source for : '$symbol'\n");
} elsif (m%^\s*([\w:-]*\w)\s*:?\s*(\([-a-z0-9_ ]+\)\s*)*$%) {
$symbol = $1;
- #print "SYMBOL DOCS found in source for : '$symbol'\n";
+ @TRACE@("SYMBOL DOCS found in source for : '$symbol'\n");
}
next;
}
s%^\s*Description:%%;
}
- if (m/^\s*(returns:|return\s+value:)/i) {
- if ($return_style eq 'broken') {
- $description .= $return_start . $return_desc;
- }
- $return_start = $1;
- if ($return_style eq 'sane') {
- &LogWarning ($file, $., "Multiple Returns for $symbol.");
+ if (m%^\s*(returns|return\s+value):%i) {
+ # we're in param section and have not seen the blank line
+ if($in_part ne "") {
+ $return_desc = $';
+ $in_part = "return";
+ next;
}
- $return_style = 'sane';
- $ignore_broken_returns = 1;
- $return_desc = $';
- $in_part = "return";
- next;
- } elsif (!$ignore_broken_returns && m/^\s*(returns\b\s*)/i) {
- $return_start = $1;
- $return_style = 'broken';
- $return_desc = $';
- $in_part = "return";
- next;
} elsif (m%^\s*since:%i) {
# we're in param section and have not seen the blank line
if($in_part ne "") {
my $param_name = $1;
my $param_desc = $';
- #print "Found parameter: $param_name\n";
+ @TRACE@("Found parameter: $param_name\n");
# Allow varargs variations
if ($param_name =~ m/^\.\.\.$/) {
$param_name = "...";
}
- if ("\L$param_name" eq "returns") {
- $return_style = 'sane';
- $ignore_broken_returns = 1;
- }
@TRACE@("Found param for symbol $symbol : '$param_name'= '$_'");
push (@params, $param_name);
}
} elsif ($symbol =~ /:(Long_Description|Short_Description)/) {
$total++;
- #my $len1=(exists($SymbolDocs{$symbol}))?length($SymbolDocs{$symbol}):-1;
- #my $len2=(exists($AllDocumentedSymbols{$symbol}))?length($AllDocumentedSymbols{$symbol}):-1;
- #print "%%%% $symbol : $len1,$len2\n";
if (((exists ($SymbolDocs{$symbol})) && (length ($SymbolDocs{$symbol}) > 0))
|| ((exists ($AllDocumentedSymbols{$symbol})) && (length ($AllDocumentedSymbols{$symbol}) > 0))) {
$n_documented++;
if (scalar %SymbolDocs) {
@Symbols=keys (%SymbolDocs);
- #print "num existing entries: ".(scalar @Symbols)."\n";
- #print " ",$Symbols[0], " ",$Symbols[1],"\n";
+ @TRACE@("num existing entries: ".(scalar @Symbols)."\n");
}
else {
# filter scanned declarations, with what we suppress from -sections.txt
$tmp{$symbol}=1;
}
@Symbols = keys (%tmp);
- #print "num source entries: ".(scalar @Symbols)."\n";
+ @TRACE@("num source entries: ".(scalar @Symbols)."\n");
}
foreach $symbol (@Symbols) {
$AllSymbols{$symbol} = 1;
# anything left ?
if ($check_tmpl_doc ne "") {
$have_tmpl_docs = 1;
- #print "## [$check_tmpl_doc]\n";
} else {
# if the docs have just an empty para, don't merge that.
$check_tmpl_doc = $tmpl_doc;
if (exists ($SourceSymbolDocs{$symbol})) {
my $type = $DeclarationTypes {$symbol};
- #print "merging [$symbol] from source\n";
+ @TRACE@("merging [$symbol] from source\n");
my $item = "Parameter";
if (defined ($type)) {
$AllDocumentedSymbols{$symbol} = 1;
}
- # Convert <!--PARAMETERS--> with any blank lines around it to
- # a </para> followed by <!--PARAMETERS--> followed by <para>.
- $src_doc =~ s%\n+\s*<!--PARAMETERS-->\s*\n+%\n</para>\n<!--PARAMETERS-->\n<para>\n%g;
-
# Do not add <para> to nothing, it breaks missing docs checks.
my $src_doc_para = "";
if ($src_doc ne "") {
# so we will not change that. We only override the actual text.
my $tmpl_params = $SymbolParams{$symbol};
if (!defined ($tmpl_params)) {
- #print "No merge needed for $symbol\n";
+ @TRACE@("No merge needed for $symbol\n");
$SymbolParams{$symbol} = $SourceSymbolParams{$symbol};
# FIXME: we still like to get the number of params and merge
# 1) we would noticed that params have been removed/renamed
} else {
my $params = $SourceSymbolParams{$symbol};
my $j;
- #print "Merge needed for $symbol, tmpl_params: ",$#$tmpl_params,", source_params: ",$#$params," \n";
+ @TRACE@("Merge needed for $symbol, tmpl_params: ",$#$tmpl_params,", source_params: ",$#$params," \n");
for ($j = 0; $j <= $#$tmpl_params; $j += $PARAM_FIELD_COUNT) {
my $tmpl_param_name = $$tmpl_params[$j];
# Try to find the param in the source comment documentation.
my $found = 0;
my $k;
- #print " try merge param $tmpl_param_name\n";
+ @TRACE@(" try merge param $tmpl_param_name\n");
for ($k = 0; $k <= $#$params; $k += $PARAM_FIELD_COUNT) {
my $param_name = $$params[$k];
my $param_desc = $$params[$k + 1];
- #print " test param $param_name\n";
+ @TRACE@(" test param $param_name\n");
# We accept changes in case, since the Gnome source
# docs contain a lot of these.
if ("\L$param_name" eq "\L$tmpl_param_name") {
if(($type eq "MACRO") && ($param_name eq "Returns")) {
# FIXME: do we need to add it then to tmpl_params[] ?
my $num=$#$tmpl_params;
- #print " adding Returns: to macro docs for $symbol.\n";
+ @TRACE@(" adding Returns: to macro docs for $symbol.\n");
$$tmpl_params[$num+1]="Returns";
$$tmpl_params[$num+2]=$$params[$j+1];
next;
} else {
if ($have_tmpl_docs) {
$AllDocumentedSymbols{$symbol} = 1;
- #print "merging [$symbol] from template\n";
+ @TRACE@("merging [$symbol] from template\n");
}
else {
- #print "[$symbol] undocumented\n";
+ @TRACE@("[$symbol] undocumented\n");
}
}
$type="SIGNAL";
}
- #print "Check param docs for $symbol, tmpl_params: ",$#$tmpl_params," entries, type=$type\n";
+ @TRACE@("Check param docs for $symbol, tmpl_params: ",$#$tmpl_params," entries, type=$type\n");
if ($#$tmpl_params > 0) {
my $j;
}
}
}
- #print "num doc entries: ".(scalar %SymbolDocs)."\n";
+ @TRACE@("num doc entries: ".(scalar %SymbolDocs)."\n");
}
#############################################################################
# a heading is ended by any level less than or equal
if ($md_block->{"level"} == 1) {
if ($line =~ /^={4,}[ \t]*$/) {
- my $text = pop $md_block->{"lines"};
+ my $text = pop @{$md_block->{"lines"}};
$md_block->{"interrupted"} = 0;
push @md_blocks, $md_block;
next OUTER;
} else {
# push lines into the block until the end is reached
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
next OUTER;
}
} else {
if ($line =~ /^[=]{4,}[ \t]*$/) {
- my $text = pop $md_block->{"lines"};
+ my $text = pop @{$md_block->{"lines"}};
$md_block->{"interrupted"} = 0;
push @md_blocks, $md_block;
level => 1 };
next OUTER;
} elsif ($line =~ /^[-]{4,}[ \t]*$/) {
- my $text = pop $md_block->{"lines"};
+ my $text = pop @{$md_block->{"lines"}};
$md_block->{"interrupted"} = 0;
push @md_blocks, $md_block;
next OUTER;
} else {
# push lines into the block until the end is reached
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
next OUTER;
}
}
text => "",
lines => [] };
} else {
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
}
next OUTER;
}
if ($md_block->{"type"} eq "quote") {
if (!$md_block->{"interrupted"}) {
$line =~ s/^[ ]*>[ ]?//;
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
next OUTER;
}
} elsif ($md_block->{"type"} eq "li") {
if ($line =~ /^([ ]{0,3})($marker)[ ](.*)/) {
my $indentation = $1;
if ($md_block->{"indentation"} ne $indentation) {
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
} else {
my $lines = $3;
my $ordered = $md_block->{"ordered"};
if ($md_block->{"interrupted"}) {
if ($first_char eq " ") {
- push $md_block->{"lines"}, "";
+ push @{$md_block->{"lines"}}, "";
$line =~ s/^[ ]{0,4}//;
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
$md_block->{"interrupted"} = 0;
next OUTER;
}
} else {
$line =~ s/^[ ]{0,4}//;
- push $md_block->{"lines"}, $line;
+ push @{$md_block->{"lines"}}, $line;
next OUTER;
}
}
}
# indentation insensitive types
-
if ($line =~ /^[ ]*<!DOCTYPE/) {
push @md_blocks, $md_block;
}
if ($block->{"interrupted"}) {
- push $block->{"lines"}, "";
+ push @{$block->{"lines"}}, "";
}
$text = &MarkDownParseLines ($block->{"lines"}, $symbol, "li");
if (m/^<([^>]+)>/) {
$declaration_type = $1;
$declaration_name = "";
- #print "Found declaration: $declaration_type\n";
+ @TRACE@("Found declaration: $declaration_type\n");
$declaration = "";
}
} else {
} elsif (m%^<DEPRECATED/>%) {
$is_deprecated = 1;
} elsif (m%^</$declaration_type>%) {
- #print "Found end of declaration: $declaration_name\n";
+ @TRACE@("Found end of declaration: $declaration_name\n");
# Check that the declaration has a name
if ($declaration_name eq "") {
- print "ERROR: $declaration_type has no name $file:$.\n";
+ &LogWarning ($file, $., "$declaration_type has no name.\n");
}
# If the declaration is an empty typedef struct _XXX XXX
# set the flag to indicate the struct has a typedef.
if ($declaration_type eq 'STRUCT'
&& $declaration =~ m/^\s*$/) {
- #print "Struct has typedef: $declaration_name\n";
+ @TRACE@("Struct has typedef: $declaration_name\n");
$StructHasTypedef{$declaration_name} = 1;
}
if ($signal_name =~ m/^(.*)::(.*)$/) {
$signal_object = $1;
($signal_name = $2) =~ s/_/-/g;
- #print "Found signal: $signal_name\n";
+ @TRACE@("Found signal: $signal_name\n");
} else {
&LogWarning ($file, $., "Invalid signal name: $signal_name.");
}
} elsif (m/^<FLAGS>(.*)<\/FLAGS>/) {
$signal_flags = $1;
} elsif (m%^</SIGNAL>%) {
- #print "Found end of signal: ${signal_object}::${signal_name}\nReturns: ${signal_returns}\n${signal_prototype}";
+ @TRACE@("Found end of signal: ${signal_object}::${signal_name}\nReturns: ${signal_returns}\n${signal_prototype}");
push (@SignalObjects, $signal_object);
push (@SignalNames, $signal_name);
push (@SignalReturns, $signal_returns);
my $template = "$docsfile.sgml";
if (! -f $template) {
- #print "File doesn't exist: $template\n";
+ @TRACE@("File doesn't exist: $template\n");
return 0;
}
$symbol = $docsfile . ":" . $symbol;
}
- #print "Found symbol: $symbol\n";
+ @TRACE@("Found symbol: $symbol\n");
# Remember file and line for the symbol
$SymbolSourceFile{$symbol} = $template;
$SymbolSourceLine{$symbol} = $.;
@params = ();
} elsif (m/^<!-- # Unused Parameters # -->/) {
- #print "DEBUG: Found unused parameters\n";
+ @TRACE@("Found unused parameters\n");
$in_unused_params = 1;
next;
} elsif ($in_unused_params && $skip_unused_params) {
# When outputting the DocBook we skip unused parameters.
- #print "DEBUG: Skipping unused param: $_";
+ @TRACE@("Skipping unused param: $_");
next;
} else {
if ($arg_name =~ m/^(.*)::(.*)$/) {
$arg_object = $1;
($arg_name = $2) =~ s/_/-/g;
- #print "Found arg: $arg_name\n";
+ @TRACE@("Found arg: $arg_name\n");
} else {
&LogWarning ($file, $., "Invalid argument name: $arg_name");
}
} elsif (m/^<DEFAULT>(.*)<\/DEFAULT>/) {
$arg_default = $1;
} elsif (m%^</ARG>%) {
- #print "Found end of arg: ${arg_object}::${arg_name}\n${arg_type} : ${arg_flags}\n";
+ @TRACE@("Found end of arg: ${arg_object}::${arg_name}\n${arg_type} : ${arg_flags}\n");
push (@ArgObjects, $arg_object);
push (@ArgNames, $arg_name);
push (@ArgTypes, $arg_type);
# If we find a line containing _DEPRECATED, we hope that this is
# attribute based deprecation and also treat this as a deprecation
- # guard.
+ # guard, unless it's a macro definition.
if ($deprecated_conditional_nest == 0 and m/_DEPRECATED/) {
- $deprecated_conditional_nest += 0.1;
+ unless (m/^\s*#\s*(if*|define)/ or $in_declaration eq "enum") {
+ @TRACE@("Found deprecation annotation (decl: '$in_declaration'): $_");
+ $deprecated_conditional_nest += 0.1;
+ }
}
# set global that is used later when we do AddSymbolToList
# ENUMS
- } elsif (s/^\s*enum\s+_(\w+)\s+\{/enum $1 {/) {
+ } elsif (s/^\s*enum\s+_?(\w+)\s+\{/enum $1 {/) {
# We assume that 'enum _<enum_name> {' is really the
# declaration of enum <enum_name>.
$symbol = $1;
# VARIABLES (extern'ed variables)
- } elsif (m/^\s*(extern|[A-Za-z_]+VAR|${IGNORE_DECORATORS})\s+((const\s+|signed\s+|unsigned\s+|long\s+|short\s+)*\w+)(\s+\*+|\*+|\s)\s*(const\s+)*([A-Za-z]\w*)\s*;/) {
+ } elsif (m/^\s*(extern|[A-Za-z_]+VAR|${IGNORE_DECORATORS})\s+((const\s+|signed\s+|unsigned\s+|long\s+|short\s+)*\w+)(\s+\*+|\*+|\s)\s*(const\s+)*([A-Za-z]\w*)\s*;/o) {
$symbol = $6;
s/^\s*([A-Za-z_]+VAR)\b/extern/;
$decl = $_;
# STRUCTS
- } elsif (m/^\s*struct\s+_(\w+)\s*\*/) {
+ } elsif (m/^\s*struct\s+_?(\w+)\s*\*/) {
# Skip 'struct _<struct_name> *', since it could be a
# return type on its own line.
- } elsif (m/^\s*struct\s+_(\w+)/) {
+ } elsif (m/^\s*struct\s+_?(\w+)/) {
# We assume that 'struct _<struct_name>' is really the
# declaration of struct <struct_name>.
$symbol = $1;
+++ /dev/null
-#!@PERL@ -w
-# -*- cperl -*-
-#
-# gtk-doc - GTK DocBook documentation generator.
-# Copyright (C) 1998 Damon Chaplin
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
-
-#
-# This gets information about object heirarchies and signals
-# by compiling a small C program. CFLAGS and LDFLAGS must be
-# set appropriately before running this script.
-#
-
-use Getopt::Long;
-
-push @INC, '@PACKAGE_DATA_DIR@';
-require "gtkdoc-common.pl";
-
-# Options
-
-# name of documentation module
-my $MODULE;
-my $OUTPUT_DIR;
-my $PRINT_VERSION;
-
-my $CC;
-my $LD;
-my $CFLAGS;
-my $LDFLAGS;
-my $RUN;
-
-%optctl = (module => \$MODULE,
- types => \$TYPES_FILE,
- nogtkinit => \$NO_GTK_INIT,
- 'output-dir' => \$OUTPUT_DIR,
- 'cc' => \$CC,
- 'ld' => \$LD,
- 'cflags' => \$CFLAGS,
- 'ldflags' => \$LDFLAGS,
- 'run' => \$RUN,
- 'version' => \$PRINT_VERSION,
- 'help' => \$PRINT_HELP);
-
-GetOptions(\%optctl, "module=s", "types:s", "output-dir:s", "nogtkinit", "cc:s", "ld:s", "run:s", "cflags:s", "ldflags:s", "version", "help");
-
-if ($PRINT_VERSION) {
- print "@VERSION@\n";
- exit 0;
-}
-
-if (!$MODULE) {
- $PRINT_HELP = 1;
-}
-
-if ($PRINT_HELP) {
- print <<EOF;
-gtkdoc-scanobj version @VERSION@ - introspect gtk-objects
-
---module=MODULE_NAME Name of the doc module being parsed
---types=FILE The name of the file to store the types in
---output-dir=DIRNAME The directory where the results are stored
---cc=COMPILER The compiler to use
---ld=LINKER The linker to use
---run=RUN Command for running the scanner
---cflags=CFLAGS Compiler flags
---ldflags=LDFLAGS Linker flags
---version Print the version of this program
---help Print this help
-EOF
- exit 0;
-}
-
-$OUTPUT_DIR = $OUTPUT_DIR ? $OUTPUT_DIR : ".";
-
-$TYPES_FILE = $TYPES_FILE ? $TYPES_FILE : "$OUTPUT_DIR/$MODULE.types";
-
-open (TYPES, $TYPES_FILE) || die "Cannot open $TYPES_FILE: $!\n";
-open (OUTPUT, ">$MODULE-scan.c") || die "Cannot open $MODULE-scan.c: $!\n";
-
-my $old_signals_filename = "$OUTPUT_DIR/$MODULE.signals";
-my $new_signals_filename = "$OUTPUT_DIR/$MODULE.signals.new";
-my $old_hierarchy_filename = "$OUTPUT_DIR/$MODULE.hierarchy";
-my $new_hierarchy_filename = "$OUTPUT_DIR/$MODULE.hierarchy.new";
-my $old_args_filename = "$OUTPUT_DIR/$MODULE.args";
-my $new_args_filename = "$OUTPUT_DIR/$MODULE.args.new";
-
-# write a C program to scan the types
-
-$includes = "";
-@types = ();
-
-for (<TYPES>) {
- if (/^#include/) {
- $includes .= $_;
- } elsif (/^%/) {
- next;
- } elsif (/^\s*$/) {
- next;
- } else {
- chomp;
- push @types, $_;
- }
-}
-
-$ntypes = @types + 1;
-
-print OUTPUT <<EOT;
-#include <string.h>
-#include <stdlib.h>
-#include <stdio.h>
-#include <errno.h>
-
-$includes
-GtkType object_types[$ntypes];
-
-GtkType *
-get_object_types (void)
-{
- gint i = 0;
-EOT
-
-for (@types) {
- print OUTPUT " object_types[i++] = $_ ();\n";
-}
-
-print OUTPUT <<EOT;
- object_types[i] = 0;
-
- return object_types;
-}
-
-/*
- * This uses GTK type functions to output signal prototypes and the widget
- * hierarchy.
- */
-
-/* The output files */
-gchar *signals_filename = "$new_signals_filename";
-gchar *hierarchy_filename = "$new_hierarchy_filename";
-gchar *args_filename = "$new_args_filename";
-
-
-static void output_signals (void);
-static void output_widget_signals (FILE *fp,
- GtkType object_type);
-static void output_widget_signal (FILE *fp,
- GtkType object_type,
- gchar *object_class_name,
- guint signal_id);
-static gchar * get_type_name (GtkType type,
- gboolean * is_pointer);
-static void output_widget_hierarchy (void);
-static void output_hierarchy (FILE *fp,
- GtkType type,
- guint level);
-
-static void output_args (void);
-static void output_widget_args (FILE *fp, GtkType object_type);
-
-int
-main (int argc, char *argv[])
-{
-EOT
-
- if ($NO_GTK_INIT) {
- print OUTPUT <<EOT;
- gtk_type_init ();
-EOT
- } else {
- print OUTPUT <<EOT;
- gtk_init (&argc, &argv);
-EOT
- }
-
-print OUTPUT <<EOT;
- get_object_types ();
-
- output_signals ();
- output_widget_hierarchy ();
- output_args ();
-
- return 0;
-}
-
-
-static void
-output_signals (void)
-{
- FILE *fp;
- gint i;
-
- fp = fopen (signals_filename, "w");
- if (fp == NULL)
- {
- g_warning ("Couldn't open output file: %s : %s", signals_filename, g_strerror(errno));
- return;
- }
-
- for (i = 0; object_types[i]; i++)
- output_widget_signals (fp, object_types[i]);
-
- fclose (fp);
-}
-
-
-/* This outputs all the signals of one widget. */
-static void
-output_widget_signals (FILE *fp, GtkType object_type)
-{
- GtkObjectClass *class;
- gchar *object_class_name;
- guint sig;
-
- class = gtk_type_class (object_type);
- if (!class || class->nsignals == 0)
- return;
-
- object_class_name = gtk_type_name (object_type);
-
- for (sig = 0; sig < class->nsignals; sig++)
- {
- if (!class->signals[sig])
- {
- /*g_print ("Signal slot [%u] is empty\\n", sig);*/
- continue;
- }
-
- output_widget_signal (fp, object_type, object_class_name,
- class->signals[sig]);
- }
-}
-
-
-/* This outputs one signal. */
-static void
-output_widget_signal (FILE *fp,
- GtkType object_type,
- gchar *object_name,
- guint signal_id)
-{
- GtkSignalQuery *query_info;
- gchar *ret_type, *pos, *type_name, *arg_name, *object_arg, *object_arg_start;
- gboolean is_pointer;
- gchar buffer[1024];
- guint i, param;
- gint param_num, widget_num, event_num, callback_num;
- gint *arg_num;
- gchar signal_name[128];
-
- /* g_print ("Object: %s Type: %i Signal: %u\\n", object_name, object_type,
- signal_id);*/
-
- param_num = 1;
- widget_num = event_num = callback_num = 0;
-
- query_info = gtk_signal_query (signal_id);
- if (query_info == NULL)
- {
- g_warning ("Couldn't query signal");
- return;
- }
-
- /* Output the signal object type and the argument name. We assume the
- type is a pointer - I think that is OK. We remove "Gtk" or "Gnome" and
- convert to lower case for the argument name. */
- pos = buffer;
- sprintf (pos, "%s ", object_name);
- pos += strlen (pos);
-
- /* Try to come up with a sensible variable name for the first arg
- * I chops off 2 know prefixes :/ and makes the name lowercase
- * It should replace lowercase -> uppercase with '_'
- * see gtkdoc-scangobject.in for better algorithm
- */
- if (!strncmp (object_name, "Gtk", 3))
- object_arg = object_name + 3;
- else if (!strncmp (object_name, "Gnome", 5))
- object_arg = object_name + 5;
- else
- object_arg = object_name;
-
- object_arg_start = pos;
- sprintf (pos, "*%s\\n", object_arg);
- pos += strlen (pos);
- g_strdown (object_arg_start);
- if (!strcmp (object_arg_start, "widget"))
- widget_num++;
-
- /* Convert signal name to use underscores rather than dashes '-'. */
- strncpy (signal_name, query_info->signal_name, 127);
- signal_name[127] = '\\0';
- for (i = 0; signal_name[i]; i++)
- {
- if (signal_name[i] == '-')
- signal_name[i] = '_';
- }
-
- /* Output the signal parameters. */
- for (param = 0; param < query_info->nparams; param++)
- {
- type_name = get_type_name (query_info->params[param], &is_pointer);
-
- /* Most arguments to the callback are called "arg1", "arg2", etc.
- GtkWidgets are called "widget", "widget2", ...
- GtkCallbacks are called "callback", "callback2", ... */
- if (!strcmp (type_name, "GtkWidget"))
- {
- arg_name = "widget";
- arg_num = &widget_num;
- }
- else if (!strcmp (type_name, "GtkCallback")
- || !strcmp (type_name, "GtkCCallback"))
- {
- arg_name = "callback";
- arg_num = &callback_num;
- }
- else
- {
- arg_name = "arg";
- arg_num = ¶m_num;
- }
- sprintf (pos, "%s ", type_name);
- pos += strlen (pos);
-
- if (!arg_num || *arg_num == 0)
- sprintf (pos, "%s%s\\n", is_pointer ? "*" : " ", arg_name);
- else
- sprintf (pos, "%s%s%i\\n", is_pointer ? "*" : " ", arg_name,
- *arg_num);
- pos += strlen (pos);
-
- if (arg_num)
- *arg_num += 1;
- }
-
- /* Output the return type and function name. */
- ret_type = get_type_name (query_info->return_val, &is_pointer);
-
- fprintf (fp,
- "<SIGNAL>\\n<NAME>%s::%s</NAME>\\n<RETURNS>%s%s</RETURNS>\\n%s</SIGNAL>\\n\\n",
- object_name, query_info->signal_name, ret_type, is_pointer ? "*" : "", buffer);
- g_free (query_info);
-}
-
-
-/* Returns the type name to use for a signal argument or return value, given
- the GtkType from the signal info. It also sets is_pointer to TRUE if the
- argument needs a '*' since it is a pointer. */
-static gchar *
-get_type_name (GtkType type, gboolean * is_pointer)
-{
- gchar *type_name;
-
- *is_pointer = FALSE;
- type_name = gtk_type_name (type);
-
- switch (type) {
- case GTK_TYPE_NONE:
- case GTK_TYPE_CHAR:
- case GTK_TYPE_UCHAR:
- case GTK_TYPE_BOOL:
- case GTK_TYPE_INT:
- case GTK_TYPE_UINT:
- case GTK_TYPE_LONG:
- case GTK_TYPE_ULONG:
- case GTK_TYPE_FLOAT:
- case GTK_TYPE_DOUBLE:
- case GTK_TYPE_POINTER:
- /* These all have normal C type names so they are OK. */
- return type_name;
-
- case GTK_TYPE_STRING:
- /* A GtkString is really a gchar*. */
- *is_pointer = TRUE;
- return "gchar";
-
- case GTK_TYPE_ENUM:
- case GTK_TYPE_FLAGS:
- /* We use a gint for both of these. Hopefully a subtype with a decent
- name will be registered and used instead, as GTK+ does itself. */
- return "gint";
-
- case GTK_TYPE_BOXED:
- /* A boxed value is just an opaque pointer, I think. */
- return "gpointer";
-
- case GTK_TYPE_SIGNAL:
- case GTK_TYPE_ARGS:
- case GTK_TYPE_FOREIGN:
- case GTK_TYPE_CALLBACK:
- case GTK_TYPE_C_CALLBACK:
- /* FIXME: These are wrong. I think they expand into more than 1 argument.
- See the GtkArg struct in gtktypeutils.h and gtkargcollector.c.
- Fortunately I doubt anything uses these as signal args. */
- return "gpointer";
-
- default:
- break;
- }
-
- /* For all GtkObject subclasses we can use the class name with a "*",
- e.g. 'GtkWidget *'. */
- if (gtk_type_is_a (type, GTK_TYPE_OBJECT))
- *is_pointer = TRUE;
-
- return type_name;
-}
-
-
-/* This outputs the hierarchy of all widgets which have been initialized,
- i.e. by calling their XXX_get_type() initialization function. */
-static void
-output_widget_hierarchy (void)
-{
- FILE *fp;
-
- fp = fopen (hierarchy_filename, "w");
- if (fp == NULL)
- {
- g_warning ("Couldn't open output file: %s : %s", hierarchy_filename, g_strerror(errno));
- return;
- }
- output_hierarchy (fp, GTK_TYPE_OBJECT, 0);
- fclose (fp);
-}
-
-
-/* This is called recursively to output the hierarchy of a widget. */
-static void
-output_hierarchy (FILE *fp,
- GtkType type,
- guint level)
-{
- GList *list;
- guint i;
-
- if (!type)
- return;
-
- for (i = 0; i < level; i++)
- fprintf (fp, " ");
- fprintf (fp, "%s\\n", gtk_type_name (type));
-
- list = gtk_type_children_types (type);
-
- while (list)
- {
- GtkType child = (GtkType) list->data;
- output_hierarchy (fp, child, level + 1);
- list = list->next;
- }
-}
-
-
-static void
-output_args (void)
-{
- FILE *fp;
- gint i;
-
- fp = fopen (args_filename, "w");
- if (fp == NULL)
- {
- g_warning ("Couldn't open output file: %s : %s", args_filename, g_strerror(errno));
- return;
- }
-
- for (i = 0; object_types[i]; i++)
- output_widget_args (fp, object_types[i]);
-
- fclose (fp);
-}
-
-
-static void
-output_widget_args (FILE *fp, GtkType object_type)
-{
- GtkObjectClass *class;
- gchar *object_class_name;
- GtkArg *args;
- guint32 *arg_flags;
- guint n_args;
- guint arg;
- gchar flags[16], *pos;
-
- class = gtk_type_class (object_type);
- if (!class)
- return;
-
- object_class_name = gtk_type_name (object_type);
-
- args = gtk_object_query_args (class->type, &arg_flags, &n_args);
-
- for (arg = 0; arg < n_args; arg++)
- {
- pos = flags;
- /* We use one-character flags for simplicity. */
- if (arg_flags[arg] & GTK_ARG_READABLE)
- *pos++ = 'r';
- if (arg_flags[arg] & GTK_ARG_WRITABLE)
- *pos++ = 'w';
- if (arg_flags[arg] & GTK_ARG_CONSTRUCT)
- *pos++ = 'x';
- if (arg_flags[arg] & GTK_ARG_CONSTRUCT_ONLY)
- *pos++ = 'X';
- if (arg_flags[arg] & GTK_ARG_CHILD_ARG)
- *pos++ = 'c';
- *pos = 0;
-
- fprintf (fp, "<ARG>\\n<NAME>%s</NAME>\\n<TYPE>%s</TYPE>\\n<FLAGS>%s</FLAGS>\\n</ARG>\\n\\n",
- args[arg].name, gtk_type_name (args[arg].type), flags);
- }
-
- g_free (args);
- g_free (arg_flags);
-}
-EOT
-
-close OUTPUT;
-
-# Compile and run our file
-
-unless ($CC) {
- $CC = $ENV{CC} ? $ENV{CC} : "gcc";
-}
-unless ($LD) {
- $LD = $ENV{LD} ? $ENV{LD} : $CC;
-}
-unless ($CFLAGS) {
- $CFLAGS = $ENV{CFLAGS} ? $ENV{CFLAGS} : "";
-}
-unless ($LDFLAGS) {
- $LDFLAGS = $ENV{LDFLAGS} ? $ENV{LDFLAGS} : "";
-}
-unless ($RUN) {
- $RUN = $ENV{RUN} ? $ENV{RUN} : "";
-}
-
-my $o_file;
-if ($CC =~ /libtool/) {
- $o_file = "$MODULE-scan.lo"
-} else {
- $o_file = "$MODULE-scan.o"
-}
-
-# Compiling scanner
-$command = "$CC $CFLAGS -c -o $o_file $MODULE-scan.c";
-system("($command)") == 0 or die "Compilation of scanner failed: $!\n";
-
-# Linking scanner
-# FIXME: Can we turn off as-needed for the docs (or better fix it?)
-#$command = "$LD -Wl,--no-as-needed $o_file $LDFLAGS -o $MODULE-scan";
-$command = "$LD $o_file $LDFLAGS -o $MODULE-scan";
-system("($command)") == 0 or die "Linking of scanner failed: $!\n";
-
-# Running scanner $MODULE-scan ";
-system("($RUN ./$MODULE-scan)") == 0 or die "Scan failed: $!\n";
-
-if (!defined($ENV{"GTK_DOC_KEEP_INTERMEDIATE"})) {
- unlink "./$MODULE-scan.c", "./$MODULE-scan.o", "./$MODULE-scan.lo", "./$MODULE-scan";
-}
-
-&UpdateFileIfChanged ($old_signals_filename, $new_signals_filename, 0);
-&UpdateFileIfChanged ($old_hierarchy_filename, $new_hierarchy_filename, 0);
-&UpdateFileIfChanged ($old_args_filename, $new_args_filename, 0);
-
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
</legalnotice>
<revhistory>
+ <revision>
+ <revnumber>1.21</revnumber>
+ <date>17 Jul 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, dropping deprecated features</revremark>
+ </revision>
<revision>
<revnumber>1.20</revnumber>
<date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>bug fixes, markdown support, style improvements</revremark>
- </revision>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<guilabel>Perl v5</guilabel> - the main scripts are in Perl.
</para>
<para>
- <guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD.
- <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting SGML to various formats.
- <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
</para>
<para>
- <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook.
- I've customized the 'translation spec' slightly, to capitalise section
- headings and add the 'GTK Library' title at the top of the pages and the
- revision date at the bottom.
- There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
- NOTE: This does not work yet.
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>
- There is no standard place where the DocBook Modular Stylesheets are installed.
- </para>
- <para>
- GTK-Doc's configure script searches these 3 directories automatically:
- </para>
- <para>
- <filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by RedHat)
- </para>
- <para>
- <filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)
- </para>
- <para>
- <filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)
- </para>
- <para>
- If you have the stylesheets installed somewhere else, you need to configure
- GTK-Doc using the option:
- <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>
- </para>
- </sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>About GTK-Doc</title>
</para>
<para>
- (History, authors, web pages, license, future plans,
+ (History, authors, web pages, mailing list, license, future plans,
comparison with other similar systems.)
</para>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Integration with autoconf</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Preparation for gtkdocize</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Running gtkdocize from autogen.sh</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>Running the doc build</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>Documentation placement</title>
<para>
In the past most documentation had to be filled into files residing
- inside the <filename>tmpl</filename> directory. This has the
- disadvantages that the information is often not updated and also that
- the file tend to cause conflicts with version control systems.
+ inside the <filename>tmpl</filename> directory. This has the
+ disadvantages that the information is often not updated and also that
+ the file tend to cause conflicts with version control systems.
</para>
<para>
The avoid the aforementioned problems we suggest putting the
- documentation inside the sources. This manual will only describe this
- way of documenting code.
+ documentation inside the sources. This manual will only describe this
+ way of documenting code.
</para>
</note>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Section comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<example><title>General tags</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Function comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Function tags</title>
<sect2><title>Property comment block</title>
<example><title>Property comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Signal comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct comment block</title>
<example><title>Struct comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum comment block</title>
<example><title>Enum comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Master document header</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
HELP_ID = gtk-doc-manual
HELP_FILES = \
- index.docbook \
- fdl-appendix.xml
+ index.docbook \
+ fdl-appendix.xml
HELP_LINGUAS = bn_IN de el en_GB es fr gu pt_BR sl sv ta te zh_CN
+CLEANFILES = $(_HELP_LC_FILES) $(_HELP_LC_STAMPS) $(_HELP_MOFILES)
+
-include $(top_srcdir)/git.mk
top_srcdir = @top_srcdir@
HELP_ID = gtk-doc-manual
HELP_FILES = \
- index.docbook \
- fdl-appendix.xml
+ index.docbook \
+ fdl-appendix.xml
HELP_LINGUAS = bn_IN de el en_GB es fr gu pt_BR sl sv ta te zh_CN
+CLEANFILES = $(_HELP_LC_FILES) $(_HELP_LC_STAMPS) $(_HELP_MOFILES)
all: all-am
.SUFFIXES:
mostlyclean-generic:
clean-generic:
+ -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
<book id="index" lang="bn-IN">
<bookinfo>
<title>GTK-Doc সহায়িকা</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>GTK-Doc ব্যবহারের নির্দেশাবলী সহ, ডিভেলপরদের উদ্দেশ্যে নির্মিত সহায়িকা।</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>আবশ্যক মান</title>
<para><guilabel>Perl v5</guilabel> - প্রধান স্ক্রিপ্টগুলি Perl-এ লেখা হয়েছে।</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - এটি DocBook SGML DTD। <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - SGML-কে বিভিন্ন বিন্যাসে পরিবর্তনের জন্য ব্যবহৃত এটি একটি DSSSL প্রসেসর। <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook.
- I've customized the 'translation spec' slightly, to capitalise section
- headings and add the 'GTK Library' title at the top of the pages and the
- revision date at the bottom.
- There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
- NOTE: This does not work yet.
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
- <sect2 id="installation">
- <title>ইনস্টলেশনের প্রণালী</title>
- <para>DocBook মডিউলার স্টাইল-শিট ইনস্টল করার কোনো প্রমিত স্থান উপস্থিত নেই।</para>
- <para>GTK-Doc-র কনফিগার স্ক্রিপ্ট দ্বারা স্বয়ংক্রিয়ভাবে নিম্নলিখিত তিনটি ডিরেক্টরির মধ্যে অনুসন্ধান করা হয়:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (RedHat দ্বারা ব্যবহৃত)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (Debian দ্বারা ব্যবহৃত)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (SuSE দ্বারা ব্যবহৃত)</para>
- <para>স্টাইল-শিটগুলি অন্য কোনো স্থানে ইনস্টল করা হয়ে থাকলে, নিম্নলিখিত বিকল্প সহয়োগে GTK-Doc কনফিগার করতে হবে: <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command></para>
- </sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>GTK-Doc পরিচিতি</title>
<para>(FIXME)</para>
- <para>(পূর্ববর্তী তথ্য, লেখক, ওয়েব-পেজ, লাইসেন্স, ভবিষ্যতের প্রকল্প, অন্যান্য সমতূল্য সিস্টেমের সাথে তূলনা।)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>autoconf সহযোগে একত্রিত করার প্রণালী</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>gtkdocize-র প্রস্তুতি</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>autogen.sh থেকে gtkdocsize সঞ্চালনার প্রণালী</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>doc build সঞ্চালনার প্রণালী</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>নথিপত্রের স্থাপনা</title>
<para>
In the past most documentation had to be filled into files residing
- inside the <filename>tmpl</filename> directory. This has the
- disadvantages that the information is often not updated and also that
- the file tend to cause conflicts with version control systems.
+ inside the <filename>tmpl</filename> directory. This has the
+ disadvantages that the information is often not updated and also that
+ the file tend to cause conflicts with version control systems.
</para>
<para>
The avoid the aforementioned problems we suggest putting the
- documentation inside the sources. This manual will only describe this
- way of documenting code.
+ documentation inside the sources. This manual will only describe this
+ way of documenting code.
</para>
</note>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>বিভাগ কমেন্ট ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : স্থায়ীত্ব সংক্রান্ত তথ্য)</para>
<example><title>সাধারণ ট্যাগ</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>ফাংশান কমেন্টের ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>ফাংশান সংক্রান্ত ট্যাগ</title>
<sect2><title>Property কমেন্টের ব্লক</title>
<example><title>Property কমেন্টের ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Signal কমেন্টের ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct কমেন্টের ব্লক</title>
<example><title>Struct কমেন্টের ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum কমেন্টের ব্লক</title>
<example><title>Enum কমেন্টের ব্লক</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>প্রধা নথির হেডার</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="de">
<bookinfo>
<title>GTK-Doc-Handbuch</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>Benutzerhandbuch für Entwickler mit Anweisungen für die Benutzung von GTK-Doc.</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author>
+ <firstname>Stefan</firstname>
+ <surname>Sauer (Kost)</surname>
+ <affiliation>
+ <address>
+ <email>ensonic@users.sf.net</email>
+ </address>
+ </affiliation>
+ </author>
</authorgroup>
<publisher role="maintainer"><publishername>GTK-Doc-Projekt</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth und Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright>
+ <year>2007-2014</year>
+ <holder>Stefan Sauer (Kost)</holder>
+ </copyright>
<!-- translators: uncomment this:
<copyright>
</legalnotice>
<revhistory>
- <revision><revnumber>1.19.1</revnumber> <date>05. Juni 2013</date> <authorinitials>ss</authorinitials> <revremark>Entwicklerversion</revremark></revision>
+ <revision>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>development version</revremark>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision><revnumber>1.19</revnumber> <date>05. Juni 2013</date> <authorinitials>sk</authorinitials> <revremark>Fehlerbehebungen</revremark></revision>
<revision><revnumber>1.18</revnumber> <date>14. September 2011</date> <authorinitials>ss</authorinitials> <revremark>Fehlerbehebungen, Verbesserte Geschwindigkeit, Unterstützung für markdown</revremark></revision>
<revision><revnumber>1.17</revnumber> <date>26. Februar 2011</date> <authorinitials>sk</authorinitials> <revremark>Dringende Bugfix-Aktualisierung</revremark></revision>
<sect2 id="requirements">
<title>Erfordernisse</title>
<para><guilabel>Perl v5</guilabel> - Die Hauptskripte wurden in Perl geschrieben.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - Die DTD für DocBook SGML. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - Dies ist ein DSSSL-Prozessor zur Umwandlung von SGML in verschiedene Formate. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modulare DocBook-Stilvorlagen</guilabel> Dies ist der DSSSL-Code zur Umwandlung von DocBook in HTML und einige andere Formate. Es wird zusammen mit Jade benutzt. Ich habe den DSSSL-Code in gtk-doc.dsl etwas angepasst, um die Programmcode-Listings und -Deklarationen einzufärben und um globale Cross-Reference-Indizes im erzeugten HTML zu unterstützen. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - Wenn Sie man-Hilfeseiten vom DocBook erstellen möchten. Ich habe die »translation spec« geringfügig angepasst, um Abschnittüberschriften groß zu schreiben und den Titel »GTK-bibliothek« oben auf jeder Seite und das Überarbeitungsdatum unten zu platzieren. Dazu gibt es einen Verweis auf <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> HINWEIS: Das funktioniert noch nicht.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>Es gibt keinen Standardort, an welchem die Modularen DocBook-Stilvorlagen installiert werden.</para>
- <para>Das Configure-Skript von GTK-Doc durchsucht folgende drei Ordner automatisch:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (verwendet von RedHat)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (verwendet von Debian)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (verwendet von SuSE)</para>
- <para>Falls sie Stilvorlagen an anderen Orten installiert haben, müssen Sie GTK-Doc mit folgender Option konfigurieren: <command>--with-dsssl-dir=<PFAD_ZUM_BASISORDNER_DER_STILVORLAGEN> </command></para>
+ <para>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
+ </para>
+ <para>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
+ </para>
</sect2>
-
- </sect1>
-
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
</sect1>
- -->
<sect1 id="aboutgtkdoc">
<title>Info zu GTK-Doc</title>
<para>(FIXME)</para>
- <para>(Geschichte, Autoren, Webseiten, Lizenz, Zukunftspläne, Vergleich mit ähnlichen Systemen)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>Erstellen Sie in dem Ordner der obersten Ebene des Projekts die Unterordner namens docs/reference. Auf diese Weise können Sie auch docs/help für die Endbenutzerdokumentation anlegen. Es ist empfehlenswert, einen weiteren Unterordner mit dem Namen des Dokumentationspakets anzulegen. Für Pakete, die nur eine einzige Bibliothek enthalten, ist dieser Schritt nicht notwendig.</para>
<para>Dies kann dann wie nachstehend angezeigt aussehen: <example><title>Beispiel für die Ordnerstruktur</title>
- <programlisting>
-
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+]]></programlisting>
</example></para>
</sect1>
<para>
<example><title>Integration in autoconf</title>
- <programlisting>
-
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Dazu müssen alle Entwickler gtk-doc installiert haben. Wenn es für das Projekt vertretbar ist, einen optionalen Erstellungsschritt für die api-doc zu haben, so können Sie es wie im Folgenden lösen. Lassen Sie es so, wie es ist, weil gtkdocize nach <function>GTK_DOC_CHECK</function> am Anfang einer Zeile sucht. <example><title>Halten Sie gtk-doc optional</title>
- <programlisting>
-
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-
- </programlisting>
+]]></programlisting>
</example></para>
<para>Das erste Argument wird zur Überprüfung von gtkdocversion während des configure-Durchlaufs benutzt. Das zweite, optionale Argument wird von <application>gtkdocize</application> verwendet. Das Makro <symbol>GTK_DOC_CHECK</symbol> fügt verschiedene Schalter für configure hinzu:</para>
<para>
<example><title>Vorbereitung für gtkdocize</title>
- <programlisting>
-
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Ausführen von gtkdocize durch autogen.sh</title>
- <programlisting>
-
+ <programlisting><![CDATA[
gtkdocize || exit 1
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Der erste Durchlauf von make erstellt verschiedene zusätzliche Dateien in den Dokumentationsordnern. Die bedeutendsten davon sind: <filename><package>.types</filename>, <filename><package>-docs.xml</filename> (früher .sgml), <filename><package>-sections.txt</filename>.</para>
<para>
<example><title>Erstellung der Dokumentation</title>
- <programlisting>
-
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Nun können Sie <filename>docs/reference/<package>/index.html</filename> in Ihrem Browser öffnen. Zugegeben, das Ergebnis ist noch ein wenig enttäuschend. Im nächsten Abschnitt zeigen wir Ihnen, wie Sie die Seiten mit Leben füllen können.</para>
<para>
<example><title>Schritte zur Erstellung der Dokumentation</title>
- <programlisting>
-
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml
// xml files have changed
mkdir html
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
+cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</note>
<para>Der Scanner kann mit den meisten C-Kopfdateien umgehen. Im falle von Warnungen des Scanners, die wie ein Spezialfall aussehen, kann man GTK-Doc anweisen diese zu überspringen. <example><title>GTK-Doc-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-
- </programlisting>
+]]></programlisting>
</example></para>
<!-- -->
<title>Kommentare zur Dokumentation</title>
<para>Ein mehrzeiliger Kommentar, der mit einem zusätzlichen »*« beginnt, markiert einen Kommentarblock, der von den Werkzeugen in GTK-Doc verarbeitet wird. <example><title>GTK-Doc-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-
- </programlisting>
+]]></programlisting>
</example></para>
<para>Der »identifier« ist eine Zeile mit dem Namen des Objekts, auf das sich der Kommentar bezieht. Die Syntax kann abhängig von der Art des Objekts variieren.</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Abschnitts-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : Stabilitätsinformation)</para>
<example><title>Allgemeine Markierungen</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
*
* Since: 2.6
* Deprecated: 2.12: Use foo_baz_get_bar() instead.
- **/
+ */
Bar *
foo_get_bar(Foo *foo)
{
...
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<para>Werfen Sie auch einen Blick auf die »GObject introspection annotation tags«: http://live.gnome.org/GObjectIntrospection/Annotations</para>
<example><title>Kommentarblock einer Funktion</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Funktions-Tags</title>
<sect2><title>Property-Kommentarblock</title>
<example><title>Property-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</itemizedlist></para>
<example><title>Signal-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct-Kommentarblock</title>
<example><title>Struct-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
* This is the best widget, ever.
*/
typedef struct _FooWidget {
- /*< private >*/
+ /*< private >*/
GtkWidget parent;
- /*< public >*/
+ /*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+]]></programlisting>
</example>
<para>Verwenden Sie <code>/*< private >*/</code> vor den privaten »struct«-Feldern, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie <code>/*< public >*/</code>.</para>
<sect2><title>Enum-Kommentarblock</title>
<example><title>Enum-Kommentarblock</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
* @SOMETHING_BAR: something bar
*
* Enum values used for the thing, to specify the thing.
- *
- **/
+ */
typedef enum {
SOMETHING_FOO,
SOMETHING_BAR,
- /*< private >*/
+ /*< private >*/
SOMETHING_COUNT
} Something;
-
- </programlisting>
+]]></programlisting>
</example>
<para>Verwenden Sie <code>/*< private >*/</code> vor den privaten »enum«-Werten, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie <code>/*< public >*/</code>.</para>
<para>Nachfolgend finden Sie einige DocBook-Tags, die beim Dokumentieren von Code nützlich sein können.</para>
<para>So erstellen Sie eine Verknüpfung zu einem anderen Abschnitt in den GTK-Docs: <informalexample>
- <programlisting>
-
-<link linkend="glib-Hash-Tables">Hash Tables</link>
-
- </programlisting>
+ <programlisting><![CDATA[
+<link linkend="glib-Hash-Tables">Hash Tables</link>
+]]></programlisting>
</informalexample> »linkend« ist dabei die SGML-XML-Kennung des obersten Elements der Seite, auf welche die Verknüpfung zielt (»gtk«, »gdk«, »glib«), danach folgt der Seitentitel ("Hash Tables"). Für Widgets ist dies einfach der Klassenname. Leerzeichen und Unterstriche werden SGML/XML-konform in »-« umgewandelt. </para>
<para>Für einen Bezug zu einer externen Funktion, z.B. einer C-Standardfunktion: <informalexample>
- <programlisting>
-
-<function>...</function>
-
- </programlisting>
+ <programlisting><![CDATA[
+<function>...</function>
+]]></programlisting>
</informalexample></para>
<para>So fügen Sie Beispielcode ein: <placeholder-1/> Vielleicht auch so, für sehr kurze Codeschnipsel, die keinen Titel benötigen: <informalexample>
- <programlisting>
-
-<informalexample>
- <programlisting>
+ <programlisting><![CDATA[
+<informalexample>
+ <programlisting>
...
- </programlisting>
-</informalexample>
-
- </programlisting>
+ </programlisting>
+</informalexample>
+]]></programlisting>
</informalexample> Außerdem unterstützt GTK-Doc auch eine Abkürzung: |[ ... ]|</para>
<para>Für eine Liste mit Aufzählungszeichen: <informalexample>
- <programlisting>
-
-<itemizedlist>
- <listitem>
- <para>
+ <programlisting><![CDATA[
+<itemizedlist>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
-</itemizedlist>
-
- </programlisting>
+ </para>
+ </listitem>
+</itemizedlist>
+]]></programlisting>
</informalexample></para>
<para>Für eine nicht zum eigentlichen Text gehörende Notiz: <informalexample>
- <programlisting>
-
-<note>
- <para>
+ <programlisting><![CDATA[
+<note>
+ <para>
Make sure you free the data after use.
- </para>
-</note>
-
- </programlisting>
+ </para>
+</note>
+]]></programlisting>
</informalexample></para>
<para>Für einen Bezug zu einem Typ: <informalexample>
- <programlisting>
-
-<type>unsigned char</type>
-
- </programlisting>
+ <programlisting><![CDATA[
+<type>unsigned char</type>
+]]></programlisting>
</informalexample></para>
<para>Für einen Bezug zu einer externen Struktur (die nicht in den GTK-Docs beschrieben wird): <informalexample>
- <programlisting>
-
-<structname>XFontStruct</structname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structname>XFontStruct</structname>
+]]></programlisting>
</informalexample></para>
<para>Für einen Bezug zu einem Feld einer Struktur: <informalexample>
- <programlisting>
-
-<structfield>len</structfield>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structfield>len</structfield>
+]]></programlisting>
</informalexample></para>
<para>Um sich auf einen Klassennamen zu beziehen kann man möglicherweise folgendes verwenden: <informalexample>
- <programlisting>
-
-<classname>GtkWidget</classname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<classname>GtkWidget</classname>
+]]></programlisting>
</informalexample> Aber Sie verwenden vermutlich stattdessen #GtkWidget (um automatisch eine Verknüpfung zur GtkWidget-Seite zu erstellen - lesen Sie <link linkend="documenting_syntax">die Abkürzungen</link>).</para>
<para>Zum Hervorheben von Text: <informalexample>
- <programlisting>
-
-<emphasis>This is important</emphasis>
-
- </programlisting>
+ <programlisting><![CDATA[
+<emphasis>This is important</emphasis>
+]]></programlisting>
</informalexample></para>
<para>Für Dateinamen: <informalexample>
- <programlisting>
-
-<filename>/home/user/documents</filename>
-
- </programlisting>
+ <programlisting><![CDATA[
+<filename>/home/user/documents</filename>
+]]></programlisting>
</informalexample></para>
<para>Für einen Bezug zu einem Schlüssel: <informalexample>
- <programlisting>
-
-<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+ <programlisting><![CDATA[
+<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
+]]></programlisting>
</informalexample></para>
</sect1>
<para>
<example><title>Beispiel-Schnipsel einer Typen-Datei</title>
- <programlisting>
-
-#include <gtk/gtk.h>
+ <programlisting><![CDATA[
+#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Kopfzeile des Master-Dokuments</title>
- <programlisting>
-
-<bookinfo>
- <title>MODULENAME Reference Manual</title>
- <releaseinfo>
+ <programlisting><![CDATA[
+<bookinfo>
+ <title>MODULENAME Reference Manual</title>
+ <releaseinfo>
for MODULENAME [VERSION]
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
- </releaseinfo>
-</bookinfo>
+ <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
+ </releaseinfo>
+</bookinfo>
-<chapter>
- <title>[Insert title here]</title>
-
- </programlisting>
+<chapter>
+ <title>[Insert title here]</title>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Zusätzliche Configure-Überprüfungen</title>
- <programlisting>
-
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Zusätzliche Configure-Überprüfungen</title>
- <programlisting>
-
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
if ENABLE_MAN
%.1 : %.xml
- @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+ @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
endif
endif
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
msgid ""
msgstr ""
"Project-Id-Version: gtk-doc-help.master\n"
-"POT-Creation-Date: 2014-01-05 22:06+0000\n"
-"PO-Revision-Date: 2014-01-11 17:59+0300\n"
+"POT-Creation-Date: 2014-04-06 09:24+0000\n"
+"PO-Revision-Date: 2014-04-06 19:02+0300\n"
"Last-Translator: Dimitris Spingos (Δημήτρης Σπίγγος) <dmtrs32@gmail.com>\n"
-"Language-Team: www.gnome.gr\n"
+"Language-Team: team@lists.gnome.gr\n"
"Language: el\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Generator: Virtaal 0.7.1\n"
+"X-Generator: Virtaal 0.7.0\n"
#. Put one translator per line, in the form NAME <EMAIL>, YEAR1, YEAR2
msgctxt "_"
msgstr ""
"Τζένη Πετούμενου <epetoumenou@gmail.com>, 2009\n"
"Θάνος Τρυφωνίδης <tomtryf@gmail.com>, 2012\n"
-"Δημήτρης Σπίγγος <dmtrs32@gmail.com>, 2013, 2014"
+"Δημήτρης Σπίγγος <dmtrs32@gmail.com>, 2013, 2014\n"
+"Μαρία Θουκυδίδου <marablack3@gmail.com>, 2014"
#. (itstool) path: bookinfo/title
#: C/index.docbook:12
#. (itstool) path: bookinfo/edition
#: C/index.docbook:13
-msgid "1.18.1"
-msgstr "1.18.1"
+msgid "1.20"
+msgstr "1.20"
#. (itstool) path: abstract/para
#: C/index.docbook:14
msgid "User manual for developers with instructions of GTK-Doc usage."
-msgstr "Εγχειρίδιο χρήσης του GTK-Doc για προγραμματιστές."
+msgstr ""
+"Εγχειρίδιο χρήστη για προγραμματιστές με οδηγίες για τη χρήση του GTK-Doc."
#. (itstool) path: authorgroup/author
#: C/index.docbook:16
#. (itstool) path: authorgroup/author
#: C/index.docbook:34
msgid ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
msgstr ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
#. (itstool) path: publisher/publishername
#. (itstool) path: bookinfo/copyright
#: C/index.docbook:52
-msgid "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
-msgstr "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
+msgid "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
+msgstr "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
#. (itstool) path: legalnotice/para
#: C/index.docbook:65
#. (itstool) path: revhistory/revision
#: C/index.docbook:83
msgid ""
-"<revnumber>1.
19.1</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
+"<revnumber>1.
20.1</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
"authorinitials> <revremark>development version</revremark>"
msgstr ""
-"<revnumber>1.
19.1</revnumber> <date>05 Ιουν 2013</date> <authorinitials>ss</"
+"<revnumber>1.
20.1</revnumber> <date>16 Φεβ. 2014</date> <authorinitials>ss</"
"authorinitials> <revremark>έκδοση ανάπτυξης</revremark>"
#. (itstool) path: revhistory/revision
#: C/index.docbook:89
msgid ""
+"<revnumber>1.20</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
+"authorinitials> <revremark>bug fixes, markdown support, style improvements</"
+"revremark>"
+msgstr ""
+"<revnumber>1.20</revnumber> <date>16 Φεβ 2014</date> <authorinitials>ss</"
+"authorinitials> <revremark>διορθώσεις σφαλμάτων,, υποστήριξη markdown, και "
+"βελτιώσεις τεχνοτροπιών</revremark>"
+
+#. (itstool) path: revhistory/revision
+#: C/index.docbook:95
+msgid ""
"<revnumber>1.19</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes</revremark>"
msgstr ""
"authorinitials> <revremark>διόρθωση σφάλματος</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:95
+#: C/index.docbook:101
msgid ""
"<revnumber>1.18</revnumber> <date>14 Sep 2011</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes, speedups, markdown support</revremark>"
"markdown</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:101
+#: C/index.docbook:107
msgid ""
"<revnumber>1.17</revnumber> <date>26 Feb 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>urgent bug fix update</revremark>"
"authorinitials> <revremark>διόρθωση σφάλματος</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:107
+#: C/index.docbook:113
msgid ""
"<revnumber>1.16</revnumber> <date>14 Jan 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes, layout improvements</revremark>"
"revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:113
+#: C/index.docbook:119
msgid ""
"<revnumber>1.15</revnumber> <date>21 May 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bug and regression fixes</revremark>"
msgstr ""
"<revnumber>1.15</revnumber> <date>21 Μαίου 2010</date> <authorinitials>sk</"
-"authorinitials> <revremark>bug and regression fixes</revremark>"
+"authorinitials> <revremark>διορθώσεις σφαλμάτων και αναδρομής</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:119
+#: C/index.docbook:125
msgid ""
"<revnumber>1.14</revnumber> <date>28 March 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes and performance improvements</revremark>"
"revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:125
+#: C/index.docbook:131
msgid ""
"<revnumber>1.13</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>broken tarball update</"
"revremark>"
msgstr ""
"<revnumber>1.13</revnumber> <date>18 Δεκεμβρίου 2009</date> "
-"<authorinitials>sk</authorinitials> <revremark>ανανέωση σπασμένου "
+"<authorinitials>sk</authorinitials> <revremark>ανανέωση κατεστραμμένου "
"συμπιεσμένου αρχείου</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:131
+#: C/index.docbook:137
msgid ""
"<revnumber>1.12</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>new tool features and "
"bugfixes</revremark>"
msgstr ""
"<revnumber>1.12</revnumber> <date>18 Δεκεμβρίου 2009</date> "
-"<authorinitials>sk</authorinitials> <revremark>νÎα Ï\87αÏ\81ακÏ\84ηÏ\81ιÏ\83Ï\84ικά και "
-"διορθώσεις σφαλμάτων</revremark>"
+"<authorinitials>sk</authorinitials> <revremark>νÎα Ï\87αÏ\81ακÏ\84ηÏ\81ιÏ\83Ï\84ικά εÏ\81γαλείÏ\89ν "
+"και διοÏ\81θÏ\8eÏ\83ειÏ\82 Ï\83Ï\86αλμάÏ\84Ï\89ν</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:137
+#: C/index.docbook:143
msgid ""
"<revnumber>1.11</revnumber> <date>16 November 2008</date> "
"<authorinitials>mal</authorinitials> <revremark>GNOME doc-utils migration</"
"revremark>"
#. (itstool) path: chapter/title
-#: C/index.docbook:150
+#: C/index.docbook:156
msgid "Introduction"
msgstr "Εισαγωγή"
#. (itstool) path: chapter/para
-#: C/index.docbook:152
+#: C/index.docbook:158
msgid ""
"This chapter introduces GTK-Doc and gives an overview of what it is and how "
"it is used."
"και τον τρόπο χρήσης του."
#. (itstool) path: sect1/title
-#: C/index.docbook:158
+#: C/index.docbook:164
msgid "What is GTK-Doc?"
msgstr "Τι είναι το GTK-Doc;"
#. (itstool) path: sect1/para
-#: C/index.docbook:160
+#: C/index.docbook:166
msgid ""
"GTK-Doc is used to document C code. It is typically used to document the "
"public API of libraries, such as the GTK+ and GNOME libraries. But it can "
"εφαρμογών."
#. (itstool) path: sect1/title
-#: C/index.docbook:168
+#: C/index.docbook:174
msgid "How Does GTK-Doc Work?"
msgstr "Πώς λειτουργεί το GTK-Doc;"
#. (itstool) path: sect1/para
-#: C/index.docbook:170
+#: C/index.docbook:176
msgid ""
"GTK-Doc works by using documentation of functions placed inside the source "
"files in specially-formatted comment blocks, or documentation added to the "
"συναρτήσεις)."
#. (itstool) path: sect1/para
-#: C/index.docbook:177
+#: C/index.docbook:183
msgid ""
"GTK-Doc consists of a number of perl scripts, each performing a different "
"step in the process."
msgstr ""
-"Το GTK-Doc αποτελείται από μια σειρά από σενάρια perl , καθένα από τα οποία "
+"Το GTK-Doc αποτελείται από μια σειρά σεναρίων perl , καθένα από τα οποία "
"είναι υπεύθυνο για διαφορετικό στάδιο της όλης διαδικασίας."
#. (itstool) path: sect1/para
-#: C/index.docbook:182
+#: C/index.docbook:188
msgid "There are 5 main steps in the process:"
msgstr "Η διαδικασία περιλαμβάνει 5 κύρια στάδια:"
#. (itstool) path: listitem/para
-#: C/index.docbook:189
+#: C/index.docbook:195
msgid ""
"<guilabel>Writing the documentation.</guilabel> The author fills in the "
"source files with the documentation for each function, macro, union etc. (In "
"παράγονταν αυτόματα, αλλά αυτός ο τρόπος δεν συνιστάται πλέον.)"
#. (itstool) path: listitem/para
-#: C/index.docbook:199
+#: C/index.docbook:205
msgid ""
"<guilabel>Gathering information about the code.</guilabel> "
"<application>gtkdoc-scan</application> scans the header files of the code "
"the ones in <filename><module>-decl.txt</filename> into <filename><"
"module>-overrides.txt</filename>."
msgstr ""
-"<guilabel>Συλλέγοντας πληροφορίες σχετικά με τον κώδικα.</guilabel> Το "
+"<guilabel>Συλλέγοντας πληροφορίες για τον κώδικα.</guilabel> Το "
"<application>gtkdoc-scan</application> σαρώνει τα αρχεία κεφαλίδων του "
"κώδικα ψάχνοντας για δηλώσεις συναρτήσεων, μακροεντολές, enums, δομές και "
"ενώσεις. Δημιουργεί το αρχείο <filename><module>-decl-list.txt</"
"filename> που περιέχει μια λίστα με τις δηλώσεις, και τις τοποθετεί σε "
-"ενÏ\8cÏ\84ηÏ\84εÏ\82 αναλÏ\8cγÏ\89Ï\82 με Ï\84ο αÏ\81Ï\87είο κεÏ\86αλίδαÏ\82 Ï\80οÏ\85 βρίσκονται. Από την πρώτη "
+"ενÏ\8cÏ\84ηÏ\84εÏ\82 αναλÏ\8cγÏ\89Ï\82 με Ï\84ο αÏ\81Ï\87είο κεÏ\86αλίδαÏ\82 Ï\83Ï\84ο οÏ\80οίο βρίσκονται. Από την πρώτη "
"εκτέλεση του προγράμματος το αρχείο αντιγράφεται στο <filename><"
-"module>-sections.txt</filename>. Î\9f Ï\83Ï\85γγÏ\81αÏ\86ÎαÏ\82 μÏ\80οÏ\81εί να Ï\84ακÏ\84οÏ\80οιήÏ\83ει τις "
-"ενÏ\8cÏ\84ηÏ\84εÏ\82 και Ï\84η Ï\83ειÏ\81ά Ï\84Ï\89ν δηλÏ\8eÏ\83εÏ\89ν, για να Ï\80αÏ\81άξει το επιθυμητό τελικό "
+"module>-sections.txt</filename>. Î\9f Ï\83Ï\85γγÏ\81αÏ\86ÎαÏ\82 μÏ\80οÏ\81εί να Ï\84ακÏ\84οÏ\80οιεί τις "
+"ενÏ\8cÏ\84ηÏ\84εÏ\82 και Ï\84η Ï\83ειÏ\81ά Ï\84Ï\89ν δηλÏ\8eÏ\83εÏ\89ν, για να Ï\80αÏ\81αγάγει το επιθυμητό τελικό "
"αποτέλεσμα. Το δεύτερο αρχείο δημιουργεί το <filename><module>-decl."
"txt</filename>. Το αρχείο αυτό περιέχει τις πλήρεις δηλώσεις που βρέθηκαν "
"από τον σαρωτή.Αν για κάποιο λόγο θέλετε μερικά σύμβολα να εμφανίζονται στην "
-"τεκμηρίωση, όπου η πλήρης δήλωση δεν μπορεί να βρεθεί από τον σαρωτή ή "
-"Ï\80Ï\81ÎÏ\80ει να εμÏ\86ανίζεÏ\84αι διαÏ\86οÏ\81εÏ\84ικά, κάÏ\80οιοÏ\82 μÏ\80οÏ\81εί να τοποθετήσει οντότητες "
-"όμοιες με αυτές <filename><module>-decl.txt</filename> στο αρχείο "
+"τεκμηρίωση, όπου η πλήρης δήλωση δεν μπορεί να βρεθεί από τον σαρωτή, ή "
+"Ï\80Ï\81ÎÏ\80ει να εμÏ\86ανίζεÏ\84αι διαÏ\86οÏ\81εÏ\84ικά, μÏ\80οÏ\81εί κάÏ\80οιοÏ\82 να τοποθετήσει οντότητες "
+"Ï\80αÏ\81Ï\8cμοιεÏ\82 με αÏ\85Ï\84ÎÏ\82 <filename><module>-decl.txt</filename> Ï\83Ï\84ο αÏ\81Ï\87είο "
"<filename><module>-overrides.txt</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:216
+#: C/index.docbook:222
msgid ""
"<application>gtkdoc-scangobj</application> can also be used to dynamically "
"query a library about any GObject subclasses it exports. It saves "
"ιεραρχία κλάσεων καθώς και για τα ορίσματα και σήματα GObject που περιέχει."
#. (itstool) path: listitem/para
-#: C/index.docbook:222
+#: C/index.docbook:228
msgid ""
"<application>gtkdoc-scanobj</application> should not be used anymore. It was "
"needed in the past when GObject was still GtkObject inside gtk+."
"gtk+."
#. (itstool) path: listitem/para
-#: C/index.docbook:229
+#: C/index.docbook:235
msgid ""
"<guilabel>Generating the \"template\" files.</guilabel> <application>gtkdoc-"
"mktmpl</application> creates a number of files in the <filename class="
"<guilabel>Δημιουργία \"πρότυπων\" αρχείων</guilabel> Το <application>gtkdoc-"
"mktmpl</application> παράγει μια σειρά από αρχεία στον υποκατάλογο <filename "
"class=\"directory\">tmpl/</filename>, χρησιμοποιώντας τις πληροφορίες που "
-"συλλέχθηκαν κατά το πρώτο στάδιο. (Σημειώστε ότι μπορεί να εκτελεστεί "
+"συλλέχθηκαν κατά το πρώτο στάδιο. (Σημειώστε ότι μπορεί να εκτελεσθεί "
"περισσότερες από μία φορές. Προσπαθεί να διασφαλίσει ότι δεν χάνεται ποτέ "
"και κανενός είδους τεκμηρίωση.)"
#. (itstool) path: note/para
-#: C/index.docbook:238
+#: C/index.docbook:244
msgid ""
"Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep "
"documentation in the code. <application>gtkdocize</application> supports now "
"skips tmpl usage totally. If you have never changed file in tmpl by hand, "
"please remove the directory (e.g. from version control system)."
msgstr ""
-"Από την έκδοση GTK-Doc 1.9 και μετά τα πρότυπα αρχεία δεν είναι πλέον "
+"Από την έκδοση GTK-Doc 1.9 και μετά, τα πρότυπα αρχεία δεν είναι πλέον "
"απαραίτητα. Σας συνιστούμε να διατηρείτε την τεκμηρίωση στον κώδικα. Το "
"<application>gtkdocize</application> υποστηρίζει πλέον την επιλογή <option>--"
"flavour no-tmpl</option> η οποία επιλέγει ένα αρχείο makefile που δεν "
"σύστημα ελέγχου εκδόσεων)."
#. (itstool) path: listitem/para
-#: C/index.docbook:250
+#: C/index.docbook:256
msgid ""
"<guilabel>Generating the SGML/XML and HTML/PDF.</guilabel> "
"<application>gtkdoc-mkdb</application> turns the template files into SGML or "
"το βιβλίο τεκμηρίωσης XML."
#. (itstool) path: listitem/para
-#: C/index.docbook:261
+#: C/index.docbook:267
msgid ""
"<application>gtkdoc-mkhtml</application> turns the SGML/XML files into HTML "
"files in the <filename class=\"directory\">html/</filename> subdirectory. "
msgstr ""
" Το <application>gtkdoc-mkhtml</application> μετατρέπει τα αρχεία SGML/XML "
"σε αρχεία HTML που τοποθετούνται στον υποκατάλογο <filename class=\"directory"
-"\">html/</filename>. Ομοίως το <application>gtkdoc-mkpdf</application> "
+"\">html/</filename>. Ομοίως
, το <application>gtkdoc-mkpdf</application> "
"μετατρέπει τα αρχεία SGML/XML σε ένα αρχείο PDF που ονομάζεται <filename><"
"package>.pdf</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:267
+#: C/index.docbook:273
msgid ""
"Files in <filename class=\"directory\">sgml/</filename> or <filename class="
"\"directory\">xml/</filename> and <filename class=\"directory\">html/</"
"αλλάζετε με το χέρι."
#. (itstool) path: listitem/para
-#: C/index.docbook:275
+#: C/index.docbook:281
msgid ""
"<guilabel>Fixing up cross-references between documents.</guilabel> After "
"installing the HTML files, <application>gtkdoc-fixxref</application> can be "
"links. When installing distributed (pregenerated) docs the same application "
"will try to turn links back to local links (where those docs are installed)."
msgstr ""
-"<guilabel>Διόρθωση παραπομπών μεταξύ εγγράφων</guilabel> Μετά την "
-"εγκατάσταση των αρχείων HTML, μπορείτε να εκτελέσετε το <application>gtkdoc-"
-"fixxref</application> για να διορθώσετε τυχόν παραπομπές σε διαφορετικά "
-"έγγραφα. Για παράδειγμα, η τεκμηρίωση του GTK+ περιέχει πολλές παραπομπές σε "
-"τύπους που επεξηγούνται στο εγχειρίδιο του GLib. Όταν ετοιμάζετε πακέτα "
-"κώδικα για διανομή, μπορείτε να χρησιμοποιείτε το <application>gtkdoc-"
-"rebase</application> για να μετατρέπετε όλους τους εξωτερικούς συνδέσμους σε "
-"διαδικτυακούς συνδέσμους. Κατά την εγκατάσταση της τεκμηρίωσης που "
-"περιλαμβάνεται στο διανεμηθέντα κώδικα (παράγεται αυτόματα), η ίδια εφαρμογή "
-"θα προσπαθήσει να μετατρέψει ξανά τους συνδέσμους σε τοπικούς συνδέσμους "
-"(προς τις τοποθεσίες όπου είναι εγκατεστημένη η τεκμηρίωση)."
+"<guilabel>Διόρθωση διασταυρούμενων παραπομπών μεταξύ εγγράφων</guilabel> "
+"Μετά την εγκατάσταση των αρχείων HTML, μπορείτε να εκτελέσετε το "
+"<application>gtkdoc-fixxref</application> για να διορθώσετε τυχόν "
+"διασταυρούμενες παραπομπές σε διαφορετικά έγγραφα. Για παράδειγμα, η "
+"τεκμηρίωση του GTK+ περιέχει πολλές παραπομπές σε τύπους που επεξηγούνται "
+"στο εγχειρίδιο του GLib. Όταν ετοιμάζετε πακέτα κώδικα για διανομή, μπορείτε "
+"να χρησιμοποιείτε το <application>gtkdoc-rebase</application> για να "
+"μετατρέπετε όλους τους εξωτερικούς συνδέσμους σε διαδικτυακούς συνδέσμους. "
+"Κατά την εγκατάσταση της τεκμηρίωσης που περιλαμβάνεται στον διανεμηθέντα "
+"κώδικα (παράγεται αυτόματα), η ίδια εφαρμογή θα προσπαθήσει να μετατρέψει "
+"ξανά τους συνδέσμους σε τοπικούς συνδέσμους (προς τις τοποθεσίες όπου είναι "
+"εγκατεστημένη η τεκμηρίωση)."
#. (itstool) path: sect1/title
-#: C/index.docbook:293
+#: C/index.docbook:299
msgid "Getting GTK-Doc"
msgstr "Λήψη GTK-Doc"
#. (itstool) path: sect2/title
-#: C/index.docbook:296
+#: C/index.docbook:302
msgid "Requirements"
msgstr "Απαιτήσεις"
#. (itstool) path: sect2/para
-#: C/index.docbook:297
+#: C/index.docbook:303
msgid "<guilabel>Perl v5</guilabel> - the main scripts are in Perl."
msgstr ""
"<guilabel>Perl v5</guilabel> - τα βασικά σενάρια είναι γραμμένα σε Perl."
#. (itstool) path: sect2/para
-#: C/index.docbook:300
+#: C/index.docbook:306
msgid ""
-"<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. <ulink "
-"url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel> - the xslt processor from libxslt <ulink url="
+"\"http://xmlsoft.org/XSLT/\" type=\"http\">xmlsoft.org/XSLT/</ulink>"
msgstr ""
-"<guilabel>DocBook DTD v3.0</guilabel> - Πρόκειται για την DocBook SGML DTD. "
-"<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel> - το πρόγραμμα xslt processor από τη "
+"βιβλιοθήκη libxslt <ulink url=\"http://xmlsoft.org/XSLT/\" type=\"http"
+"\">xmlsoft.org/XSLT/</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:304
+#: C/index.docbook:310
msgid ""
-"<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
-"SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
-"\"http\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets <ulink url="
+"\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type=\"http"
+"\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
msgstr ""
-"<guilabel>Jade v1.1</guilabel> - Πρόκειται για επεξεργαστή DSSSL που "
-"μετατρέπει τη SGML σε διάφορες άλλες μορφές. <ulink url=\"http://www.jclark."
-"com/jade\" type=\"http\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel> - τα docbook xsl stylesheets <ulink url="
+"\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type=\"http"
+"\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:308
-msgid ""
-"<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code to "
-"convert DocBook to HTML (and a few other formats). It's used together with "
-"jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour the "
-"program code listings/declarations, and to support global cross-reference "
-"indices in the generated HTML. <ulink url=\"http://nwalsh.com/docbook/dsssl"
-"\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
-msgstr ""
-"<guilabel>Modular DocBook Stylesheets</guilabel> Πρόκειται για τον κώδικα "
-"DSSSL που απαιτείται για τη μετατροπή από DocBook σε HTML (και ορισμένες "
-"άλλες μορφές). Χρησιμοποιείται σε συνδυασμό με το jade. Έχουν γίνει κάποιες "
-"μικρές προσαρμογές του κώδικα DSSSL, στο gtk-doc.dsl, για το χρωματισμό "
-"κώδικα/δηλώσεων και για την υποστήριξη των καθολικών ευρετηρίων παραπομπών "
-"στα παραγόμενα HTML. <ulink url=\"http://nwalsh.com/docbook/dsssl\" type="
-"\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
+#: C/index.docbook:314
+msgid "<guilabel>Python</guilabel> - optional - for gtkdoc-depscan"
+msgstr "<guilabel>Python</guilabel> - προαιρετική - για το gtkdoc-depscan"
#. (itstool) path: sect2/para
#: C/index.docbook:317
msgid ""
-"<guilabel>docbook-to-man</guilabel> - if you want to create man pages from "
-"the DocBook. I've customized the 'translation spec' slightly, to capitalise "
-"section headings and add the 'GTK Library' title at the top of the pages and "
-"the revision date at the bottom. There is a link to this on <ulink url="
-"\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/davenport</"
-"ulink> NOTE: This does not work yet."
-msgstr ""
-"<guilabel>docbook-to-man</guilabel> - Σε περίπτωση που θέλετε να "
-"δημιουργήσετε σελίδες man από το DocBook. Έχουν γίνει κάποιες μικρές "
-"προσαρμογές των 'προδιαγραφών μετάφρασης', για να εμφανίζονται με κεφαλαία "
-"οι τίτλοι ενοτήτων και να προστίθενται ο τίτλος 'Βιβλιοθήκη GTK' στην αρχή "
-"της σελίδας και η ημερομηνία αναθεώρησης στο τέλος της. Βλέπε <ulink url="
-"\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/davenport</"
-"ulink> ΣΗΜΕΙΩΣΗ: Αυτή η δυνατότητα δε λειτουργεί προς το παρόν."
-
-#. (itstool) path: sect2/title
-#: C/index.docbook:328
-msgid "Installation"
-msgstr "Εγκατάσταση"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:329
-msgid ""
-"There is no standard place where the DocBook Modular Stylesheets are "
-"installed."
-msgstr ""
-"Δεν υπάρχει σταθερή τοποθεσία για την εγκατάσταση των DocBook Modular "
-"Stylesheets."
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:332
-msgid "GTK-Doc's configure script searches these 3 directories automatically:"
-msgstr ""
-"Το σενάριο εντολών configure του GTK-Doc ψάχνει αυτόματα τους τρεις παρακάτω "
-"καταλόγους:"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:335
-msgid ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
-"RedHat)"
-msgstr ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> "
-"(χρησιμοποιείται από το RedHat)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:338
-msgid ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
-msgstr ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (χρησιμοποιείται "
-"από το Debian)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:341
-msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
-msgstr ""
-"<filename> /usr/share/sgml/docbkdsl </filename> (χρησιμοποιείται από το SuSE)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:344
-msgid ""
-"If you have the stylesheets installed somewhere else, you need to configure "
-"GTK-Doc using the option: <command> --with-dsssl-dir=<"
-"PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+"One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> "
+"or <guilabel>vim</guilabel> - optional - used for syntax highlighting of "
+"examples"
msgstr ""
-"Î\91ν Ï\84α Ï\86Ï\8dλλα Ï\83Ï\84Ï\85λ είναι εγκαÏ\84εÏ\83Ï\84ημÎνα κάÏ\80οÏ\85 αλλοÏ\8d, θα Ï\80Ï\81ÎÏ\80ει να Ï\81Ï\85θμίÏ\83εÏ\84ε GTK-"
-"Doc με την επιλογή: <command> --with-dsssl-dir=< "
-"ΔΙΑΔΡΟΜΗ_ΠΡΟΣ_ΡΙΖΙΚΟ_ΚΑΤΑΛΟΓΟ_ΦΥΛΛΩΝ_ΣΤΥΛ> </command>"
+"Î\88να αÏ\80Ï\8c Ï\84α <guilabel>source-highlight</guilabel>, <guilabel>highlight</"
+"guilabel> ή <guilabel>vim</guilabel> - optional - που χρησιμοποιούνται για "
+"την επισήμανση της σύνταξης στα παραδείγματα"
#. (itstool) path: sect1/title
-#: C/index.docbook:368
+#: C/index.docbook:325
msgid "About GTK-Doc"
msgstr "Περί GTK-Doc"
#. (itstool) path: sect1/para
-#: C/index.docbook:370 C/index.docbook:384
+#: C/index.docbook:327 C/index.docbook:341
msgid "(FIXME)"
msgstr "(ΠΡΟΣ ΔΙΟΡΘΩΣΗ)"
#. (itstool) path: sect1/para
-#: C/index.docbook:374
+#: C/index.docbook:331
msgid ""
-"(History, authors, web pages, license, future plans, comparison with other "
-"similar systems.)"
+"(History, authors, web pages, mailing list, license, future plans, "
+"comparison with other similar systems.)"
msgstr ""
-"(Ιστορικό, συγγραφείς, ιστοσελίδες, άδεια, μελλοντικά σχέδια, σύγκριση με "
-"άλλα παρόμοια συστήματα.)"
+"(Ιστορικό, συγγραφείς, ιστοσελίδες, ταχυδρομική λίστα, άδεια, μελλοντικά "
+"σχέδια, σύγκριση με άλλα παρόμοια συστήματα.)"
#. (itstool) path: sect1/title
-#: C/index.docbook:382
+#: C/index.docbook:339
msgid "About this Manual"
msgstr "Περί του εγχειριδίου"
#. (itstool) path: sect1/para
-#: C/index.docbook:388
+#: C/index.docbook:345
msgid "(who it is meant for, where you can get it, license)"
msgstr "(σε ποιους απευθύνεται, πού θα το βρείτε, άδεια)"
#. (itstool) path: chapter/title
-#: C/index.docbook:397
+#: C/index.docbook:354
msgid "Setting up your project"
-msgstr "Δημιουργώντας ένα έργο"
+msgstr "Δημιουργώντας το δικό σας έργο"
#. (itstool) path: chapter/para
-#: C/index.docbook:399
+#: C/index.docbook:356
msgid ""
"The next sections describe what steps to perform to integrate GTK-Doc into "
"your project. Theses sections assume we work on a project called 'meep'. "
"build setup."
msgstr ""
"Οι επόμενες ενότητες περιγράφουν τα βήματα που απαιτούνται για να "
-"ενσωματώσετε το GTK-Doc στο έργο σας. Υποθέστε ότι εργάζεστε στο έργο "
-"'meep'. Το έργο περιέχει τη βιβλιοθήκη 'libmeep' και την εφαρμογή 'meeper' "
-"για τον τελικό χρήστη. Υποθέστε επίσης ότι θα χρησιμοποιήσουμε το autoconf "
-"και το automake. Επιπλέον η ενότητα <link linkend=\"plain_makefiles\">αρχεία "
-"makefiles ή άλλα συστήματα ανάπτυξης</link> περιγράφει τα βασικά που "
-"χρειάζονται για να δουλέψουμε σε διαφορετικό έργο."
+"ενσωματώσετε το GTK-Doc στο έργο σας. Αυτές οι ενότητες προϋποθέτουν ότι "
+"εργάζεσθε σε ένα έργο που λέγεται 'meep'. Το έργο περιέχει τη βιβλιοθήκη "
+"'libmeep' και την εφαρμογή 'meeper' για τον τελικό χρήστη. Προϋποτίθεται "
+"επίσης ότι θα χρησιμοποιείτε το autoconf και το automake. Επιπλέον, η "
+"ενότητα <link linkend=\"plain_makefiles\">αρχεία makefiles ή άλλα συστήματα "
+"ανάπτυξης</link> περιγράφει τα βασικά που χρειάζονται για να δουλέψετε σε "
+"ένα διαφορετικό έργο."
#. (itstool) path: sect1/title
-#: C/index.docbook:410
+#: C/index.docbook:367
msgid "Setting up a skeleton documentation"
msgstr "Δημιουργία του σκελετού τεκμηρίωσης"
#. (itstool) path: sect1/para
-#: C/index.docbook:412
+#: C/index.docbook:369
msgid ""
"Under your top-level project directory create folders called docs/reference "
"(this way you can also have docs/help for end-user documentation). It is "
"περιλαμβάνουν μόνο μία βιβλιοθήκη."
#. (itstool) path: example/title
-#: C/index.docbook:421
+#: C/index.docbook:378
msgid "Example directory structure"
msgstr "Παράδειγμα δομής καταλόγου"
#. (itstool) path: example/programlisting
-#: C/index.docbook:422
+#: C/index.docbook:379
#, no-wrap
msgid ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:419
+#: C/index.docbook:376
msgid "This can then look as shown below: <_:example-1/>"
-msgstr "Αυτό θα φαίνεται όπως είναι παρακάτω: <_:example-1/>"
+msgstr "Αυτό θα φαίνεται, λοιπόν, όπως εμφανίζεται παρακάτω: <_:example-1/>"
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:439 C/index.docbook:446
+#: C/index.docbook:394 C/index.docbook:401
msgid "Integration with autoconf"
msgstr "Ενσωμάτωση στο autoconf"
#. (itstool) path: sect1/para
-#: C/index.docbook:441
+#: C/index.docbook:396
msgid ""
"Very easy! Just add one line to your <filename>configure.ac</filename> "
"script."
"filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:447
+#: C/index.docbook:402
#, no-wrap
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"# έλεγχος για gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
#. (itstool) path: example/title
-#: C/index.docbook:461
+#: C/index.docbook:414
msgid "Keep gtk-doc optional"
msgstr "Προαιρετικά κρατήστε το gtk-doc"
#. (itstool) path: example/programlisting
-#: C/index.docbook:462
+#: C/index.docbook:415
#, no-wrap
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"# έλεγχος για gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:456
+#: C/index.docbook:409
msgid ""
"This will require all developers to have gtk-doc installed. If it is okay "
"for your project to have optional api-doc build setup, you can solve this as "
"below. Keep it as is, as gtkdocize is looking for <function>GTK_DOC_CHECK</"
"function> at the start of a line. <_:example-1/>"
msgstr ""
-"Î\91Ï\85Ï\84Ï\8c θα εÏ\80αιÏ\84εί Ï\8cλοι οι Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 να ÎÏ\87οÏ\85ν εγκαÏ\84εÏ\83Ï\84ημÎνο Ï\84ο gtk-doc. "
-"Αν είναι εντάξει για το έργο σας να έχετε επιπλέον κατασκευή ρυθμίσεων για "
-"Ï\84ο api-doc, μÏ\80οÏ\81είÏ\84ε να Ï\84ο εÏ\80ιλÏ\8dÏ\83εÏ\84ε Ï\8cÏ\80Ï\89Ï\82 αναÏ\86ÎÏ\81εÏ\84ε Ï\80αÏ\81ακάÏ\84Ï\89. Î\91Ï\86ήÏ\83Ï\84ε Ï\84ο Ï\8cÏ\80Ï\89Ï\82 "
-"ÎÏ\87ει, Ï\8cÏ\83ο Ï\84ο gtkdocize Ï\88άÏ\87νει Ï\83την αρχή της σειράς για το "
+"Î\91Ï\85Ï\84Ï\8c αÏ\80αιÏ\84εί αÏ\80Ï\8c Ï\8cλοÏ\85Ï\82 Ï\84οÏ\85Ï\82 Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 να ÎÏ\87οÏ\85ν εγκαÏ\84εÏ\83Ï\84ημÎνο Ï\84ο gtk-"
+"doc. Αν είναι εντάξει για το έργο σας να έχετε μια επιπλέον κατασκευή "
+"Ï\81Ï\85θμίÏ\83εÏ\89ν για Ï\84ο api-doc, μÏ\80οÏ\81είÏ\84ε να Ï\84ο εÏ\80ιλÏ\8dÏ\83εÏ\84ε Ï\8cÏ\80Ï\89Ï\82 αναÏ\86ÎÏ\81εÏ\84αι Ï\80αÏ\81ακάÏ\84Ï\89. "
+"Î\91Ï\86ήÏ\83Ï\84ε Ï\84ο Ï\89Ï\82 ÎÏ\87ει, Ï\8cÏ\83ο Ï\84ο gtkdocize αναζηÏ\84ά την αρχή της σειράς για το "
"<function>GTK_DOC_CHECK</function>. <_:example-1/>"
#. (itstool) path: sect1/para
-#: C/index.docbook:475
+#: C/index.docbook:426
msgid ""
"The first argument is used to check for the gtkdocversion at configure time. "
"The 2nd, optional argument is used by <application>gtkdocize</application>. "
"symbol> επίσης προσθέτει αρκετούς διακόπτες ρύθμισης:"
#. (itstool) path: listitem/para
-#: C/index.docbook:481
+#: C/index.docbook:432
msgid "--with-html-dir=PATH : path to installed docs"
msgstr "--with-html-dir=ΔΙΑΔΡΟΜΗ : διαδρομή προς την εγκατεστημένη τεκμηρίωση"
#. (itstool) path: listitem/para
-#: C/index.docbook:482
+#: C/index.docbook:433
msgid "--enable-gtk-doc : use gtk-doc to build documentation [default=no]"
-msgstr "--enable-gtk-doc : χρήση gtk-doc για την τεκμηρίωσης [default=no]"
+msgstr "--enable-gtk-doc : χρήση gtk-doc για την τεκμηρίωση [default=no]"
#. (itstool) path: listitem/para
-#: C/index.docbook:483
+#: C/index.docbook:434
msgid ""
"--enable-gtk-doc-html : build documentation in html format [default=yes]"
msgstr ""
"--enable-gtk-doc-html : παραγωγή τεκμηρίωσης σε μορφή html [default=yes]"
#. (itstool) path: listitem/para
-#: C/index.docbook:484
+#: C/index.docbook:435
msgid "--enable-gtk-doc-pdf : build documentation in pdf format [default=no]"
msgstr "--enable-gtk-doc-pdf : παραγωγή τεκμηρίωσης σε μορφή pdf [default=no]"
#. (itstool) path: important/para
-#: C/index.docbook:488
+#: C/index.docbook:439
msgid ""
"GTK-Doc is disabled by default! Remember to pass the option <option>'--"
"enable-gtk-doc'</option> to the next <filename>configure</filename> run. "
"Otherwise pregenerated documentation is installed (which makes sense for "
"users but not for developers)."
msgstr ""
-"Î\97 Ï\80Ï\81οεÏ\80ιλογή είναι να είναι αÏ\80ενεÏ\81γοÏ\80οιημÎνο Ï\84ο GTK-Doc! Î\98Ï\85μηθείτε να "
-"Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83ετε την επιλογή <option>'--enable-gtk-doc'</option> στην επόμενη "
-"εκτέλεση του <filename>configure</filename>. Διαφορετικά εγκαθίσταται η "
-"προπαραχθείσα τεκμηρίωση (δυνατότητα χρήσιμη για το χρήστη, αλλά όχι για τον "
-"προγραμματιστή)."
+"Το GTK-Doc είναι αÏ\80ενεÏ\81γοÏ\80οιημÎνο αÏ\80Ï\8c Ï\80Ï\81οεÏ\80ιλογή! Î\9dα θÏ\85μάÏ\83τε να "
+"Ï\87Ï\81ηÏ\83ιμοÏ\80οιείτε την επιλογή <option>'--enable-gtk-doc'</option> στην επόμενη "
+"εκτέλεση του <filename>configure</filename>. Διαφορετικά, εγκαθίσταται η "
+"προπαραχθείσα τεκμηρίωση (δυνατότητα χρήσιμη για τον χρήστη, αλλά όχι για "
+"Ï\84ον Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ή)."
#. (itstool) path: sect1/para
-#: C/index.docbook:496
+#: C/index.docbook:447
msgid ""
"Furthermore it is recommended that you have the following line inside you "
"<filename>configure.ac</filename> script. This allows "
"<function>GTK_DOC_CHECK</function> στο έργο σας."
#. (itstool) path: example/title
-#: C/index.docbook:504
+#: C/index.docbook:455
msgid "Preparation for gtkdocize"
msgstr "Προετοιμασία για το gtkdocize"
#. (itstool) path: example/programlisting
-#: C/index.docbook:505
+#: C/index.docbook:456
#, no-wrap
msgid ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:461
+msgid ""
+"After all changes to <filename>configure.ac</filename> are made, update the "
+"<filename>configure</filename> file. This can be done by re-running "
+"<code>autoreconf -i</code> or <code>autogen.sh</code>."
+msgstr ""
+"Όταν όλες οι αλλαγές στο <filename>configure.ac</filename> έχουν γίνει, "
+"ενημερώστε το αρχείο <filename>ρύθμιση</filename>. Αυτό μπορείτε να το "
+"κάνετε επανεκετελώντας το <code>autoreconf -i</code> ή το <code>autogen.sh</"
+"code>."
#. (itstool) path: sect1/title
-#: C/index.docbook:515
+#: C/index.docbook:469
msgid "Integration with automake"
msgstr "Ενσωμάτωση στο automake"
#. (itstool) path: sect1/para
-#: C/index.docbook:517
+#: C/index.docbook:471
msgid ""
-"First copy the <filename>Makefile.am</filename> from the examples "
-"subdirectory of the gtkdoc-sources to your project's API documentation "
-"directory ( <filename class=\"directory\">./docs/reference/<package></"
-"filename>). If you have multiple doc-packages repeat this for each one."
+"First copy the <filename>Makefile.am</filename> from the <filename class="
+"\"directory\">examples</filename> sub directory of the <ulink url=\"https://"
+"git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am\">gtkdoc-sources</"
+"ulink> to your project's API documentation directory ( <filename class="
+"\"directory\">./docs/reference/<package></filename>). A local copy "
+"should be available under e.g. <filename>/usr/share/doc/gtk-doc-tools/"
+"examples/Makefile.am</filename>. If you have multiple doc-packages repeat "
+"this for each one."
msgstr ""
"Πρώτα αντιγράψτε το <filename>Makefile.am</filename> από τον υποκατάλογο με "
-"τα παραδείγματα των gtkdoc-sources στον κατάλογο της τεκμηρίωσης API του "
-"έργου σας ( <filename class=\"directory\">./docs/reference/<package></"
-"filename>). Αν έχετε περισσότερα από ένα πακέτα τεκμηρίωσης, επαναλάβετε τη "
-"διαδικασία για καθένα από αυτά."
+"τα <filename class=\"directory\">παραδείγματα</filename> των <ulink url="
+"\"https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am\">gtkdoc-"
+"sources</ulink> στον κατάλογο της τεκμηρίωσης API του έργου σας ( <filename "
+"class=\"directory\">./docs/reference/<package></filename>). Ένα τοπικό "
+"αντίγραφο θα πρέπει να είναι διαθέσιμο π.χ. στο <filename>/usr/share/doc/gtk-"
+"doc-tools/examples/Makefile.am</filename>. Αν έχετε πολλά doc-packages "
+"επαναλάβετε αυτό το βήμα για το καθένα απο αυτά."
#. (itstool) path: sect1/para
-#: C/index.docbook:524
+#: C/index.docbook:482
msgid ""
"The next step is to edit the settings inside the <filename>Makefile.am</"
"filename>. All the settings have a comment above that describes their "
"επιλογή <option>--help</option> για την παραγωγή λίστας με τις "
"υποστηριζόμενες παραμέτρους."
-#. (itstool) path: sect1/para
-#: C/index.docbook:535
-msgid ""
-"You may also want to enable GTK-Doc for the distcheck make target. Just add "
-"the one line shown in the next example to your top-level <filename>Makefile."
-"am</filename>:"
-msgstr ""
-"Μπορείτε, επίσης, να ενεργοποιήσετε το GTK-Doc για το distcheckmake target. "
-"Απλά προσθέστε τη γραμμή του επόμενου παραδείγματος στο ριζικό "
-"<filename>Makefile.am</filename>:"
-
-#. (itstool) path: example/title
-#: C/index.docbook:542
-msgid "Enable GTK-Doc during make distcheck"
-msgstr "Ενεργοποίηση του GTK-Doc κατά το make distcheck"
-
-#. (itstool) path: example/programlisting
-#: C/index.docbook:543
-#, no-wrap
-msgid ""
-"\n"
-"\n"
-"DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
-"\n"
-" "
-msgstr ""
-"\n"
-"\n"
-"DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
-"\n"
-" "
-
#. (itstool) path: sect1/title
-#: C/index.docbook:554
+#: C/index.docbook:496
msgid "Integration with autogen"
msgstr "Ενσωμάτωση στο autogen"
#. (itstool) path: sect1/para
-#: C/index.docbook:556
+#: C/index.docbook:498
msgid ""
"Most projects will have an <filename>autogen.sh</filename> script to setup "
"the build infrastructure after a checkout from version control system (such "
"autoheader, automake or autoconf."
msgstr ""
"Τα περισσότερα έργα διαθέτουν ένα σενάριο <filename>autogen.sh</filename> "
-"για τη δημιουργία υποδομών μετά από το checkout από ένα το σύστημα ελέγχου "
+"για τη δημιουργία υποδομών μετά από έναν έλεγχο από το σύστημα ελέγχου "
"εκδόσεων (π.χ., cvs/svn/git). Το GTK-Doc διαθέτει το εργαλείο "
"<filename>gtkdocize</filename>, το οποίο μπορεί να χρησιμοποιηθεί για ένα "
"τέτοιο σενάριο. Θα πρέπει να εκτελείται πριν το autoheader, το automake ή το "
"autoconf."
#. (itstool) path: example/title
-#: C/index.docbook:565
+#: C/index.docbook:507
msgid "Running gtkdocize from autogen.sh"
msgstr "Εκτέλεση του gtkdocize από το autogen.sh"
#. (itstool) path: example/programlisting
-#: C/index.docbook:566
+#: C/index.docbook:508
#, no-wrap
msgid ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:574
+#: C/index.docbook:514
msgid ""
"When running <application>gtkdocize</application> it copies <filename>gtk-"
"doc.make</filename> to your project root (or any directory specified by the "
"function>."
#. (itstool) path: sect1/para
-#: C/index.docbook:583
+#: C/index.docbook:523
msgid ""
"Historically GTK-Doc was generating template files where developers entered "
"the docs. This turned out to be not so good (e.g. the need for having "
msgstr ""
"Αρχικά, το GTK-Doc δημιουργούσε αρχεία προτύπων εκεί που οι προγραμματιστές "
"εισήγαγαν την τεκμηρίωση. Δυστυχώς, αυτή η προσέγγιση δεν ήταν ιδιαίτερα "
-"εÏ\80ιÏ\84Ï\85Ï\87ήÏ\82 (Ï\80.Ï\87 η ανάγκη για Ï\84ην Ï\80αÏ\81αγÏ\89γή αÏ\81Ï\87είÏ\89ν Ï\83Ï\84ο Ï\83Ï\8dÏ\83Ï\84ημα ελÎγÏ\87οÏ\85 "
-"εκδÏ\8cÏ\83εÏ\89ν). Î\91Ï\80Ï\8c Ï\84ην ÎκδοÏ\83η 1.9 και μεÏ\84ά, Ï\84α Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α αÏ\81Ï\87εία δεν είναι Ï\80λÎον "
-"αÏ\80αÏ\81αίÏ\84ηÏ\84α. ΣαÏ\82 Ï\83Ï\85νιÏ\83Ï\84οÏ\8dμε να διαÏ\84ηÏ\81είÏ\84ε Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η Ï\83Ï\84ον κÏ\8eδικα. To "
+"εÏ\80ιÏ\84Ï\85Ï\87ήÏ\82 (Ï\80.Ï\87 η ανάγκη για Ï\80αÏ\81αγÏ\89γή αÏ\81Ï\87είÏ\89ν Ï\83Ï\84ο Ï\83Ï\8dÏ\83Ï\84ημα ελÎγÏ\87οÏ\85 εκδÏ\8cÏ\83εÏ\89ν). "
+"Î\91Ï\80Ï\8c Ï\84ην ÎκδοÏ\83η 1.9 και μεÏ\84ά, Ï\84α Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α αÏ\81Ï\87εία δεν είναι Ï\80λÎον αÏ\80αÏ\81αίÏ\84ηÏ\84α. "
+"Σας συνιστούμε να διατηρείτε την τεκμηρίωση στον κώδικα. To "
"<application>gtkdocize</application> υποστηρίζει πλέον την επιλογή <option>--"
"flavour no-tmpl</option> που επιλέγει ένα αρχείο makefile που δεν "
"χρησιμοποιεί καθόλου πρότυπα tmpl. Πέρα από την άμεση προσθήκη της επιλογής "
"στην κλήση της εντολής, μπορεί να προστεθεί και σε μια μεταβλητή "
-"περιβάλλοντος που ονομάζεται <symbol>GTKDOCIZE_FLAGS</symbol> ή να οριστεί "
+"περιβάλλοντος που ονομάζεται <symbol>GTKDOCIZE_FLAGS</symbol> ή να ορισθεί "
"ως δεύτερη παράμετρος στη μακροεντολή <symbol>GTK_DOC_CHECK</symbol> στο "
"σενάριο configure. Αν δεν έχετε κάνει ποτέ αλλαγές με το χέρι σε αρχεία "
"προτύπων και μεταβαίνετε από μια παλιότερη έκδοση του gtkdoc, παρακαλώ "
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:600 C/index.docbook:617
+#: C/index.docbook:540 C/index.docbook:557
msgid "Running the doc build"
msgstr "Παραγωγή της τεκμηρίωσης"
#. (itstool) path: sect1/para
-#: C/index.docbook:602
+#: C/index.docbook:542
msgid ""
"After the previous steps it's time to run the build. First we need to rerun "
"<filename>autogen.sh</filename>. If this script runs configure for you, then "
"<filename>configure</filename> with this option afterwards."
msgstr ""
"Αφού ολοκληρωθούν τα προηγούμενα βήματα, προχωρήστε στην παραγωγή. Πρώτα, θα "
-"πρέπει να εκτελεστεί εκ νέου το <filename>autogen.sh</filename>. Αν το "
+"πρέπει να εκτελεσθεί εκ νέου το <filename>autogen.sh</filename>. Αν το "
"σενάριο εκτελεί και το configure, προσθέστε την επιλογή <option>--enable-gtk-"
"doc</option>. Διαφορετικά, εκτελέστε εσείς το<filename>configure</filename> "
"με αυτή την επιλογή."
#. (itstool) path: sect1/para
-#: C/index.docbook:609
+#: C/index.docbook:549
msgid ""
"The first make run generates several additional files in the doc-"
"directories. The important ones are: <filename><package>.types</"
"παρελθόν .sgml), <filename><package>-sections.txt</filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:618
+#: C/index.docbook:558
#, no-wrap
msgid ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:626
+#: C/index.docbook:564
msgid ""
"Now you can point your browser to <filename>docs/reference/<package>/"
"index.html</filename>. Yes, it's a bit disappointing still. But hang-on, "
"κεφάλαιο θα μάθετε πώς μπορείτε να ζωντανέψετε τις σελίδες σας."
#. (itstool) path: sect1/title
-#: C/index.docbook:634
+#: C/index.docbook:572
msgid "Integration with version control systems"
msgstr "Ενσωμάτωση σε συστήματα ελέγχου εκδόσεων"
#. (itstool) path: sect1/para
-#: C/index.docbook:636
+#: C/index.docbook:574
msgid ""
"As a rule of the thumb, it's those files you edit, that should go under "
"version control. For typical projects it's these files: <filename><"
"(in the past .sgml), <filename><package>-sections.txt</filename>, "
"<filename>Makefile.am</filename>"
msgstr ""
-"Ο εμπειρικός κανόνας είναι ότι αυτά τα αρχεία που επεξεργαστήκατε πρέπει να "
+"Ο εμπειρικός κανόνας είναι ότι αυτά τα αρχεία που επεξεργασθήκατε πρέπει να "
"περάσουν από τον έλεγχο έκδοσης. Για τυπικά έργα, πρόκειται για τα αρχεία: "
"<filename><package>.types</filename>, <filename><package>-docs.."
"xml</filename> (στο παρελθόν .sgml), <filename><package>-sections.txt</"
"filename>, <filename>Makefile.am</filename>"
#. (itstool) path: sect1/title
-#: C/index.docbook:647
+#: C/index.docbook:585
msgid "Integration with plain makefiles or other build systems"
msgstr "Ενσωμάτωση στα αρχεία makefiles ή άλλα συστήματα ανάπτυξης"
#. (itstool) path: sect1/para
-#: C/index.docbook:649
+#: C/index.docbook:587
msgid ""
"In the case one does not want to use automake and therefore <filename>gtk-"
"doc.mak</filename> one will need to call the gtkdoc tools in the right order "
"in own makefiles (or other build tools)."
msgstr ""
-"Στην περίπτωση που κάποιος δεν θέλει να χρησιμοποιήσει το automake και "
-"επομένως το <filename>gtk-doc.mak</filename> θα χρειαστεί να καλέσει τα "
+"Στην περίπτωση που κάποιος δε θέλει να χρησιμοποιήσει το automake και, "
+"επομένως, το <filename>gtk-doc.mak</filename> θα χρειαστεί να καλέσει τα "
"εργαλεία του gtkdoc στη σωστή σειρά στα makefiles (ή άλλα εργαλεία "
"ανάπτυξης)."
#. (itstool) path: example/title
-#: C/index.docbook:656
+#: C/index.docbook:594
msgid "Documentation build steps"
msgstr "Βήματα παραγωγής τεκμηρίωσης"
#. (itstool) path: example/programlisting
-#: C/index.docbook:657
+#: C/index.docbook:595
#, no-wrap
msgid ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// sources have changed\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// sources have changed\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:673
+#: C/index.docbook:609
msgid ""
"One will need to look at the <filename>Makefile.am</filename> and "
"<filename>gtk-doc.mak</filename> to pick the extra options needed."
"χρειάζονται."
#. (itstool) path: chapter/title
-#: C/index.docbook:682
+#: C/index.docbook:618
msgid "Documenting the code"
msgstr "Τεκμηρίωση κώδικα"
#. (itstool) path: chapter/para
-#: C/index.docbook:684
+#: C/index.docbook:620
msgid ""
"GTK-Doc uses source code comment with a special syntax for code "
"documentation. Further it retrieves information about your project structure "
"λεπτομέρειες για τη σύνταξη αυτών των σχολίων."
#. (itstool) path: note/title
-#: C/index.docbook:692
+#: C/index.docbook:628
msgid "Documentation placement"
msgstr "Τοποθέτηση τεκμηρίωσης"
#. (itstool) path: note/para
-#: C/index.docbook:693
+#: C/index.docbook:629
msgid ""
"In the past most documentation had to be filled into files residing inside "
"the <filename>tmpl</filename> directory. This has the disadvantages that the "
"συγκρούσεις με τα συστήματα ελέγχου εκδόσεων."
#. (itstool) path: note/para
-#: C/index.docbook:699
+#: C/index.docbook:635
msgid ""
"The avoid the aforementioned problems we suggest putting the documentation "
"inside the sources. This manual will only describe this way of documenting "
"περιγράψουμε σε αυτό το εγχειρίδιο."
#. (itstool) path: example/title
-#: C/index.docbook:710 C/index.docbook:729
+#: C/index.docbook:646 C/index.docbook:663
msgid "GTK-Doc comment block"
msgstr "Μπλοκ σχολίου GTK-Doc"
#. (itstool) path: example/programlisting
-#: C/index.docbook:711
+#: C/index.docbook:647
#, no-wrap
msgid ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* unparseable code here */\n"
"#endif\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* unparseable code here */\n"
"#endif\n"
-"\n"
-" "
#. (itstool) path: chapter/para
-#: C/index.docbook:706
+#: C/index.docbook:642
msgid ""
"The scanner can handle the majority of C headers fine. In the case of "
"receiving warnings from the scanner that look like a special case, one can "
"hint GTK-Doc to skip over them. <_:example-1/>"
msgstr ""
-"Ο σαρωτής μπορεί να χειριστεί άνετα την πλειοψηφία των κεφαλίδων C . Σε "
+"Ο σαρωτής μπορεί να χειρισθεί άνετα την πλειοψηφία των κεφαλίδων C . Σε "
"περίπτωση που παίρνετε προειδοποιήσεις από τον σαρωτή οι οποίες μοιάζουν με "
"έναν ειδικό χαρακτήρα, μπορείτε να υποδείξετε στο GTK-Doc να τους "
"παραλείψει. <_:example-1/>"
#. (itstool) path: sect1/title
-#: C/index.docbook:724
+#: C/index.docbook:658
msgid "Documentation comments"
msgstr "Σχόλια τεκμηρίωσης"
#. (itstool) path: example/programlisting
-#: C/index.docbook:730
+#: C/index.docbook:664
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" * documentation ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" * documentation ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:726
+#: C/index.docbook:660
msgid ""
"A multiline comment that starts with an additional '*' marks a documentation "
"block that will be processed by the GTK-Doc tools. <_:example-1/>"
"Doc. <_:example-1/>"
#. (itstool) path: sect1/para
-#: C/index.docbook:741
+#: C/index.docbook:673
msgid ""
"The 'identifier' is one line with the name of the item the comment is "
"related to. The syntax differs a little depending on the item. (TODO add "
"στοιχείου. (ΜΕΛΛΟΝΤΙΚΑ: να προστεθεί πίνακας με τα αναγνωριστικά)"
#. (itstool) path: sect1/para
-#: C/index.docbook:747
+#: C/index.docbook:679
msgid ""
"The 'documentation' block is also different for each symbol type. Symbol "
"types that get parameters such as functions or macros have the parameter "
"κώδικα)."
#. (itstool) path: listitem/para
-#: C/index.docbook:764
+#: C/index.docbook:696
msgid ""
"What it is: The name for a class or function can sometimes be misleading for "
"people coming from a different background."
"παραπλανητικό για ανθρώπους που δεν έχουν τεχνογνωσία στο θέμα."
#. (itstool) path: listitem/para
-#: C/index.docbook:770
+#: C/index.docbook:702
msgid ""
"What it does: Tell about common uses. Put it in relation with the other API."
msgstr ""
"Τι κάνει: Αναφέρει τις κοινές χρήσεις και τις βάζει σε σχέση με άλλο API."
#. (itstool) path: tip/para
-#: C/index.docbook:760
+#: C/index.docbook:692
msgid "When documenting code, describe two aspects: <_:itemizedlist-1/>"
msgstr "Όταν τεκμηριώνετε κώδικα, περιγράψτε δύο πλευρές: <_:itemizedlist-1/>"
#. (itstool) path: listitem/para
-#: C/index.docbook:785
+#: C/index.docbook:717
msgid "Use function() to refer to functions or macros which take arguments."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή function() για αναÏ\86οÏ\81ÎÏ\82 σε συναρτήσεις ή "
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο function() για να αναÏ\86εÏ\81θείÏ\84ε σε συναρτήσεις ή "
"μακροεντολές που δέχονται ορίσματα."
#. (itstool) path: listitem/para
-#: C/index.docbook:790
+#: C/index.docbook:722
msgid ""
"Use @param to refer to parameters. Also use this when referring to "
"parameters of other functions, related to the one being described."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή @param για να αναφερθείτε σε παραμέτρους. Επίσης, "
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο @param για να αναφερθείτε σε παραμέτρους. Επίσης, "
"χρησιμοποιήστε αυτή τη γραφή για να αναφερθείτε σε παραμέτρους άλλων "
"συναρτήσεων, σχετικών με την περιγραφόμενη."
#. (itstool) path: listitem/para
-#: C/index.docbook:796
+#: C/index.docbook:728
msgid "Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή %constant για να αναφερθείτε σε σταθερές, π.χ. "
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο %constant για να αναφερθείτε σε σταθερές, π.χ. "
"%G_TRAVERSE_LEAFS."
#. (itstool) path: listitem/para
-#: C/index.docbook:801
+#: C/index.docbook:733
msgid ""
"Use #symbol to refer to other types of symbol, e.g. structs and enums and "
"macros which don't take arguments."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #symbol για να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε άλλοÏ\85Ï\82 Ï\84Ï\8dÏ\80οÏ\85Ï\82 "
-"συμβόλων, π.χ. δομές, αριθμήσεις και μακροεντολές που δε δέχονται ορίσματα."
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #symbol για να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε άλλοÏ\85Ï\82 Ï\84Ï\8dÏ\80οÏ\85Ï\82 Ï\83Ï\85μβÏ\8cλÏ\89ν, Ï\80.Ï\87. "
+"δομές, αριθμήσεις και μακροεντολές που δε δέχονται ορίσματα."
#. (itstool) path: listitem/para
-#: C/index.docbook:807
+#: C/index.docbook:739
msgid "Use #Object::signal to refer to a GObject signal."
msgstr ""
-"Χρησιμοποιήστε τη γραφή #Object::signal για να αναφερθείτε σε ένα σήμα "
-"GObject."
+"Χρησιμοποιήστε το #Object::signal για να αναφερθείτε σε ένα σήμα GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:812
+#: C/index.docbook:744
msgid "Use #Object:property to refer to a GObject property."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #Object::property για να αναφερθείτε σε μία ιδιότητα "
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #Object::property για να αναφερθείτε σε μία ιδιότητα "
"GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:817
+#: C/index.docbook:749
msgid ""
"Use #Struct.field to refer to a field inside a structure and #GObjectClass."
"foo_bar() to refer to a vmethod."
msgstr ""
-"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #Struct.field για να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα Ï\80εδίο μÎÏ\83α "
-"σε μια δομή και #GObjectClass.foo_bar() για να αναφερθείτε σε μια vmethod."
+"ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #Struct.field για να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα Ï\80εδίο μÎÏ\83α Ï\83ε μια "
+"δομή και #GObjectClass.foo_bar() για να αναφερθείτε σε μια vmethod."
#. (itstool) path: sect1/para
-#: C/index.docbook:779
+#: C/index.docbook:711
msgid ""
"One advantage of hyper-text over plain-text is the ability to have links in "
"the document. Writing the correct markup for a link can be tedious though. "
"GTK-Doc comes to help by providing several useful abbreviations. <_:"
"itemizedlist-1/>"
msgstr ""
-"Ένα πλεονέκτημα της χρήσης υπερκειμένου αντί για απλό κείμενο είναι η "
+"Ένα πλεονέκτημα της χρήσης υπερκειμένου αντί για απλό κείμενο, είναι η "
"δυνατότητα προσθήκης συνδέσμων στο έγγραφο. Ωστόσο, η χρήση της σωστής "
"σύνταξης για τη δημιουργία συνδέσμων μπορεί να είναι αρκετά κουραστική "
"διαδικασία. Το GTK-Doc σας βοηθάει, παρέχοντάς σας μια σειρά από χρήσιμες "
"συντμήσεις. <_:itemizedlist-1/>"
#. (itstool) path: tip/para
-#: C/index.docbook:826
+#: C/index.docbook:758
msgid ""
"If you need to use the special characters '<', '>', '()', '@', '%', or "
"'#' in your documentation without GTK-Doc changing them you can use the XML "
"διαφυγής."
#. (itstool) path: sect1/para
-#: C/index.docbook:835
+#: C/index.docbook:767
+msgid ""
+"DocBook can do more than just links. One can also have lists, examples, "
+"headings, and images. As of version 1.20, the preferred way is to use a "
+"subset of the basic text formatting syntax called <ulink url=\"http://"
+"daringfireball.net/projects/markdown/\">Markdown</ulink>. On older GTK-Doc "
+"versions any documentation that includes Markdown will be rendered as is. "
+"For example, list items will appear as lines starting with a dash."
+msgstr ""
+"Το DocBook μπορεί να κάνει παραπάνω από απλούς συνδέσμους. Μπορεί κάποιος να "
+"έχει και λίστες, παραδείγματα, κεφαλίδες και εικόνες. Από την έκδοση 1.20 "
+"και μετά, ο προτιμώμενος τρόπος είναι με τη χρήση ενός υποσυνόλου της "
+"βασικής σύνταξης για μορφοποίηση κειμένου που ονομάζεται <ulink url=\"http://"
+"daringfireball.net/projects/markdown/\">Markdown</ulink>. Σε παλιότερες "
+"εκδόσεις GTK-Doc οποιαδήποτε τεκμηρίωση που περιλαμβάνει Markdown θα "
+"αποδίδεται ως έχει. Για παράδειγμα, οι καταχωρήσεις της λίστας θα "
+"εμφανίζονται σαν γραμμές που αρχίζουν με μια παύλα."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:778
msgid ""
-"DocBook can do more than just links. One can also have lists, tables and "
-"examples. To enable the usage of docbook SGML/XML tags inside doc-comments "
-"you need to have <option>--xml-mode</option> or <option>--sgml-mode</option> "
-"in the variable <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</"
-"filename>."
+"In older GTK-Doc releases, if you need support for additional formatting, "
+"you would need to enable the usage of docbook SGML/XML tags inside doc-"
+"comments by putting <option>--xml-mode</option> or <option>--sgml-mode</"
+"option> in the variable <symbol>MKDB_OPTIONS</symbol> inside "
+"<filename>Makefile.am</filename>."
msgstr ""
-"Το DocBook σας προσφέρει και άλλες δυνατότητες πέρα από τους συνδέσμους. "
-"Μπορεί να περιλαμβάνει λίστες, πίνακες και παραδείγματα. Για να επιτρέπεται "
-"η χρήση ετικετών SGML/XML στα σχόλια τεκμηρίωσης, θα πρέπει να έχει "
-"προστεθεί η επιλογή <option>--xml-mode</option> ή <option>--sgml-mode</"
-"option> στη μεταβλητή <symbol>MKDB_OPTIONS</symbol> του <filename>Makefile."
-"am</filename>."
+"Σε παλιότερες εκδόσεις του GTK-Doc, αν χρειάζεστε υποστήριξη για πρόσθετη "
+"μορφοποίηση, θα πρέπει να ενεργοποιήσετε τη χρήση των ετικετών docbook SGML/"
+"XML μέσα στα doc-comments θέτοντας το <option>--xml-mode</option> ή το "
+"<option>--sgml-mode</option> στη μεταβλητή <symbol>MKDB_OPTIONS</symbol> "
+"μέσα στο <filename>Makefile.am</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:849
-msgid "GTK-Doc comment block using markdown"
-msgstr "Μπλοκ σχολίου GTK-Doc χρησιμοποιώντας markdown"
+#: C/index.docbook:788
+msgid "GTK-Doc comment block using Markdown"
+msgstr "Μπλοκ σχολίου GTK-Doc χρησιμοποιώντας Markdown"
#. (itstool) path: example/programlisting
-#: C/index.docbook:850
+#: C/index.docbook:789
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" *\n"
-" * documentation ...\n"
+" * documentation paragraph ...\n"
" *\n"
-" * # Sub heading #\n"
+" * # Sub Heading #\n"
+" *\n"
+" * ## Second Sub Heading\n"
+" *\n"
+" * # Sub Heading With a Link Anchor # {#heading-two}\n"
" *\n"
" * more documentation:\n"
+" *\n"
" * - list item 1\n"
+" *\n"
+" * Paragraph inside a list item.\n"
+" *\n"
" * - list item 2\n"
" *\n"
-" * Even more docs.\n"
+" * 1. numbered list item\n"
+" *\n"
+" * 2. another numbered list item\n"
+" *\n"
+" * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n"
+" *\n"
+" * ![an inline image][plot-result.png]\n"
+" *\n"
+" * [A link to the heading anchor above][heading-two]\n"
+" *\n"
+" * A C-language example:\n"
+" * |[<!-- language=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
-" * identifier:\n"
+" * ταυτοποιητικό:\n"
" *\n"
-" * documentation ...\n"
+" * παράγραφος τεκμηρίωσης ...\n"
" *\n"
-" * # Sub heading #\n"
+" * # Υπο Κεφαλίδα #\n"
" *\n"
-" * more documentation:\n"
-" * - list item 1\n"
-" * - list item 2\n"
+" * ## Δεύτερη Υπο Κεφαλίδα\n"
+" *\n"
+" * # Υπο Κεφαλίδα με έναν αγκυρωμένο σύνδεσμο # {#heading-two}\n"
" *\n"
-" * Even more docs.\n"
+" * περισσότερη τεκμηρίωση:\n"
+" *\n"
+" * - καταχώρηση λίστας 1\n"
+" *\n"
+" * Παράγραφος μέσα σε μια καταχώρηση λίστας.\n"
+" *\n"
+" * - καταχώρηση λίστας 2\n"
+" *\n"
+" * 1. αριθμημένη καταχώρηση λίστας\n"
+" *\n"
+" * 2. μια άλλη αριθμημένη καταχώρηση λίστας\n"
+" *\n"
+" * Μια άλλη παράγραφος. [Ένας σύνδεσμος στον ιστότοπο του GNOME](http://www.gnome.org/)\n"
+" *\n"
+" * ![μια εικόνα inline][plot-result.png]\n"
+" *\n"
+" * [Ένας σύνδεσμος στον παραπάνω heading anchor][heading-two]\n"
+" *\n"
+" * Ένα παράδειγμα γλώσσας-C:\n"
+" * |[<!-- γλώσσα=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Υπέροχη!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:843
+#: C/index.docbook:828
msgid ""
-"Since GTK-Doc-1.18 the tool supports a subset or the <ulink url=\"http://"
-"daringfireball.net/projects/markdown/\">markdown language</ulink>. One can "
-"use it for sub-headings and simple itemized lists. On older GTK-Doc versions "
-"the content will be rendered as it (the list items will appear in one line "
-"separated by dashes). <_:example-1/>"
+"More examples of what markdown tags are supported can be found in the <ulink "
+"url=\"https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown"
+"\">GTK+ Documentation Markdown Syntax Reference</ulink>."
msgstr ""
-"Από το GTK-Doc-1.18 το εργαλείο υποστηρίζει υποσύνολα ή <ulink url=\"http://"
-"daringfireball.net/projects/markdown/\">γλώσσα markdown</ulink>. Κάποιος "
-"μπορεί να τα χρησιμοποιήσει για υπό-κεφαλίδες και για απλές "
-"κατηγοριοποιημένες λίστες. Στις παλαιότερες εκδόσεις του GTK-Doc το "
-"περιεχόμενο θα πρέπει να καταστεί ως έχει (τα στοιχεία της λίστας θα "
-"εμφανιστούν σε μία γραμμή χωρισμένες με παύλες). <_:example-1/>"
+"Μπορείτε να βρείτε περισσότερα παραδείγματα για το ποιες ετικέτες markdown "
+"υποστηρίζονται στη διεύθυνση <ulink url=\"https://wiki.gnome.org/Projects/GTK"
+"%2B/DocumentationSyntax/Markdown\">GTK+ Documentation Markdown Syntax "
+"Reference</ulink>."
#. (itstool) path: tip/para
-#: C/index.docbook:871
+#: C/index.docbook:834
msgid ""
"As already mentioned earlier GTK-Doc is for documenting public API. Thus one "
"cannot write documentation for static symbols. Nevertheless it is good to "
"all one needs to do is to add another '*' in the comment block and insert "
"the symbol name at the right place inside the sections file."
msgstr ""
-"Όπως αναφέρθηκε και προηγουμένως το GTK-Doc αναλαμβάνει την τεκμηρίωση του "
-"δημÏ\8cÏ\83ιοÏ\85 API. Î\86Ï\81α, δεν μÏ\80οÏ\81εί να γÏ\81αÏ\86Ï\84εί Ï\84εκμηÏ\81ίÏ\89Ï\83η για Ï\83Ï\84αÏ\84ικά Ï\83Ï\8dμβολα. "
-"Παρόλα αυτά, συνιστάται ο σχολιασμός και αυτών των συμβόλων, γιατί βοηθά "
-"στην κατανόηση του κώδικα. Σας προτείνουμε λοιπόν να τα σχολιάζετε "
+"Όπως αναφέρθηκε και προηγουμένως το GTK-Doc στοχεύει στην τεκμηρίωση του "
+"δημÏ\8cÏ\83ιοÏ\85 API. Î\86Ï\81α, δεν μÏ\80οÏ\81εί κάÏ\80οιοÏ\82 να γÏ\81άÏ\88ει Ï\84εκμηÏ\81ίÏ\89Ï\83η για Ï\83Ï\84αÏ\84ικά "
+"σύμβολα. Παρόλα αυτά, συνιστάται ο σχολιασμός και αυτών των συμβόλων, γιατί "
+"βοηθά στην κατανόηση του κώδικα. Σας προτείνουμε λοιπόν να τα σχολιάζετε "
"χρησιμοποιώντας κανονικά σχόλια (χωρίς το δεύτερο «*» στην πρώτη γραμμή). Αν "
"αργότερα χρειαστεί να μετατραπεί η συνάρτηση σε δημόσια, το μόνο που θα "
"πρέπει να γίνει είναι να προστεθεί άλλο ένα «*» στο μπλοκ του σχολίου, και "
"να εισαχθεί το όνομα του συμβόλου στην κατάλληλη θέση του αρχείου ενοτήτων."
#. (itstool) path: sect1/title
-#: C/index.docbook:885
+#: C/index.docbook:848
msgid "Documenting sections"
msgstr "Τεκμηρίωση ενοτήτων"
#. (itstool) path: sect1/para
-#: C/index.docbook:887
+#: C/index.docbook:850
msgid ""
"Each section of the documentation contains information about one class or "
"module. To introduce the component one can write a section block. The short "
"περιεχομένων. Όλα τα πεδία @fields είναι προαιρετικά."
#. (itstool) path: example/title
-#: C/index.docbook:895
+#: C/index.docbook:858
msgid "Section comment block"
msgstr "Μπλοκ σχολίου ενότητας"
#. (itstool) path: example/programlisting
-#: C/index.docbook:896
+#: C/index.docbook:859
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: the application class\n"
" *\n"
" * The application class handles ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: the application class\n"
" *\n"
" * The application class handles ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: varlistentry/term
-#: C/index.docbook:917
+#: C/index.docbook:878
msgid "SECTION:<name>"
msgstr "SECTION:<name>"
#. (itstool) path: listitem/para
-#: C/index.docbook:919
+#: C/index.docbook:880
msgid ""
"The name links the section documentation to the respective part in the "
"<filename><package>-sections.txt</filename> file. The name give here "
"<filename><package>-sections.txt</filename>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:928
+#: C/index.docbook:889
msgid "@short_description"
msgstr "@short_description"
#. (itstool) path: listitem/para
-#: C/index.docbook:930
+#: C/index.docbook:891
msgid ""
"A one line description of the section, that later will appear after the "
"links in the TOC and at the top of the section page."
"της ενότητας."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:937
+#: C/index.docbook:898
msgid "@title"
msgstr "@title"
#. (itstool) path: listitem/para
-#: C/index.docbook:939
+#: C/index.docbook:900
msgid ""
"The section title defaults to <name> from the SECTION declaration. It "
"can be overridden with the @title field."
"SECTION. Μπορεί να παρακαμφθεί με το πεδίο @title."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:946
+#: C/index.docbook:907
msgid "@section_id"
msgstr "@section_id"
#. (itstool) path: listitem/para
-#: C/index.docbook:948
+#: C/index.docbook:909
msgid ""
"Overrides the use of title as a section identifier. For GObjects the <"
"title> is used as a section_id and for other sections it is <"
"άλλες ενότητες είναι <MODULE>-<title>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:956
+#: C/index.docbook:917
msgid "@see_also"
msgstr "@see_also"
#. (itstool) path: listitem/para
-#: C/index.docbook:958
+#: C/index.docbook:919
msgid "A list of symbols that are related to this section."
msgstr "Λίστα συμβόλων σχετικών με αυτή την ενότητα."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:964
+#: C/index.docbook:925
msgid "@stability"
msgstr "@stability"
#. (itstool) path: listitem/para
-#: C/index.docbook:971
+#: C/index.docbook:932
msgid ""
"Stable - The intention of a Stable interface is to enable arbitrary third "
"parties to develop applications to these interfaces, release them, and have "
"λόγους."
#. (itstool) path: listitem/para
-#: C/index.docbook:983
+#: C/index.docbook:944
msgid ""
"Unstable - Unstable interfaces are experimental or transitional. They are "
"typically used to give outside developers early access to new or rapidly "
"συμβατότητας μεταξύ μιας ελάσσονας έκδοσης και της επόμενης."
#. (itstool) path: listitem/para
-#: C/index.docbook:995
+#: C/index.docbook:956
msgid ""
"Private - An interface that can be used within the GNOME stack itself, but "
"that is not documented for end-users. Such functions should only be used in "
"σαφώς καθορισμένων και τεκμηριωμένων διαδικασιών."
#. (itstool) path: listitem/para
-#: C/index.docbook:1004
+#: C/index.docbook:965
msgid ""
"Internal - An interface that is internal to a module and does not require "
"end-user documentation. Functions that are undocumented are assumed to be "
"Internal."
msgstr ""
-"Εσωτερική - Μια διεπαφή που είναι εσωτερική σε ένα module δεν απαιτεί την "
-"Ï\8dÏ\80αÏ\81ξη Ï\84εκμηÏ\81ίÏ\89Ï\83ηÏ\82 για Ï\84ον Ï\84ελικÏ\8c Ï\87Ï\81ήÏ\83Ï\84η. Î\9fι Ï\83Ï\85ναÏ\81Ï\84ήÏ\83ειÏ\82 Ï\80οÏ\85 δεν Ï\80εÏ\81ιÎÏ\87οÏ\85ν "
-"Ï\84εκμηÏ\81ίÏ\89Ï\83η θεÏ\89Ï\81είÏ\84αι Ï\8cÏ\84ι είναι εσωτερικές."
+"Εσωτερική - Μια διεπαφή που είναι εσωτερική σε ένα άρθρωμα και δεν απαιτεί "
+"Ï\84ην Ï\8dÏ\80αÏ\81ξη Ï\84εκμηÏ\81ίÏ\89Ï\83ηÏ\82 για Ï\84ον Ï\84ελικÏ\8c Ï\87Ï\81ήÏ\83Ï\84η. Î\9fι Ï\83Ï\85ναÏ\81Ï\84ήÏ\83ειÏ\82 Ï\80οÏ\85 δεν "
+"Ï\80εÏ\81ιÎÏ\87οÏ\85ν Ï\84εκμηÏ\81ίÏ\89Ï\83η εκλαμβάνονÏ\84αι Ï\89Ï\82 εσωτερικές."
#. (itstool) path: listitem/para
-#: C/index.docbook:966
+#: C/index.docbook:927
msgid ""
"An informal description of the stability level this API has. We recommend "
"the use of one of these terms: <_:itemizedlist-1/>"
"συνιστούμε τη χρήση ενός από τους ακόλουθους όρους: <_:itemizedlist-1/>"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1016
+#: C/index.docbook:977
msgid "@include"
msgstr "@include"
#. (itstool) path: listitem/para
-#: C/index.docbook:1018
+#: C/index.docbook:979
msgid ""
"The <literal>#include</literal> files to show in the section synopsis (a "
"comma separated list), overriding the global value from the <link linkend="
"link> ή στη γραμμή εντολών. Πρόκειται για προαιρετικό στοιχείο."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1027
+#: C/index.docbook:988
msgid "@image"
msgstr "@image"
#. (itstool) path: listitem/para
-#: C/index.docbook:1029
+#: C/index.docbook:990
msgid ""
"The image to display at the top of the reference page for this section. This "
"will often be some sort of a diagram to illustrate the visual appearance of "
"καταχώρηση είναι προαιρετική."
#. (itstool) path: tip/para
-#: C/index.docbook:1040
+#: C/index.docbook:1001
msgid ""
"To avoid unnecessary recompilation after doc-changes put the section docs "
"into the c-source where possible."
"αρχείο του πηγαίου κώδικα, όπου αυτό είναι δυνατό."
#. (itstool) path: sect1/title
-#: C/index.docbook:1049
+#: C/index.docbook:1010
msgid "Documenting symbols"
msgstr "Τεκμηρίωση συμβόλων"
#. (itstool) path: sect1/para
-#: C/index.docbook:1051
+#: C/index.docbook:1012
msgid ""
"Each symbol (function, macro, struct, enum, signal and property) is "
"documented in a separate block. The block is best placed close to the "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1059 C/index.docbook:1088
+#: C/index.docbook:1020 C/index.docbook:1049
msgid "General tags"
msgstr "Γενικές ετικέτες"
#. (itstool) path: sect2/para
-#: C/index.docbook:1061
+#: C/index.docbook:1022
msgid ""
"You can add versioning information to all documentation elements to tell "
"when an API was introduced, or when it was deprecated."
"τεκμηρίωσης για να πείτε πότε εισήχθηκε ένα API, ή πότε καταργήθηκε."
#. (itstool) path: variablelist/title
-#: C/index.docbook:1066
+#: C/index.docbook:1027
msgid "Versioning Tags"
-msgstr "Ετικέτες εκδόσεων"
+msgstr "Εκδόσεις Ετικετών"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1067
+#: C/index.docbook:1028
msgid "Since:"
-msgstr "Since:"
+msgstr "Από:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1069
+#: C/index.docbook:1030
msgid "Description since which version of the code the API is available."
-msgstr "ΠεÏ\81ιγÏ\81αÏ\86ή για Ï\80οια ÎκδοÏ\83η Ï\84οÏ\85 κÏ\8eδικα είναι διαθέσιμο το API."
+msgstr "ΠεÏ\81ιγÏ\81αÏ\86ή οÏ\80Ï\8c Ï\80οια ÎκδοÏ\83η Ï\84οÏ\85 κÏ\8eδικα και μεÏ\84ά είναι διαθέσιμο το API."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1074
+#: C/index.docbook:1035
msgid "Deprecated:"
-msgstr "Deprecated:"
+msgstr "Παρωχημένη:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1076
+#: C/index.docbook:1037
msgid ""
"Paragraph denoting that this function should no be used anymore. The "
"description should point the reader to the new API."
msgstr ""
-"Παράγραφος που ενημερώνει ότι θα πρέπει να σταματήσει η χρήση της "
+"Παράγραφος που επισημαίνει ότι θα πρέπει να σταματήσει η χρήση της "
"συνάρτησης. Η περιγραφή θα πρέπει να παραπέμπει τον αναγνώστη στο νέο API."
#. (itstool) path: sect2/para
-#: C/index.docbook:1084
+#: C/index.docbook:1045
msgid "(FIXME : Stability information)"
msgstr "(FIXME : Πληροφορίες σταθερότητας)"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1089
+#: C/index.docbook:1050
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: some foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: some foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1111 C/index.docbook:1147
+#: C/index.docbook:1070 C/index.docbook:1106
msgid "Function comment block"
msgstr "Μπλοκ σχολίου συνάρτησης"
#. (itstool) path: listitem/para
-#: C/index.docbook:1117
+#: C/index.docbook:1076
msgid ""
"Document whether returned objects, lists, strings, etc, should be freed/"
"unrefed/released."
"κ.λπ, θα πρέπει να ελευθερώνονται, να μην ελευθερώνονται ή να απορρίπτονται."
#. (itstool) path: listitem/para
-#: C/index.docbook:1123
+#: C/index.docbook:1082
msgid "Document whether parameters can be NULL, and what happens if they are."
msgstr ""
"Τεκμηριώσετε κατά πόσο οι παράμετροι μπορούν να είναι μηδενικές (NULL) και "
"τι συμβαίνει αν είναι."
#. (itstool) path: listitem/para
-#: C/index.docbook:1128
+#: C/index.docbook:1087
msgid ""
"Mention interesting pre-conditions and post-conditions where appropriate."
msgstr ""
-"Αναφέρετε ενδιαφέρουσες προ-υποθέσεις και μετα-υποθέσεις όπου χρειάζεται."
+"Αναφέρετε ενδιαφέρουσες προ-καταστάσεις και μετα-καταστάσεις όπου χρειάζεται."
#. (itstool) path: sect2/para
-#: C/index.docbook:1113 C/index.docbook:1210
+#: C/index.docbook:1072 C/index.docbook:1165
msgid "Please remember to: <_:itemizedlist-1/>"
msgstr "Παρακαλούμε να θυμηθείτε να: <_:itemizedlist-1/>"
#. (itstool) path: sect2/para
-#: C/index.docbook:1135
+#: C/index.docbook:1094
msgid ""
"Gtk-doc assumes all symbols (macros, functions) starting with '_' are "
"private. They are treated like static functions."
"συναρτήσεις."
#. (itstool) path: sect2/para
-#: C/index.docbook:1140
+#: C/index.docbook:1099
msgid ""
"Also, take a look at GObject Introspection annotation tags: http://live."
"gnome.org/GObjectIntrospection/Annotations"
"gnome.org/GObjectIntrospection/Annotations"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1148
+#: C/index.docbook:1107
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * function_name:\n"
" * @par1: description of parameter 1. These can extend over more than\n"
" * Since: 2.2\n"
" * Deprecated: 2.18: Use other_function() instead.\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * function_name:\n"
-" * @par1: description of parameter 1. These can extend over more than\n"
-" * one line.\n"
-" * @par2: description of parameter 2\n"
-" * @...: a %NULL-terminated list of bars\n"
+" * @par1: περιγραφή της παραμέτρου 1. Αυτά μπορουν να επεκταθούν επί πολύ περισσότερο από\n"
+" * μια γραμμή.\n"
+" * @par2: περιγραφή της παραμέτρου 2\n"
+" * @...: a %NULL-terminated λίστα γραμμών\n"
" *\n"
-" * The function description goes here. You can use @par1 to refer to parameters\n"
-" * so that they are highlighted in the output. You can also use %constant\n"
-" * for constants, function_name2() for functions and #GtkWidget for links to\n"
-" * other declarations (which may be documented elsewhere).\n"
+" * Η περιγραφή παραμέτρου πηγαίνει εδώ. Μπορείτε να χρησιμοποιήσετε το @par1 για να αναφερθείτε στις παραμέτρους\n"
+" * έτσι ώστε να τονίζονται έντονα στην έξοδο. Μπορείτε επίσης να χρησιμοποιήσετε το %constant\n"
+" * για τις σταθερές, το function_name2() για τις συναρτήσεις και το #GtkWidget για συνδέσμους σε\n"
+" * άλλες δηλώσεις (που μπορεί να τεκμηριώνονται αλλού).\n"
" *\n"
-" * Returns: an integer.\n"
+" * Επιστρέφει: έναν ακέραιο.\n"
" *\n"
-" * Since: 2.2\n"
-" * Deprecated: 2.18: Use other_function() instead.\n"
+" * Από την: 2.2\n"
+" * Παρωχημένη: 2.18: Χρησιμοποιήστε αντιθέτως μια άλλη_συνάρτηση().\n"
" */\n"
"\n"
-" "
#. (itstool) path: variablelist/title
-#: C/index.docbook:1171
+#: C/index.docbook:1128
msgid "Function tags"
msgstr "Ετικέτες συναρτήσεων"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1172
+#: C/index.docbook:1129
msgid "Returns:"
msgstr "Returns:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1174
+#: C/index.docbook:1131
msgid "Paragraph describing the returned result."
msgstr "Παράγραφος που περιγράφει το επιστρεφόμενο αποτέλεσμα."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1179
+#: C/index.docbook:1136
msgid "@...:"
msgstr "@...:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1181
+#: C/index.docbook:1138
msgid ""
"In case the function has variadic arguments, you should use this tag "
"(@Varargs: does also work for historic reasons)."
msgstr ""
-"Σε περίπτωση που η μεταβλητή μπορεί να δεκτεί μεταβλητό αριθμό ορισμάτων "
+"Σε περίπτωση που η μεταβλητή μπορεί να δεχθεί μεταβλητό αριθμό ορισμάτων "
"(variadic), πρέπει να χρησιμοποιήσετε αυτή την ετικέτα (η ετικέτα @Varargs: "
"λειτουργεί επίσης, για ιστορικούς λόγους)."
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1191 C/index.docbook:1193
+#: C/index.docbook:1148 C/index.docbook:1150
msgid "Property comment block"
msgstr "Μπλοκ σχολίου ιδιότητας"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1194
+#: C/index.docbook:1151
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * SomeWidget:some-property:\n"
" *\n"
" * Here you can document a property.\n"
" */\n"
"g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * SomeWidget:some-property:\n"
" *\n"
-" * Here you can document a property.\n"
+" * Εδώ μπορείτε να τεκμηριώσετε μια ιδιότητα.\n"
" */\n"
"g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1208 C/index.docbook:1227
+#: C/index.docbook:1163 C/index.docbook:1182
msgid "Signal comment block"
msgstr "Μπλοκ σχολίου σήματος"
#. (itstool) path: listitem/para
-#: C/index.docbook:1214
+#: C/index.docbook:1169
msgid ""
"Document when the signal is emitted and whether it is emitted before or "
"after other signals."
msgstr ""
-"ΤεκμηÏ\81ιÏ\8eÏ\83Ï\84ε Ï\80Ï\8cÏ\84ε εκÏ\80ÎμÏ\80εÏ\84αι Ï\84ο Ï\83ήμα και αν εκÏ\80ÎμÏ\80εÏ\84αι Ï\80Ï\81ιν ή μεÏ\84ά αÏ\80Ï\8c άλλα "
-"σήματα."
+"ΤεκμηÏ\81ιÏ\8eÏ\83Ï\84ε Ï\80Ï\8cÏ\84ε εκÏ\80ÎμÏ\80εÏ\84αι Ï\84ο Ï\83ήμα και καÏ\84ά Ï\80Ï\8cÏ\83ο εκÏ\80ÎμÏ\80εÏ\84αι Ï\80Ï\81ιν ή μεÏ\84ά αÏ\80Ï\8c "
+"άλλα σήματα."
#. (itstool) path: listitem/para
-#: C/index.docbook:1220
+#: C/index.docbook:1175
msgid "Document what an application might do in the signal handler."
msgstr "Τεκμηριώστε τι μπορεί να κάνει μια εφαρμογή στον διαχειριστή σημάτων."
#. (itstool) path: example/programlisting
-#: C/index.docbook:1228
+#: C/index.docbook:1183
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarized:\n"
" * @widget: the widget that received the signal\n"
"foo_signals[FOOBARIZE] =\n"
" g_signal_new (\"foobarize\",\n"
" ...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarized:\n"
" * @widget: the widget that received the signal\n"
" * @foo: some foo\n"
" * @bar: some bar\n"
" *\n"
-" * The ::foobarized signal is emitted each time someone tries to foobarize @widget.\n"
+" * Το ::foobar-οποιημένο σήμα εκπέμπεται κάθε φορά που κάποιος προσπαθεί να foobar-οποιήσει το @widget.\n"
" */\n"
"foo_signals[FOOBARIZE] =\n"
" g_signal_new (\"foobarize\",\n"
" ...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1247 C/index.docbook:1248
+#: C/index.docbook:1200 C/index.docbook:1201
msgid "Struct comment block"
msgstr "Μπλοκ σχολίου δομής"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1249
+#: C/index.docbook:1202
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: some #gboolean\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: some #gboolean\n"
" *\n"
-" * This is the best widget, ever.\n"
+" * Αυτό είναι το καλύτερο widget που υπήρξε ποτέ.\n"
" */\n"
"typedef struct _FooWidget {\n"
" /*< private >*/\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1268
+#: C/index.docbook:1219
msgid ""
"Use <code>/*< private >*/</code> before the private struct fields you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
"public >*/</code>για την αντίστροφη συμπεριφορά."
#. (itstool) path: sect2/para
-#: C/index.docbook:1274
+#: C/index.docbook:1225
msgid ""
"Struct comment blocks can also be used for GObjects and GObjectClasses. It "
"is usually a good idea to add a comment block for a class, if it has "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1286 C/index.docbook:1287
+#: C/index.docbook:1237 C/index.docbook:1238
msgid "Enum comment block"
msgstr "Μπλοκ σχολίου Enum"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1288
+#: C/index.docbook:1239
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * Something:\n"
" * @SOMETHING_FOO: something foo\n"
" /*< private >*/\n"
" SOMETHING_COUNT\n"
"} Something;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * Something:\n"
" * @SOMETHING_FOO: something foo\n"
" * @SOMETHING_BAR: something bar\n"
" *\n"
-" * Τιμές απαρίθμησης χρησιμοποιούνται για το πράγμα, για τον ορισμό του πράγματος.\n"
+" * ΤιμÎÏ\82 αÏ\80αÏ\81ίθμηÏ\83ηÏ\82 Ï\80οÏ\85 Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dνÏ\84αι για Ï\84ο Ï\80Ï\81άγμα, για Ï\84ον οÏ\81ιÏ\83μÏ\8c Ï\84οÏ\85 Ï\80Ï\81άγμαÏ\84οÏ\82.\n"
" */\n"
"typedef enum {\n"
" SOMETHING_FOO,\n"
" /*< private >*/\n"
" SOMETHING_COUNT\n"
"} Something·\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1307
+#: C/index.docbook:1256
msgid ""
"Use <code>/*< private >*/</code> before the private enum values you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
">*/</code> για την αντίστροφη συμπεριφορά."
#. (itstool) path: sect1/title
-#: C/index.docbook:1317
+#: C/index.docbook:1266
msgid "Useful DocBook tags"
msgstr "Χρήσιμες ετικέτες DocBook"
#. (itstool) path: sect1/para
-#: C/index.docbook:1319
+#: C/index.docbook:1268
msgid ""
"Here are some DocBook tags which are most useful when documenting the code."
msgstr ""
"του κώδικα."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1328
+#: C/index.docbook:1277
#, no-wrap
msgid ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1324
+#: C/index.docbook:1273
msgid ""
"To link to another section in the GTK docs: <_:informalexample-1/> The "
"linkend is the SGML/XML id on the top item of the page you want to link to. "
"then the page title (\"Hash Tables\"). For widgets it is just the class "
"name. Spaces and underscores are converted to '-' to conform to SGML/XML."
msgstr ""
-"Î\93ια να Ï\83Ï\85νδÎÏ\83ετε με μια άλλη ενότητα στην τεκμηρίωση GTK: <_:"
+"Î\93ια να Ï\83Ï\85νδεθείτε με μια άλλη ενότητα στην τεκμηρίωση GTK: <_:"
"informalexample-1/> Ο προορισμός είναι το id του SGML/XML στο πρώτο στοιχείο "
"της σελίδας στην οποία παραπέμπει ο σύνδεσμος. Για τις περισσότερες σελίδες "
"είναι το (\"gtk\", \"gdk\", glib\"), ακολουθούμενο από τον τίτλο της σελίδας "
"SGML/XML."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1343
+#: C/index.docbook:1290
#, no-wrap
msgid ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1340
+#: C/index.docbook:1287
msgid ""
"To refer to an external function, e.g. a standard C function: <_:"
"informalexample-1/>"
"informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1354
+#: C/index.docbook:1299
#, no-wrap
msgid ""
"\n"
-"\n"
"<example>\n"
" <title>Using a GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<example>\n"
-" <title>Using a GHashTable.</title>\n"
+" <title>Χρησιμοποιώντας έναν πίνακα GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1367
+#: C/index.docbook:1310
#, no-wrap
msgid ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1351
+#: C/index.docbook:1296
msgid ""
"To include example code: <_:informalexample-1/> or possibly this, for very "
"short code fragments which don't need a title: <_:informalexample-2/> For "
"τελευταία περίπτωση το GTK-Doc υποστηρίζει επίσης τη σύντμηση: |[ ... ]|"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1388
+#: C/index.docbook:1329
#, no-wrap
msgid ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1385
+#: C/index.docbook:1326
msgid "To include bulleted lists: <_:informalexample-1/>"
msgstr "Συμπερίληψη λιστών με κουκίδες: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1410
+#: C/index.docbook:1349
#, no-wrap
msgid ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
" Make sure you free the data after use.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
-" Make sure you free the data after use.\n"
+" Βεβαιωθείτε πως απελυεθερώνετε τα δεδομένα μετά τη χρήση.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1407
+#: C/index.docbook:1346
msgid ""
"To include a note which stands out from the text: <_:informalexample-1/>"
msgstr ""
"informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1425
+#: C/index.docbook:1362
#, no-wrap
msgid ""
"\n"
-"\n"
"<type>unsigned char</type>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
-"<type>unsigned char</type>\n"
-"\n"
-" "
+"<type>μη υπογεγραμμένος χαρακτήρας char</type>\n"
#. (itstool) path: sect1/para
-#: C/index.docbook:1422
+#: C/index.docbook:1359
msgid "To refer to a type: <_:informalexample-1/>"
-msgstr "Î\91ναÏ\86οÏ\81ά Ï\83ε τύπο: <_:informalexample-1/>"
+msgstr "Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îναν τύπο: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1436
+#: C/index.docbook:1371
#, no-wrap
msgid ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1433
+#: C/index.docbook:1368
msgid ""
"To refer to an external structure (not one described in the GTK docs): <_:"
"informalexample-1/>"
msgstr ""
-"Î\91ναÏ\86οÏ\81ά Ï\83ε εξÏ\89Ï\84εÏ\81ική δομή (Ï\80οÏ\85 δεν Ï\80εÏ\81ιγÏ\81άÏ\86εÏ\84αι Ï\83Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η GTK): <_:"
-"informalexample-1/>"
+"Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε μια εξÏ\89Ï\84εÏ\81ική δομή (Ï\80οÏ\85 δεν Ï\80εÏ\81ιγÏ\81άÏ\86εÏ\84αι Ï\83Ï\84ην "
+"τεκμηρίωση GTK): <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1447
+#: C/index.docbook:1380
#, no-wrap
msgid ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1444
+#: C/index.docbook:1377
msgid "To refer to a field of a structure: <_:informalexample-1/>"
-msgstr "Î\91ναÏ\86οÏ\81ά Ï\83ε πεδίο μιας δομής: <_:informalexample-1/>"
+msgstr "Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα πεδίο μιας δομής: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1458
+#: C/index.docbook:1389
#, no-wrap
msgid ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1455
+#: C/index.docbook:1386
msgid ""
"To refer to a class name, we could possibly use: <_:informalexample-1/> but "
"you'll probably be using #GtkWidget instead (to automatically create a link "
"to the GtkWidget page - see <link linkend=\"documenting_syntax\">the "
"abbreviations</link>)."
msgstr ""
-"Î\91ναÏ\86οÏ\81ά Ï\83ε Ï\8cνομα κλάÏ\83ηÏ\82. Î\9cία δÏ\85ναÏ\84Ï\8cÏ\84ηÏ\84α είναι Ï\84ο : <_:informalexample-1/>, "
-"αλλά μάλλον θα χρησιμοποιήσετε το #GtkWidget (για αυτόματη δημιουργία "
-"συνδέσμου προς τη σελίδα GtkWidget, δείτε <link linkend=\"documenting_syntax"
-"\">τις συντμήσεις</link>)."
+"Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα Ï\8cνομα κλάÏ\83ηÏ\82, θα μÏ\80οÏ\81οÏ\8dÏ\83αÏ\84ε να Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83εÏ\84ε "
+"το : <_:informalexample-1/>, αλλά μάλλον θα χρησιμοποιήσετε το #GtkWidget "
+"(για αυτόματη δημιουργία συνδέσμου προς τη σελίδα GtkWidget, δείτε <link "
+"linkend=\"documenting_syntax\">τις συντμήσεις</link>)."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1471
+#: C/index.docbook:1400
#, no-wrap
msgid ""
"\n"
-"\n"
"<emphasis>This is important</emphasis>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
-"<emphasis>This is important</emphasis>\n"
-"\n"
-" "
+"<emphasis>Αυτό είναι σημαντικό;/emphasis>\n"
#. (itstool) path: sect1/para
-#: C/index.docbook:1468
+#: C/index.docbook:1397
msgid "To emphasize text: <_:informalexample-1/>"
msgstr "Χρήση έντονων χαρακτήρων: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1482
+#: C/index.docbook:1409
#, no-wrap
msgid ""
"\n"
-"\n"
"<filename>/home/user/documents</filename>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<filename>/home/user/documents</filename>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1479
+#: C/index.docbook:1406
msgid "For filenames use: <_:informalexample-1/>"
-msgstr "Î\9fνÏ\8cμαÏ\84α αÏ\81Ï\87είÏ\89ν: <_:informalexample-1/>"
+msgstr "Î\93ια ονÏ\8cμαÏ\84α αÏ\81Ï\87είÏ\89ν Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1493
+#: C/index.docbook:1418
#, no-wrap
msgid ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1490
+#: C/index.docbook:1415
msgid "To refer to keys use: <_:informalexample-1/>"
msgstr "Για να αναφερθείτε σε κλειδιά χρησιμοποιήστε: <_:informalexample-1/>"
#. (itstool) path: chapter/title
-#: C/index.docbook:1505
+#: C/index.docbook:1428
msgid "Filling the extra files"
-msgstr "Συμπλήρωση επιπλέον αρχείων"
+msgstr "Συμπλήρωση των επιπλέον αρχείων"
#. (itstool) path: chapter/para
-#: C/index.docbook:1507
+#: C/index.docbook:1430
msgid ""
"There are a couple of extra files, that need to be maintained along with the "
"inline source code comments: <filename><package>.types</filename>, "
"sgml), <filename><package>-sections.txt</filename>."
#. (itstool) path: sect1/title
-#: C/index.docbook:1516
+#: C/index.docbook:1439
msgid "Editing the types file"
msgstr "Επεξεργασία του αρχείου types"
#. (itstool) path: sect1/para
-#: C/index.docbook:1518
+#: C/index.docbook:1441
msgid ""
"If your library or application includes GObjects, you want their signals, "
"arguments/parameters and position in the hierarchy to be shown in the "
"<filename><package>.types</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:1527
+#: C/index.docbook:1450
msgid "Example types file snippet"
msgstr "Υπόδειγμα αποσπάσματος αρχείου types"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1528
+#: C/index.docbook:1451
#, no-wrap
msgid ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1541
+#: C/index.docbook:1462
msgid ""
"Since GTK-Doc 1.8 <application>gtkdoc-scan</application> can generate this "
"list for you. Just add \"--rebuild-types\" to SCAN_OPTIONS in "
"διανομή ούτε στον έλεγχο εκδόσεων."
#. (itstool) path: sect1/title
-#: C/index.docbook:1550
+#: C/index.docbook:1471
msgid "Editing the master document"
msgstr "Επεξεργασία κύριου εγγράφου (master)"
#. (itstool) path: sect1/para
-#: C/index.docbook:1552
+#: C/index.docbook:1473
msgid ""
"GTK-Doc produces documentation in DocBook SGML/XML. When processing the "
"inline source comments, the GTK-Doc tools generate one documentation page "
"ταξινομεί."
#. (itstool) path: sect1/para
-#: C/index.docbook:1559
+#: C/index.docbook:1480
msgid ""
"While GTK-Doc creates a template master document for you, later run will not "
"touch it again. This means that one can freely structure the documentation. "
"προστεθεί νέα στοιχεία."
#. (itstool) path: tip/para
-#: C/index.docbook:1569
+#: C/index.docbook:1490
msgid ""
"Do not create tutorials as extra documents. Just write extra chapters. The "
"benefit of directly embedding the tutorial for your library into the API "
"πιθανότερη η ενημέρωση του οδηγού μαζί με τη βιβλιοθήκη."
#. (itstool) path: sect1/para
-#: C/index.docbook:1578
+#: C/index.docbook:1499
msgid ""
"So what are the things to change inside the master document? For a start is "
"only a little. There are some placeholders (text in square brackets) there "
"(κείμενα εντός αγκυλών)."
#. (itstool) path: example/title
-#: C/index.docbook:1585
+#: C/index.docbook:1506
msgid "Master document header"
msgstr "Κεφαλίδα κύριου εγγράφου"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1586
+#: C/index.docbook:1507
#, no-wrap
msgid ""
"\n"
-"\n"
"<bookinfo>\n"
" <title>MODULENAME Reference Manual</title>\n"
" <releaseinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insert title here]</title>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<bookinfo>\n"
-" <title>MODULENAME Reference Manual</title>\n"
+" <title>MODULENAME Εγχειρίδιο αναφοράς;/title>\n"
" <releaseinfo>\n"
-" for MODULENAME [VERSION]\n"
-" The latest version of this documentation can be found on-line at\n"
+" για το MODULENAME [ΕΚΔΟΣΗ]\n"
+" Η πιο πρόσφατη έκδοση αυτή της τεκμηρίωσης μπορούν να εντοπισθούν on-line στη διεύθυνση\n"
" <ulink role=\"online-location\" url=\"http://[SERVER]/MODULENAME/index.html\">http://[SERVER]/MODULENAME/</ulink>.\n"
" </releaseinfo>\n"
"</bookinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insert title here]</title>\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1607
+#: C/index.docbook:1526
msgid "Editing the section file"
msgstr "Επεξεργασία αρχείου ενοτήτων"
#. (itstool) path: sect1/para
-#: C/index.docbook:1609
+#: C/index.docbook:1528
msgid ""
"The section file is used to organise the documentation output by GTK-Doc. "
"Here one specifies which symbol belongs to which module or class and control "
"σύμβολο και αποφασίζεται η ορατότητά του (αν θα είναι δημόσιο ή ιδιωτικό)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1615
+#: C/index.docbook:1534
msgid ""
"The section file is a plain text file with XML-like syntax (using tags). "
"Blank lines are ignored and lines starting with a '#' are treated as comment "
"που ξεκινούν με '#' αντιμετωπίζονται ως γραμμές σχολίων."
#. (itstool) path: sect1/para
-#: C/index.docbook:1621
+#: C/index.docbook:1540
msgid ""
"The <FILE> ... </FILE> tag is used to specify the file name, "
"without any suffix. For example, using '<FILE>gnome-config</"
"GObjects που μετατράπηκε σε πεζά γράμματα)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1633
+#: C/index.docbook:1552
msgid ""
"The <TITLE> ... </TITLE> tag is used to specify the title of the "
"section. It is only useful before the templates (if used) are initially "
"αυτό είναι πεπαλαιωμένο."
#. (itstool) path: sect1/para
-#: C/index.docbook:1640
+#: C/index.docbook:1559
msgid ""
"You can group items in the section by using the <SUBSECTION> tag. "
"Currently it outputs a blank line between subsections in the synopsis "
"(μεταβλητές,vmethods)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1659
+#: C/index.docbook:1578
msgid ""
"You can also use <INCLUDE> ... </INCLUDE> to specify the "
"#include files which are shown in the synopsis sections. It contains a comma-"
"μόνο τη συγκεκριμένη ενότητα. "
#. (itstool) path: chapter/title
-#: C/index.docbook:1673
+#: C/index.docbook:1592
msgid "Controlling the result"
msgstr "Έλεγχος αποτελέσματος"
#. (itstool) path: chapter/para
-#: C/index.docbook:1675
+#: C/index.docbook:1594
msgid ""
"A GTK-Doc run generates report files inside the documentation directory. The "
"generated files are named: <filename><package>-undocumented.txt</"
"filename>. Είναι αρχεία απλού κειμένου, εύκολα στην ανάγνωση και επεξεργασία."
#. (itstool) path: chapter/para
-#: C/index.docbook:1684
+#: C/index.docbook:1603
msgid ""
"The <filename><package>-undocumented.txt</filename> file starts with "
"the documentation coverage summary. Below are two sections divided by blank "
"προστέθηκε μια νέα παράμετρος."
#. (itstool) path: chapter/para
-#: C/index.docbook:1693
+#: C/index.docbook:1612
msgid ""
"The <filename><package>-undeclared.txt</filename> file lists symbols "
"given in the <filename><package>-sections.txt</filename> but not found "
"έχουν αφαιρεθεί ή αν περιέχουν συντακτικά λάθη."
#. (itstool) path: chapter/para
-#: C/index.docbook:1700
+#: C/index.docbook:1619
msgid ""
"The <filename><package>-unused.txt</filename> file lists symbol names, "
"where the GTK-Doc scanner has found documentation, but does not know where "
"προστεθεί ακόμη στο αρχείο <filename><package>-sections.txt</filename>."
#. (itstool) path: tip/para
-#: C/index.docbook:1708
+#: C/index.docbook:1627
msgid ""
"Enable or add the <option>TESTS=$(GTKDOC_CHECK)</option> line in Makefile."
"am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during "
"command>."
#. (itstool) path: chapter/para
-#: C/index.docbook:1715
+#: C/index.docbook:1634
msgid ""
"One can also look at the files produced by the source code scanner: "
"<filename><package>-decl-list.txt</filename> and <filename><"
"περιέχεται σε αυτό το αρχείο."
#. (itstool) path: chapter/para
-#: C/index.docbook:1724
+#: C/index.docbook:1643
msgid ""
"If the project is GObject based, one can also look into the files produced "
"by the object scanner: <filename><package>.args.txt</filename>, "
"<filename><package>.hierarchy.txt</filename>, <filename><"
"package>.interfaces.txt</filename>, <filename><package>."
"prerequisites.txt</filename> and <filename><package>.signals.txt</"
-"filename>. If there are missing symbols in any of those, one can ask gtkdoc "
+"filename>. If there are missing symbols in any of those, one can ask GTK-Doc "
"to keep the intermediate scanner file for further analysis, by running it as "
"<command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
msgstr ""
"filename>, <filename><package>.hierarchy.txt</filename>, <filename><"
"package>.interfaces.txt</filename>, <filename><package>."
"prerequisites.txt</filename> και <filename><package>.signals.txt</"
-"filename>. Αν λείπουν σύμβολα από οποιοδήποτε από αυτά, μπορείτε να ζητήσετε "
-"από το gtkdoc να κρατήσει το ενδιάμεσο αρχείο σάρωσης για παραπέρα ανάλυση, "
-"αλλά εκτελώντας το ως <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
+"filename>. Αν υπάρχουν σύμβολα που λείπουν από οποιοδήποτε από αυτά, "
+"μπορείτε να ζητήσετε από το gtkdoc να κρατήσει το ενδιάμεσο αρχείο σάρωσης "
+"για περαιτέρω ανάλυση, εκτελώντας το ως μια εντολή "
+"<command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
#. (itstool) path: chapter/title
-#: C/index.docbook:1739
+#: C/index.docbook:1658
+msgid "Modernizing the documentation"
+msgstr "Εκσυγχρονίζοντας την τεκμηρίωση"
+
+#. (itstool) path: chapter/para
+#: C/index.docbook:1660
+msgid ""
+"GTK-Doc has been around for quite some time. In this section we list new "
+"features together with the version since when it is available."
+msgstr ""
+"Το GTK-Doc κυκλοφορεί εδώ και αρκετό καιρό. Σε αυτό το κεφάλαιο θα "
+"παραθέσουμε τα νέα χαρακτηρηστικά μαζί με την έκδοση στην οποία είναι "
+"διαθέσιμα."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1666
+msgid "GTK-Doc 1.9"
+msgstr "GTK-Doc 1.9"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1668
+msgid ""
+"When using xml instead of sgml, one can actually name the master document "
+"<filename><package>-docs.xml</filename>."
+msgstr ""
+"Όταν χρησιμοποιείτε το xml αντί για το sgml, μπορείτε πράγματι να ονομάσετε "
+"το κύριο έγγραφο <filename><package>-docs.xml</filename>."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1673
+msgid ""
+"This version supports <option>SCAN_OPTIONS=--rebuild-sections</option> in "
+"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
+"package>-sections.txt</filename> is autogenerated and can be removed from "
+"the vcs. This only works nicely for projects that have a very regular "
+"structure (e.g. each .{c,h} pair will create new section). If one organize a "
+"project close to that updating a manually maintained section file can be as "
+"simple as running <code>meld <package>-decl-list.txt <package>-"
+"sections.txt</code>."
+msgstr ""
+"Αυτή η έκδοση υποστηρίζει <option>SCAN_OPTIONS=--rebuild-sections</option> "
+"στο <filename>Makefile.am</filename>. Αν αυτό ενεργοποιηθεί, το "
+"<filename><package>-sections.txt</filename> αυτοδημιουργείται και "
+"μπορεί να αφαιρεθεί από το vcs. Αυτό λειτουργεί ωραία μόνο για έργα που "
+"έχουν μια πολύ κανονική δομή (π.χ. το κάθε ζεύγος .{c,h} θα δημιουργεί μια "
+"νέα ενότητα). Αν κάποιος οργανώσει ένα έργο κοντά σε αυτό, τότε η ενημέρωση "
+"μιας ενότητας αρείων που συντηρούνται χειρονακτικά μπορεί να είναι τόσο απλή "
+"όσο και το να εκτελούμε <code>meld <package>-decl-list.txt <"
+"package>-sections.txt</code>."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1684
+msgid ""
+"Version 1.8 already introduced the syntax for documenting sections in the "
+"sources instead of the separate files under <filename class=\"directory"
+"\">tmpl</filename>. This version adds options to switch the whole doc module "
+"to not use the extra tmpl build step at all, by using <option>--flavour no-"
+"tmpl</option> in <filename>configure.ac</filename>."
+msgstr ""
+"Η εκδοση 1.8 εισήγαγε ήδη τη σύνταξη για τις ενότητες τεκμηρίωσης στις "
+"πηγές, αντί για τα ξεχωριστά αρχεία, κάτω από το <filename class=\"directory"
+"\">tmpl</filename>. Αυτή η έκδοση προσθέτει επιλογές για τη μετατροπή "
+"ολόκληρου του αρθρώματος doc ώστε να μη χρησιμοποιεί καθόλου το επιπλέον "
+"στάδιο tmpl build, με τη χρήση της επιλογής <option>--flavour no-tmpl</"
+"option> στο <filename>configure.ac</filename>."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1694
+msgid "GTK-Doc 1.10"
+msgstr "GTK-Doc 1.10"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1696
+msgid ""
+"This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in "
+"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
+"package>.types</filename> is autogenerated and can be removed from the "
+"vcs. When using this feature it is important to also setup the "
+"<varname>IGNORE_HFILES</varname> in <filename>Makefile.am</filename> for "
+"code that is build conditionally."
+msgstr ""
+"Αυτή η έκδοση υποστηρίζει τα <option>SCAN_OPTIONS=--rebuild-types</option> "
+"στο <filename>Makefile.am</filename>. Αν αυτό ενεργοποιηθεί, το "
+"<filename><package>.types</filename> αυτοδημιουργείται και μπορεί να "
+"αφαιρεθεί από το vcs. Όταν χρησιμοποιείτε αυτό το χαρακτηριστικό είναι "
+"σημαντικό να ρυθμίσετε και το <varname>IGNORE_HFILES</varname> στο "
+"<filename>Makefile.am</filename> για τον κώδικα που δημιουργείται υπό όρους."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1707
+msgid "GTK-Doc 1.16"
+msgstr "GTK-Doc 1.16"
+
+#. (itstool) path: example/title
+#: C/index.docbook:1713
+msgid "Enable gtkdoc-check"
+msgstr "Ενεργοποίηση του gtkdoc-check"
+
+#. (itstool) path: example/programlisting
+#: C/index.docbook:1714
+#, no-wrap
+msgid ""
+"\n"
+"if ENABLE_GTK_DOC\n"
+"TESTS_ENVIRONMENT = \\\n"
+" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
+" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
+"TESTS = $(GTKDOC_CHECK)\n"
+"endif\n"
+msgstr ""
+"\n"
+"if ENABLE_GTK_DOC\n"
+"TESTS_ENVIRONMENT = \\\n"
+" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
+" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
+"TESTS = $(GTKDOC_CHECK)\n"
+"endif\n"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1709
+msgid ""
+"This version includes a new tool called gtkdoc-check. This tool can run a "
+"set of sanity checks on your documentation. It is enabled by adding these "
+"lines to the end of <filename>Makefile.am</filename>. <_:example-1/>"
+msgstr ""
+"Αυτή η έκδοση περιλαμβάνει ένα νέο εργαλείο που λέγεται gtkdoc-check. Αυτό "
+"το εργαλείο μπορέι να εκτελεί ένα σύνολο ελέγχων υγείας στην τεκμηρίωσή σας. "
+"Ενεργοποιείται προσθέτοντας αυτές τις γραμμές στο τέλος του "
+"<filename>Makefile.am</filename>. <_:example-1/>"
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1727
+msgid "GTK-Doc 1.20"
+msgstr "GTK-Doc 1.20"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1729
+msgid ""
+"Version 1.18 brought some initial markdown support. Using markdown in doc "
+"comments is less intrusive than writing docbook xml. This version improves a "
+"lot on this and add a lot more styles. The section that explains the <link "
+"linkend=\"documenting_syntax\">comment syntax</link> has all the details."
+msgstr ""
+"Η έκδοση 1.18 έφερε μια αρχική υποστήριξη για το markdown. Η χρήση markdown "
+"στα σχόλια του doc είναι λιγότερο ενοχλητική από το να γράφει κανείς docbook "
+"xml. Αυτή η έκδοση επιφέρει μεγάλες βελτιώσεις σε αυτό, και σε πολλές άλλες "
+"τεχνοτροπίες (styles). Η ενότητα που εξηγεί τη <link linkend="
+"\"documenting_syntax\">σύνταξη σχολίων</link> έχει όλες τις λεπτομέρειες."
+
+#. (itstool) path: chapter/title
+#: C/index.docbook:1740
msgid "Documenting other interfaces"
msgstr "Τεκμηρίωση άλλων διεπαφών"
#. (itstool) path: chapter/para
-#: C/index.docbook:1741
+#: C/index.docbook:1742
msgid ""
"So far we have been using GTK-Doc to document the API of code. The next "
"sections contain suggestions how the tools can be used to document other "
"interfaces too."
msgstr ""
-"ΤÏ\8cÏ\83ο καιÏ\81Ï\8c Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dÏ\83αμε Ï\84ο GTK-Doc για να καÏ\84αγÏ\81άÏ\88ουμε το API του "
+"Î\9cÎÏ\87Ï\81 Ï\84Ï\8eÏ\81α, Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dÏ\83αμε Ï\84ο GTK-Doc για να καÏ\84αγÏ\81άÏ\86ουμε το API του "
"κώδικα. Οι επόμενες συνεδρίες περιέχουν προτάσεις για το πώς τα εργαλεία "
-"μπορούν να χρησιμοποιηθούν ώστε να καταγράψετε και άλλες επιφάνειες."
+"μπορούν να χρησιμοποιηθούν για να καταγράφετε και άλλες επιφάνειες."
#. (itstool) path: sect1/title
-#: C/index.docbook:1748
+#: C/index.docbook:1749
msgid "Command line options and man pages"
msgstr "Επιλογές γραμμής εντολών και σελίδες τεκμηρίωσης man"
#. (itstool) path: sect1/para
-#: C/index.docbook:1750
+#: C/index.docbook:1751
msgid ""
"As one can generate man pages for a docbook refentry as well, it sounds like "
"a good idea to use it for that purpose. This way the interface is part of "
"την σελίδα-man δωρεάν."
#. (itstool) path: sect2/title
-#: C/index.docbook:1757
+#: C/index.docbook:1758
msgid "Document the tool"
msgstr "Τεκμηρίωση του εργαλείου"
#. (itstool) path: sect2/para
-#: C/index.docbook:1759
+#: C/index.docbook:1760
msgid ""
"Create one refentry file per tool. Following <link linkend="
"\"settingup_docfiles\">our example</link> we would call it <filename>meep/"
"αρχείο στον υποκατάλογο xml καθώς επίσης και τα παραδείγματα π.χ. στο glib."
#. (itstool) path: sect2/title
-#: C/index.docbook:1769
+#: C/index.docbook:1770
msgid "Adding the extra configure check"
msgstr "Προσθήκη του έξτρα ελέγχου διαμόρφωσης"
#. (itstool) path: example/title
-#: C/index.docbook:1772 C/index.docbook:1792
+#: C/index.docbook:1773 C/index.docbook:1791
msgid "Extra configure checks"
msgstr "Έξτρα έλεγχοι διαμόρφωσης"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1773
+#: C/index.docbook:1774
#, no-wrap
msgid ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
-" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
+" [αναδημιουργία σελίδων βοήθειας man από το Docbook [default=no]])],enable_man=yes,\n"
" enable_man=no)\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
#. (itstool) path: sect2/title
-#: C/index.docbook:1789
+#: C/index.docbook:1788
msgid "Adding the extra makefile rules"
-msgstr "Î Ï\81οÏ\83θήκη Ï\84Ï\89ν ÎξÏ\84Ï\81α κανόνων makefile"
+msgstr "Î Ï\81οÏ\83θήκη Ï\84Ï\89ν εÏ\80ιÏ\80λÎον κανόνων makefile"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1793
+#: C/index.docbook:1792
#, no-wrap
msgid ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1817
+#: C/index.docbook:1814
msgid "DBus interfaces"
-msgstr "DBus interfaces"
+msgstr "Διεπαφές DBus"
#. (itstool) path: sect1/para
-#: C/index.docbook:1819
+#: C/index.docbook:1816
msgid ""
"(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://"
"cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
"cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
#. (itstool) path: chapter/title
-#: C/index.docbook:1828
+#: C/index.docbook:1825
msgid "Frequently asked questions"
msgstr "Συχνές ερωτήσεις"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1832
+#: C/index.docbook:1829
msgid "Question"
msgstr "Ερώτηση"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1833
+#: C/index.docbook:1830
msgid "Answer"
msgstr "Απάντηση"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1835
+#: C/index.docbook:1832
msgid "No class hierarchy."
msgstr "Δεν υπάρχει ιεραρχία κλάσεων."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1836
+#: C/index.docbook:1833
msgid ""
"The objects <function>xxx_get_type()</function> function has not been "
"entered into the <filename><package>.types</filename> file."
"εισαχθεί στο αρχείο <filename><package>.types</filename>"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1842
+#: C/index.docbook:1839
msgid "Still no class hierarchy."
msgstr "Εξακολουθεί να μην υπάρχει ιεραρχία κλάσεων."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1843
+#: C/index.docbook:1840
msgid ""
"Missing or wrong naming in <filename><package>-sections.txt</filename> "
"file (see <ulink url=\"http://mail.gnome.org/archives/gtk-doc-list/2003-"
"October/msg00006.html\">explanation</ulink>)."
msgstr ""
-"Î\95λλιÏ\80ήÏ\82 ή λαθεμένη ονομασία στο αρχείο <filename><package>-sections."
+"Î\95λλιÏ\80ήÏ\82 ή λανθαÏ\83μένη ονομασία στο αρχείο <filename><package>-sections."
"txt</filename> (δείτε την <ulink url=\"http://mail.gnome.org/archives/gtk-"
"doc-list/2003-October/msg00006.html\">αιτιολόγηση</ulink>)."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1849
+#: C/index.docbook:1846
msgid "Damn, I have still no class hierarchy."
-msgstr "Î άλι δεν έχω ιεραρχία κλάσεων."
+msgstr "ΣÏ\84ο καλÏ\8c Ï\84οÏ\85, Ï\80άλι δεν έχω ιεραρχία κλάσεων."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1850
+#: C/index.docbook:1847
msgid ""
"Is the object name (name of the instance struct, e.g. <type>GtkWidget</"
"type>) part of the normal section (don't put this into Standard or Private "
"Private)."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1857
+#: C/index.docbook:1854
msgid "No symbol index."
msgstr "Δεν υπάρχει ευρετήριο συμβόλων."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1858
+#: C/index.docbook:1855
msgid ""
"Does the <filename><package>-docs.{xml,sgml}</filename> contain a "
"index that xi:includes the generated index?"
"ευρετήριο το οποίο περιλαμβάνει με xi:includes το παραγόμενο ευρετήριο;"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1864
+#: C/index.docbook:1861
msgid "Symbols are not linked to their doc-section."
msgstr ""
"Δεν υπάρχουν σύνδεσμοι μεταξύ των συμβόλων και των κατάλληλων ενοτήτων της "
"τεκμηρίωσης."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1865
+#: C/index.docbook:1862
msgid ""
"Is the doc-comment using the correct markup (added #,% or ())? Check if the "
"gtkdoc-fixxref warns about unresolvable xrefs."
"Ελέγξτε αν το gtkdoc-fixxref προειδοποιεί για ανεπίλυτα xrefs."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1871
+#: C/index.docbook:1868
msgid "A new class does not appear in the docs."
msgstr "Μια νέα κλάση δεν εμφανίζεται στην τεκμηρίωση."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1872
+#: C/index.docbook:1869
msgid ""
"Is the new page xi:included from <filename><package>-docs.{xml,sgml}</"
"filename>."
msgstr ""
-"ΣÏ\85μÏ\80εÏ\81ιλαμβάνεÏ\84αι μÎÏ\83Ï\89 xi:included η νÎα Ï\83ελίδα αÏ\80Ï\8c Ï\84ο <filename><"
-"package>-docs.{xml,sgml}</filename>;"
+"ΣÏ\85μÏ\80εÏ\81ιλαμβάνεÏ\84αι η νÎα Ï\83ελίδα xi:included αÏ\80Ï\8c Ï\84ο <filename><package>-"
+"docs.{xml,sgml}</filename>;"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1878
+#: C/index.docbook:1875
msgid "A new symbol does not appear in the docs."
msgstr "Ένα νέο σύμβολο δεν εμφανίζεται στην τεκμηρίωση."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1879
+#: C/index.docbook:1876
msgid ""
"Is the doc-comment properly formatted. Check for spelling mistakes in the "
"begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable "
"xrefs. Check if the symbol is correctly listed in the <filename><"
"package>-sections.txt</filename> in a public subsection."
msgstr ""
-"Î\95ίναι Ï\84ο doc-comment κανονικά μορφοποιημένο; Ελέγξτε για συντακτικά λάθη "
+"Το doc-comment είναι κανονικά μορφοποιημένο; Ελέγξτε για συντακτικά λάθη "
"στην αρχή του σχολίου. Ελέγξτε αν το gtkdoc-fixxref προειδοποιεί για "
"ανεπίλυτα xref. Ελέγξτε αν το σύμβολο είναι σωστά καταχωρημένο στο "
"<filename><package>-sections.txt</filename> σε μια δημόσια υποενότητα."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1887
+#: C/index.docbook:1884
msgid "A type is missing from the class hierarchy."
msgstr "Λείπει ένας τύπος από την ιεραρχία κλάσεων."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1888
+#: C/index.docbook:1885
msgid ""
"If the type is listed in <filename><package>.hierarchy</filename> but "
"not in <filename>xml/tree_index.sgml</filename> then double check that the "
"εμφανιστεί."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1897
+#: C/index.docbook:1894
msgid "I get foldoc links for all gobject annotations."
msgstr "Λαμβάνω συνδέσμους foldoc για όλες τις σημειώσεις gobject."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1898
+#: C/index.docbook:1895
msgid ""
"Check that <filename>xml/annotation-glossary.xml</filename> is xi:included "
"from <filename><package>-docs.{xml,sgml}</filename>."
"included από το <filename><package>-docs.{xml,sgml}</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1906
+#: C/index.docbook:1903
msgid "Parameter described in source code comment block but does not exist"
msgstr ""
"Μια παράμετρος περιγράφεται σε σχόλιο του πηγαίου κώδικα, αλλά δεν υπάρχει"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1907
+#: C/index.docbook:1904
msgid ""
"Check if the prototype in the header has different parameter names as in the "
"source."
"παράμετρο από αυτό που αναφέρεται στον κώδικα."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1912
+#: C/index.docbook:1909
msgid "multiple \"IDs\" for constraint linkend: XYZ"
msgstr "Πολλαπλά \"IDs\" για τον προορισμό συνδέσμου: XYZ"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1913
+#: C/index.docbook:1910
msgid ""
"Symbol XYZ appears twice in <filename><package>-sections.txt</"
"filename> file."
"txt</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1916
+#: C/index.docbook:1913
msgid ""
"Element typename in namespace '' encountered in para, but no template "
"matches."
"σε κανένα πρότυπο."
#. (itstool) path: chapter/title
-#: C/index.docbook:1923
+#: C/index.docbook:1920
msgid "Tools related to gtk-doc"
msgstr "Εργαλεία σχετικά με το gtk-doc"
#. (itstool) path: chapter/para
-#: C/index.docbook:1925
+#: C/index.docbook:1922
msgid ""
"GtkDocPlugin - a <ulink url=\"http://trac-hacks.org/wiki/GtkDocPlugin\">Trac "
"GTK-Doc</ulink> integration plugin, that adds API docs to a trac site and "
"ιστοσελίδες trac και ενσωματώνεται με την αναζήτηση trac."
#. (itstool) path: chapter/para
-#: C/index.docbook:1930
+#: C/index.docbook:1927
msgid ""
"Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since "
"tags in the API to determine the minimum required version."
"It complements the GNU General Public License, which is a copyleft license "
"designed for free software."
msgstr ""
-"Î\97 Ï\80αÏ\81οÏ\8dÏ\83α Î\86δεια είναι άδεια Ï\84Ï\8dÏ\80οÏ\85 <quote>copyleft</quote>, Ï\84ο οÏ\80οίο Ï\83ημαίνει "
-"Ï\8cÏ\84ι Ï\84α Ï\80αÏ\81άγÏ\89γα ÎÏ\81γα Ï\84οÏ\85 εγγÏ\81άÏ\86οÏ\85 θα Ï\80Ï\81ÎÏ\80ει να είναι και αÏ\85Ï\84ά ελεÏ\8dθεÏ\81α Ï\85Ï\80Ï\8c "
-"την ίδια έννοια. Πρόκειται για άδεια συμπληρωματική της Γενικής Άδειας "
-"Î\94ημÏ\8cÏ\83ιαÏ\82 ΧÏ\81ήÏ\83ηÏ\82 GNU, Ï\80οÏ\85 είναι άδεια copyleft Ï\83Ï\87εδιαÏ\83μÎνη για ελεÏ\8dθεÏ\81ο "
-"λογισμικό."
+"Î\97 Ï\80αÏ\81οÏ\8dÏ\83α Î\86δεια είναι μια άδεια Ï\84Ï\8dÏ\80οÏ\85 <quote>copyleft</quote>, Ï\84ο οÏ\80οίο "
+"Ï\83ημαίνει Ï\8cÏ\84ι Ï\84α Ï\80αÏ\81άγÏ\89γα ÎÏ\81γα Ï\84οÏ\85 εγγÏ\81άÏ\86οÏ\85 θα Ï\80Ï\81ÎÏ\80ει να είναι και αÏ\85Ï\84ά "
+"ελεύθερα υπό την ίδια έννοια. Πρόκειται για άδεια συμπληρωματική της Γενικής "
+"Î\86δειαÏ\82 Î\94ημÏ\8cÏ\83ιαÏ\82 ΧÏ\81ήÏ\83ηÏ\82 GNU, Ï\80οÏ\85 είναι άδεια copyleft Ï\83Ï\87εδιαÏ\83μÎνη για "
+"ελεÏ\8dθεÏ\81ο λογιÏ\83μικÏ\8c."
#. (itstool) path: sect1/para
#: C/index.docbook:50 C/fdl-appendix.xml:50
"conflict in title with any <link linkend=\"fdl-invariant\">Invariant "
"Section</link>."
msgstr ""
-"Μη μετατρέπετε τον τίτλο καμίας προϋπάρχουσας ενότητας στον τίτλο "
-"<quote>Έγκριση</quote> ή σε τίτλο που συγκρούεται με τον τίτλο <link linkend="
+"Μην αλλάζετε τον τίτλο καμίας προϋπάρχουσας ενότητα σε <quote>Έγκριση</"
+"quote> ή σε τίτλο που να συγκρούεται με τον τίτλο οποιασδήποτε <link linkend="
"\"fdl-invariant\">Αμετάβλητης Ενότητας</link>."
#. (itstool) path: sect1/para
"releasing these examples in parallel under your choice of free software "
"license, such as the <_:ulink-1/>, to permit their use in free software."
msgstr ""
-"Αν το έγγραφό σας περιέχει μη ασήμαντα παραδείγματα πηγαίου κώδικα, "
-"συνιστούμε την παράλληλη δημοσίευσή τους υπό τους όρους της άδειας ελεύθερου "
-"λογισμικού της αρεσκείας σας,όπως η <_:ulink-1/>, ώστε να επιτρέψετε τη "
-"χρήση τους σε ελεύθερο λογισμικό. "
+"Αν το έγγραφό σας περιέχει μη-ασήμαντα παραδείγματα πηγαίου κώδικα, "
+"συνιστούμε την παράλληλη δημοσίευσή τους, υπό τους όρους της άδειας "
+"ελεύθερου λογισμικού της αρεσκείας σας,όπως η <_:ulink-1/>, ώστε να "
+"επιτρέψετε τη χρήση τους σε ελεύθερο λογισμικό. "
+
+#~ msgid "1.18.1"
+#~ msgstr "1.18.1"
+
+#~ msgid ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink>"
+#~ msgstr ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel> - Πρόκειται για την DocBook SGML "
+#~ "DTD. <ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www."
+#~ "ora.com/davenport</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
+#~ "SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
+#~ "\"http\">http://www.jclark.com/jade</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Jade v1.1</guilabel> - Πρόκειται για επεξεργαστή DSSSL που "
+#~ "μετατρέπει τη SGML σε διάφορες άλλες μορφές. <ulink url=\"http://www."
+#~ "jclark.com/jade\" type=\"http\">http://www.jclark.com/jade</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code "
+#~ "to convert DocBook to HTML (and a few other formats). It's used together "
+#~ "with jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to "
+#~ "colour the program code listings/declarations, and to support global "
+#~ "cross-reference indices in the generated HTML. <ulink url=\"http://nwalsh."
+#~ "com/docbook/dsssl\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Modular DocBook Stylesheets</guilabel> Πρόκειται για τον κώδικα "
+#~ "DSSSL που απαιτείται για τη μετατροπή από DocBook σε HTML (και ορισμένες "
+#~ "άλλες μορφές). Χρησιμοποιείται σε συνδυασμό με το jade. Έχουν γίνει "
+#~ "κάποιες μικρές προσαρμογές του κώδικα DSSSL, στο gtk-doc.dsl, για το "
+#~ "χρωματισμό κώδικα/δηλώσεων και για την υποστήριξη των καθολικών "
+#~ "ευρετηρίων παραπομπών στα παραγόμενα HTML. <ulink url=\"http://nwalsh.com/"
+#~ "docbook/dsssl\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>docbook-to-man</guilabel> - if you want to create man pages "
+#~ "from the DocBook. I've customized the 'translation spec' slightly, to "
+#~ "capitalise section headings and add the 'GTK Library' title at the top of "
+#~ "the pages and the revision date at the bottom. There is a link to this on "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink> NOTE: This does not work yet."
+#~ msgstr ""
+#~ "<guilabel>docbook-to-man</guilabel> - Σε περίπτωση που θέλετε να "
+#~ "δημιουργήσετε σελίδες man από το DocBook. Έχουν γίνει κάποιες μικρές "
+#~ "προσαρμογές των 'προδιαγραφών μετάφρασης', για να εμφανίζονται με "
+#~ "κεφαλαία οι τίτλοι ενοτήτων και να προστίθενται ο τίτλος 'Βιβλιοθήκη GTK' "
+#~ "στην αρχή της σελίδας και η ημερομηνία αναθεώρησης στο τέλος της. Βλέπε "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink> ΣΗΜΕΙΩΣΗ: Αυτή η δυνατότητα δε λειτουργεί προς το "
+#~ "παρόν."
+
+#~ msgid "Installation"
+#~ msgstr "Εγκατάσταση"
+
+#~ msgid ""
+#~ "There is no standard place where the DocBook Modular Stylesheets are "
+#~ "installed."
+#~ msgstr ""
+#~ "Δεν υπάρχει σταθερή τοποθεσία για την εγκατάσταση των DocBook Modular "
+#~ "Stylesheets."
+
+#~ msgid ""
+#~ "GTK-Doc's configure script searches these 3 directories automatically:"
+#~ msgstr ""
+#~ "Το σενάριο εντολών configure του GTK-Doc ψάχνει αυτόματα τους τρεις "
+#~ "παρακάτω καταλόγους:"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
+#~ "RedHat)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> "
+#~ "(χρησιμοποιείται από το RedHat)"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> "
+#~ "(χρησιμοποιείται από το Debian)"
+
+#~ msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
+#~ msgstr ""
+#~ "<filename> /usr/share/sgml/docbkdsl </filename> (χρησιμοποιείται από το "
+#~ "SuSE)"
+
+#~ msgid ""
+#~ "If you have the stylesheets installed somewhere else, you need to "
+#~ "configure GTK-Doc using the option: <command> --with-dsssl-dir=<"
+#~ "PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+#~ msgstr ""
+#~ "Αν τα φύλλα στυλ είναι εγκατεστημένα κάπου αλλού, θα πρέπει να ρυθμίσετε "
+#~ "GTK-Doc με την επιλογή: <command> --with-dsssl-dir=< "
+#~ "ΔΙΑΔΡΟΜΗ_ΠΡΟΣ_ΡΙΖΙΚΟ_ΚΑΤΑΛΟΓΟ_ΦΥΛΛΩΝ_ΣΤΥΛ> </command>"
+
+#~ msgid ""
+#~ "You may also want to enable GTK-Doc for the distcheck make target. Just "
+#~ "add the one line shown in the next example to your top-level "
+#~ "<filename>Makefile.am</filename>:"
+#~ msgstr ""
+#~ "Μπορείτε, επίσης, να ενεργοποιήσετε το GTK-Doc για το distcheckmake "
+#~ "target. Απλά προσθέστε τη γραμμή του επόμενου παραδείγματος στο ριζικό "
+#~ "<filename>Makefile.am</filename>:"
+
+#~ msgid "Enable GTK-Doc during make distcheck"
+#~ msgstr "Ενεργοποίηση του GTK-Doc κατά το make distcheck"
+
+#~ msgid ""
+#~ "\n"
+#~ "\n"
+#~ "DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
+#~ "\n"
+#~ " "
+#~ msgstr ""
+#~ "\n"
+#~ "\n"
+#~ "DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
+#~ "\n"
+#~ " "
+
+#~ msgid ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identifier:\n"
+#~ " *\n"
+#~ " * documentation ...\n"
+#~ " *\n"
+#~ " * # Sub heading #\n"
+#~ " *\n"
+#~ " * more documentation:\n"
+#~ " * - list item 1\n"
+#~ " * - list item 2\n"
+#~ " *\n"
+#~ " * Even more docs.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+#~ msgstr ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identifier:\n"
+#~ " *\n"
+#~ " * documentation ...\n"
+#~ " *\n"
+#~ " * # Sub heading #\n"
+#~ " *\n"
+#~ " * more documentation:\n"
+#~ " * - list item 1\n"
+#~ " * - list item 2\n"
+#~ " *\n"
+#~ " * Even more docs.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+
+#~ msgid ""
+#~ "Since GTK-Doc-1.18 the tool supports a subset or the <ulink url=\"http://"
+#~ "daringfireball.net/projects/markdown/\">markdown language</ulink>. One "
+#~ "can use it for sub-headings and simple itemized lists. On older GTK-Doc "
+#~ "versions the content will be rendered as it (the list items will appear "
+#~ "in one line separated by dashes). <_:example-1/>"
+#~ msgstr ""
+#~ "Από το GTK-Doc-1.18 το εργαλείο υποστηρίζει υποσύνολα ή <ulink url="
+#~ "\"http://daringfireball.net/projects/markdown/\">γλώσσα markdown</ulink>. "
+#~ "Κάποιος μπορεί να τα χρησιμοποιήσει για υπό-κεφαλίδες και για απλές "
+#~ "κατηγοριοποιημένες λίστες. Στις παλαιότερες εκδόσεις του GTK-Doc το "
+#~ "περιεχόμενο θα πρέπει να καταστεί ως έχει (τα στοιχεία της λίστας θα "
+#~ "εμφανιστούν σε μία γραμμή χωρισμένες με παύλες). <_:example-1/>"
#~ msgid "Chris"
#~ msgstr "Chris"
<para>Αν δεν έχετε <link linkend="fdl-invariant">Αμετάβλητες Ενότητες</link>, γράψτε <quote>χωρίς Αμετάβλητων Ενοτήτων</quote> αντί να λέτε ποια είναι αμετάβλητα. Αν δεν έχετε <link linkend="fdl-cover-texts">Κείμενα εμπροσθοφύλλου</link>, γράψτε <quote>χωρίς Κείμενα Εμπροσθοφύλλου</quote> αντί του <quote>τα Κείμενα Εμπροσθοφύλλου είναι τα ΚΑΤΑΛΟΓΟΣ</quote>, επίσης για <link linkend="fdl-cover-texts">Κείμενα οπισθοφύλλου</link>.</para>
- <para>Αν το έγγραφό σας περιέχει μη
ασήμαντα παραδείγματα πηγαίου κώδικα, συνιστούμε την παράλληλη δημοσίευσή τους υπό τους όρους της άδειας ελεύθερου λογισμικού της αρεσκείας σας,όπως η <ulink type="http" url="http://www.gnu.org/copyleft/gpl.html">Γενική Άδεια Δημόσιας Χρήσης GNU</ulink>, ώστε να επιτρέψετε τη χρήση τους σε ελεύθερο λογισμικό. </para>
+ <para>Αν το έγγραφό σας περιέχει μη
-ασήμαντα παραδείγματα πηγαίου κώδικα, συνιστούμε την παράλληλη δημοσίευσή τους, υπό τους όρους της άδειας ελεύθερου λογισμικού της αρεσκείας σας,όπως η <ulink type="http" url="http://www.gnu.org/copyleft/gpl.html">Γενική Άδεια Δημόσιας Χρήσης GNU</ulink>, ώστε να επιτρέψετε τη χρήση τους σε ελεύθερο λογισμικό. </para>
</sect1>
</appendix>
<book id="index" lang="el">
<bookinfo>
<title>Εγχειρίδιο GTK-Doc</title>
- <edition>1.18.1</edition>
- <abstract role="description"><para>Εγχειρίδιο χρήσης του GTK-Doc για προγραμματιστές.</para></abstract>
+ <edition>1.20</edition>
+ <abstract role="description"><para>Εγχειρίδιο χρήστη για προγραμματιστές με οδηγίες για τη χρήση του GTK-Doc.</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author><firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
</authorgroup>
<publisher role="maintainer"><publishername>Έργο GTK-Doc</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth και Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright><year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder></copyright>
<!-- translators: uncomment this:
<copyright>
</legalnotice>
<revhistory>
- <revision><revnumber>1.19.1</revnumber> <date>05 Ιουν 2013</date> <authorinitials>ss</authorinitials> <revremark>έκδοση ανάπτυξης</revremark></revision>
+ <revision><revnumber>1.20.1</revnumber> <date>16 Φεβ. 2014</date> <authorinitials>ss</authorinitials> <revremark>έκδοση ανάπτυξης</revremark></revision>
+ <revision><revnumber>1.20</revnumber> <date>16 Φεβ 2014</date> <authorinitials>ss</authorinitials> <revremark>διορθώσεις σφαλμάτων,, υποστήριξη markdown, και βελτιώσεις τεχνοτροπιών</revremark></revision>
<revision><revnumber>1.19</revnumber> <date>05 Ιουν 2013</date> <authorinitials>ss</authorinitials> <revremark>διόρθωση σφάλματος</revremark></revision>
<revision><revnumber>1.18</revnumber> <date>14 Σεπτ 2011</date> <authorinitials>ss</authorinitials> <revremark>διορθώσεις σφαλμάτων, επιταχύνσεις, υποστήριξη markdown</revremark></revision>
<revision><revnumber>1.17</revnumber> <date>26 Φεβ 2011</date> <authorinitials>sk</authorinitials> <revremark>διόρθωση σφάλματος</revremark></revision>
<revision><revnumber>1.16</revnumber> <date>14 Ιαν 2011</date> <authorinitials>sk</authorinitials> <revremark>διορθώσεις σφαλμάτων και βελτιώσεις διάταξης</revremark></revision>
- <revision><revnumber>1.15</revnumber> <date>21 Μαίου 2010</date> <authorinitials>sk</authorinitials> <revremark>bug and regression fixes</revremark></revision>
+ <revision><revnumber>1.15</revnumber> <date>21 Μαίου 2010</date> <authorinitials>sk</authorinitials> <revremark>διορθώσεις σφαλμάτων και αναδρομής</revremark></revision>
<revision><revnumber>1.14</revnumber> <date>28 Μαρτίου 2010</date> <authorinitials>sk</authorinitials> <revremark>διορθώσεις σφαλμάτων και βελτιώσεις επίδοσης</revremark></revision>
- <revision><revnumber>1.13</revnumber> <date>18 Δεκεμβρίου 2009</date> <authorinitials>sk</authorinitials> <revremark>ανανέωση σπασμένου συμπιεσμένου αρχείου</revremark></revision>
- <revision><revnumber>1.12</revnumber> <date>18 Δεκεμβρίου 2009</date> <authorinitials>sk</authorinitials> <revremark>νέα χαρακτηριστικά και διορθώσεις σφαλμάτων</revremark></revision>
+ <revision><revnumber>1.13</revnumber> <date>18 Δεκεμβρίου 2009</date> <authorinitials>sk</authorinitials> <revremark>ανανέωση κατεστραμμένου συμπιεσμένου αρχείου</revremark></revision>
+ <revision><revnumber>1.12</revnumber> <date>18 Î
\94εκεμβÏ
\81ίοÏ
\85 2009</date> <authorinitials>sk</authorinitials> <revremark>νÎα Ï
\87αÏ
\81ακÏ
\84ηÏ
\81ιÏ
\83Ï
\84ικά Î
µÏ\81γαλείÏ\89ν και διοÏ
\81θÏ
\8eÏ
\83ειÏ
\82 Ï
\83Ï
\86αλμάÏ
\84Ï
\89ν</revremark></revision>
<revision><revnumber>1.11</revnumber> <date>16 Νοεμβρίου 2008</date> <authorinitials>mal</authorinitials> <revremark>Μετάβαση σε GNOME doc-utils</revremark></revision>
</revhistory>
<holder>Δημήτρης Σπίγγος</holder>
</copyright>
+
+ <othercredit class="translator">
+ <personname>
+ <firstname>Μαρία Θουκυδίδου</firstname>
+ </personname>
+ <email>marablack3@gmail.com</email>
+ </othercredit>
+ <copyright>
+
+ <year>2014</year>
+
+ <holder>Μαρία Θουκυδίδου</holder>
+ </copyright>
</bookinfo>
<!-- ======== Chapter 1: Introduction ======================== -->
<para>Το GTK-Doc χρησιμοποιεί την τεκμηρίωση συναρτήσεων που έχει συμπεριληφθεί στα πηγαία αρχεία (εντός μπλοκ σχολίων με ειδική μορφή), ή την τεκμηρίωση που έχει προστεθεί στα πρότυπα αρχεία που χρησιμοποιεί το GTK-Doc (σημειώστε όμως ότι το GTK-Doc παράγει τεκμηρίωση μόνο για τις συναρτήσεις που δηλώνονται σε αρχεία κεφαλίδας· δεν παράγει τεκμηρίωση για στατικές συναρτήσεις).</para>
- <para>Το GTK-Doc αποτελείται από μια σειρά από σενάρια perl , καθένα από τα οποία είναι υπεύθυνο για διαφορετικό στάδιο της όλης διαδικασίας.</para>
+ <para>Το GTK-Doc αποτελείται από μια σειρά σεναρίων perl , καθένα από τα οποία είναι υπεύθυνο για διαφορετικό στάδιο της όλης διαδικασίας.</para>
<para>Η διαδικασία περιλαμβάνει 5 κύρια στάδια:</para>
</listitem>
<listitem>
- <para><guilabel>Συλλέγοντας πληροφορίες σχετικά με τον κώδικα.</guilabel> Το <application>gtkdoc-scan</application> σαρώνει τα αρχεία κεφαλίδων του κώδικα ψάχνοντας για δηλώσεις συναρτήσεων, μακροεντολές, enums, δομές και ενώσεις. Δημιουργεί το αρχείο <filename><module>-decl-list.txt</filename> που περιέχει μια λίστα με τις δηλώσεις, και τις τοποθετεί σε ενότητες αναλόγως με το αρχείο κεφαλίδας που βρίσκονται. Από την πρώτη εκτέλεση του προγράμματος το αρχείο αντιγράφεται στο <filename><module>-sections.txt</filename>. Ο συγγραφέας μπορεί να τακτοποιήσει τις ενότητες και τη σειρά των δηλώσεων, για να παράξει το επιθυμητό τελικό αποτέλεσμα. Το δεύτερο αρχείο δημιουργεί το <filename><module>-decl.txt</filename>. Το αρχείο αυτό περιέχει τις πλήρεις δηλώσεις που βρέθηκαν από τον σαρωτή.Αν για κάποιο λόγο θέλετε μερικά σύμβολα να εμφανίζονται στην τεκμηρίωση, όπου η πλήρης δήλωση δεν μπορεί να βρεθεί από τον σαρωτή ή πρέπει να εμφανίζεται διαφορετικά, κάποιος μπορεί να τοποθετήσει οντότητες όμοιες με αυτές <filename><module>-decl.txt</filename> στο αρχείο <filename><module>-overrides.txt</filename>.</para>
+ <para><guilabel>Συλλέγοντας πληροφορίες για τον κώδικα.</guilabel> Το <application>gtkdoc-scan</application> σαρώνει τα αρχεία κεφαλίδων του κώδικα ψάχνοντας για δηλώσεις συναρτήσεων, μακροεντολές, enums, δομές και ενώσεις. Δημιουργεί το αρχείο <filename><module>-decl-list.txt</filename> που περιέχει μια λίστα με τις δηλώσεις, και τις τοποθετεί σε ενότητες αναλόγως με το αρχείο κεφαλίδας στο οποίο βρίσκονται. Από την πρώτη εκτέλεση του προγράμματος το αρχείο αντιγράφεται στο <filename><module>-sections.txt</filename>. Ο συγγραφέας μπορεί να τακτοποιεί τις ενότητες και τη σειρά των δηλώσεων, για να παραγάγει το επιθυμητό τελικό αποτέλεσμα. Το δεύτερο αρχείο δημιουργεί το <filename><module>-decl.txt</filename>. Το αρχείο αυτό περιέχει τις πλήρεις δηλώσεις που βρέθηκαν από τον σαρωτή.Αν για κάποιο λόγο θέλετε μερικά σύμβολα να εμφανίζονται στην τεκμηρίωση, όπου η πλήρης δήλωση δεν μπορεί να βρεθεί από τον σαρωτή, ή πρέπει να εμφανίζεται διαφορετικά, μπορεί κάποιος να τοποθετήσει οντότητες παρόμοιες με αυτές <filename><module>-decl.txt</filename> στο αρχείο <filename><module>-overrides.txt</filename>.</para>
<para>Το <application>gtkdoc-scanobj</application> μπορεί επίσης να χρησιμοποιηθεί για να κάνει δυναμική αναζήτηση σε μια βιβλιοθήκη για ενδεχόμενες υποκλάσεις GObject. Αποθηκεύει τις πληροφορίες για τη θέση κάθε αντικειμένου στην ιεραρχία κλάσεων καθώς και για τα ορίσματα και σήματα GObject που περιέχει.</para>
<para>Το <application>gtkdoc-scanobj</application> δεν πρέπει να χρησιμοποιείτε πλέον. Χρειαζόταν στο παρελθόν όταν το GObject ήταν ακόμα GtkObject μέσα στη gtk+.</para>
</listitem>
<listitem>
- <para><guilabel>Δημιουργία "πρότυπων" αρχείων</guilabel> Το <application>gtkdoc-mktmpl</application> παράγει μια σειρά από αρχεία στον υποκατάλογο <filename class="directory">tmpl/</filename>, χρησιμοποιώντας τις πληροφορίες που συλλέχθηκαν κατά το πρώτο στάδιο. (Σημειώστε ότι μπορεί να εκτελεστεί περισσότερες από μία φορές. Προσπαθεί να διασφαλίσει ότι δεν χάνεται ποτέ και κανενός είδους τεκμηρίωση.)</para>
+ <para><guilabel>Δημιουργία "πρότυπων" αρχείων</guilabel> Το <application>gtkdoc-mktmpl</application> παράγει μια σειρά από αρχεία στον υποκατάλογο <filename class="directory">tmpl/</filename>, χρησιμοποιώντας τις πληροφορίες που συλλέχθηκαν κατά το πρώτο στάδιο. (Σημειώστε ότι μπορεί να εκτελεσθεί περισσότερες από μία φορές. Προσπαθεί να διασφαλίσει ότι δεν χάνεται ποτέ και κανενός είδους τεκμηρίωση.)</para>
<note>
- <para>Από την έκδοση GTK-Doc 1.9 και μετά τα πρότυπα αρχεία δεν είναι πλέον απαραίτητα. Σας συνιστούμε να διατηρείτε την τεκμηρίωση στον κώδικα. Το <application>gtkdocize</application> υποστηρίζει πλέον την επιλογή <option>--flavour no-tmpl</option> η οποία επιλέγει ένα αρχείο makefile που δεν χρησιμοποιεί καθόλου πρότυπα tmpl. Αν δεν έχετε κάνει ποτέ αλλαγές με το χέρι σε αρχεία προτύπων tmpl, παρακαλώ αφαιρέστε τον κατάλογο (π.χ. από ένα σύστημα ελέγχου εκδόσεων).</para>
+ <para>Από την έκδοση GTK-Doc 1.9 και μετά
, τα πρότυπα αρχεία δεν είναι πλέον απαραίτητα. Σας συνιστούμε να διατηρείτε την τεκμηρίωση στον κώδικα. Το <application>gtkdocize</application> υποστηρίζει πλέον την επιλογή <option>--flavour no-tmpl</option> η οποία επιλέγει ένα αρχείο makefile που δεν χρησιμοποιεί καθόλου πρότυπα tmpl. Αν δεν έχετε κάνει ποτέ αλλαγές με το χέρι σε αρχεία προτύπων tmpl, παρακαλώ αφαιρέστε τον κατάλογο (π.χ. από ένα σύστημα ελέγχου εκδόσεων).</para>
</note>
</listitem>
<listitem>
<para><guilabel>Παραγωγή SGML/XML και HTML/PDF</guilabel>. Το <application>gtkdoc-mkdb</application> μετατρέπει τα αρχεία προτύπων tmpl σε αρχεία SGML ή XML και τα τοποθετεί στους υποκαταλόγους <filename class="directory">sgml/</filename> ή <filename class="directory">xml/</filename>. Αν ο πηγαίος κώδικας περιέχει τεκμηρίωση συναρτήσεων εντός ειδικών μπλοκ σχολίων, τα σχόλια συγχωνεύονται σε αυτό το στάδιο. Αν δεν υπάρχουν αρχεία προτύπων tmpl, τότε χρησιμοποιούνται μόνο τα έγγραφα που προέκυψαν από τον πηγαίο κώδικα και τα δεδομένα της ενδοσκόπησης. Σας συνιστούμε να χρησιμοποιήσετε το βιβλίο τεκμηρίωσης XML.</para>
- <para> Το <application>gtkdoc-mkhtml</application> μετατρέπει τα αρχεία SGML/XML σε αρχεία HTML που τοποθετούνται στον υποκατάλογο <filename class="directory">html/</filename>. Ομοίως το <application>gtkdoc-mkpdf</application> μετατρέπει τα αρχεία SGML/XML σε ένα αρχείο PDF που ονομάζεται <filename><package>.pdf</filename>.</para>
+ <para> Το <application>gtkdoc-mkhtml</application> μετατρέπει τα αρχεία SGML/XML σε αρχεία HTML που τοποθετούνται στον υποκατάλογο <filename class="directory">html/</filename>. Ομοίως
, το <application>gtkdoc-mkpdf</application> μετατρέπει τα αρχεία SGML/XML σε ένα αρχείο PDF που ονομάζεται <filename><package>.pdf</filename>.</para>
<para>Τα αρχεία στους καταλόγους <filename class="directory">sgml/</filename>, <filename class="directory">xml/</filename> και <filename class="directory">html/</filename> αντικαθίστανται αυτόματα. Επομένως, δεν πρέπει να τα αλλάζετε με το χέρι.</para>
</listitem>
<listitem>
- <para><guilabel>Διόρθωση παραπομπών μεταξύ εγγράφων</guilabel> Μετά την εγκατάσταση των αρχείων HTML, μπορείτε να εκτελέσετε το <application>gtkdoc-fixxref</application> για να διορθώσετε τυχόν παραπομπές σε διαφορετικά έγγραφα. Για παράδειγμα, η τεκμηρίωση του GTK+ περιέχει πολλές παραπομπές σε τύπους που επεξηγούνται στο εγχειρίδιο του GLib. Όταν ετοιμάζετε πακέτα κώδικα για διανομή, μπορείτε να χρησιμοποιείτε το <application>gtkdoc-rebase</application> για να μετατρέπετε όλους τους εξωτερικούς συνδέσμους σε διαδικτυακούς συνδέσμους. Κατά την εγκατάσταση της τεκμηρίωσης που περιλαμβάνεται στο διανεμηθέντα κώδικα (παράγεται αυτόματα), η ίδια εφαρμογή θα προσπαθήσει να μετατρέψει ξανά τους συνδέσμους σε τοπικούς συνδέσμους (προς τις τοποθεσίες όπου είναι εγκατεστημένη η τεκμηρίωση).</para>
+ <para><guilabel>Διόρθωση διασταυρούμενων παραπομπών μεταξύ εγγράφων</guilabel> Μετά την εγκατάσταση των αρχείων HTML, μπορείτε να εκτελέσετε το <application>gtkdoc-fixxref</application> για να διορθώσετε τυχόν διασταυρούμενες παραπομπές σε διαφορετικά έγγραφα. Για παράδειγμα, η τεκμηρίωση του GTK+ περιέχει πολλές παραπομπές σε τύπους που επεξηγούνται στο εγχειρίδιο του GLib. Όταν ετοιμάζετε πακέτα κώδικα για διανομή, μπορείτε να χρησιμοποιείτε το <application>gtkdoc-rebase</application> για να μετατρέπετε όλους τους εξωτερικούς συνδέσμους σε διαδικτυακούς συνδέσμους. Κατά την εγκατάσταση της τεκμηρίωσης που περιλαμβάνεται στον διανεμηθέντα κώδικα (παράγεται αυτόματα), η ίδια εφαρμογή θα προσπαθήσει να μετατρέψει ξανά τους συνδέσμους σε τοπικούς συνδέσμους (προς τις τοποθεσίες όπου είναι εγκατεστημένη η τεκμηρίωση).</para>
</listitem>
</orderedlist>
<sect2 id="requirements">
<title>Απαιτήσεις</title>
<para><guilabel>Perl v5</guilabel> - τα βασικά σενάρια είναι γραμμένα σε Perl.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - Πρόκειται για την DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - Πρόκειται για επεξεργαστή DSSSL που μετατρέπει τη SGML σε διάφορες άλλες μορφές. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modular DocBook Stylesheets</guilabel> Πρόκειται για τον κώδικα DSSSL που απαιτείται για τη μετατροπή από DocBook σε HTML (και ορισμένες άλλες μορφές). Χρησιμοποιείται σε συνδυασμό με το jade. Έχουν γίνει κάποιες μικρές προσαρμογές του κώδικα DSSSL, στο gtk-doc.dsl, για το χρωματισμό κώδικα/δηλώσεων και για την υποστήριξη των καθολικών ευρετηρίων παραπομπών στα παραγόμενα HTML. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - Σε περίπτωση που θέλετε να δημιουργήσετε σελίδες man από το DocBook. Έχουν γίνει κάποιες μικρές προσαρμογές των 'προδιαγραφών μετάφρασης', για να εμφανίζονται με κεφαλαία οι τίτλοι ενοτήτων και να προστίθενται ο τίτλος 'Βιβλιοθήκη GTK' στην αρχή της σελίδας και η ημερομηνία αναθεώρησης στο τέλος της. Βλέπε <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> ΣΗΜΕΙΩΣΗ: Αυτή η δυνατότητα δε λειτουργεί προς το παρόν.</para>
+ <para><guilabel>xsltproc</guilabel> - το πρόγραμμα xslt processor από τη βιβλιοθήκη libxslt <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink></para>
+ <para><guilabel>docbook-xsl</guilabel> - τα docbook xsl stylesheets <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink></para>
+ <para><guilabel>Python</guilabel> - προαιρετική - για το gtkdoc-depscan</para>
+ <para>Ένα από τα <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> ή <guilabel>vim</guilabel> - optional - που χρησιμοποιούνται για την επισήμανση της σύνταξης στα παραδείγματα</para>
</sect2>
-
- <sect2 id="installation">
- <title>Εγκατάσταση</title>
- <para>Δεν υπάρχει σταθερή τοποθεσία για την εγκατάσταση των DocBook Modular Stylesheets.</para>
- <para>Το σενάριο εντολών configure του GTK-Doc ψάχνει αυτόματα τους τρεις παρακάτω καταλόγους:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (χρησιμοποιείται από το RedHat)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (χρησιμοποιείται από το Debian)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (χρησιμοποιείται από το SuSE)</para>
- <para>Αν τα φύλλα στυλ είναι εγκατεστημένα κάπου αλλού, θα πρέπει να ρυθμίσετε GTK-Doc με την επιλογή: <command> --with-dsssl-dir=< ΔΙΑΔΡΟΜΗ_ΠΡΟΣ_ΡΙΖΙΚΟ_ΚΑΤΑΛΟΓΟ_ΦΥΛΛΩΝ_ΣΤΥΛ> </command></para>
- </sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>Περί GTK-Doc</title>
<para>(ΠΡΟΣ ΔΙΟΡΘΩΣΗ)</para>
- <para>(Ιστορικό, συγγραφείς, ιστοσελίδες, άδεια, μελλοντικά σχέδια, σύγκριση με άλλα παρόμοια συστήματα.)</para>
+ <para>(Ιστορικό, συγγραφείς, ιστοσελίδες, ταχυδρομική λίστα, άδεια, μελλοντικά σχέδια, σύγκριση με άλλα παρόμοια συστήματα.)</para>
</sect1>
</chapter>
<chapter id="settingup">
- <title>Δημιουργώντας ένα έργο</title>
+ <title>Δημιουργώντας το δικό σας έργο</title>
- <para>Î\9fι εÏ\80Ï\8cμενεÏ\82 ενÏ\8cÏ\84ηÏ\84εÏ\82 Ï\80εÏ\81ιγÏ\81άÏ\86οÏ\85ν Ï\84α βήμαÏ\84α Ï\80οÏ\85 αÏ\80αιÏ\84οÏ\8dνÏ\84αι για να ενÏ\83Ï\89μαÏ\84Ï\8eÏ\83εÏ\84ε Ï\84ο GTK-Doc Ï\83Ï\84ο ÎÏ\81γο Ï\83αÏ\82. Î¥Ï\80οθÎÏ\83Ï\84ε Ï\8cÏ\84ι εÏ\81γάζεÏ\83Ï\84ε Ï\83Ï\84ο ÎÏ\81γο 'meep'. Το ÎÏ\81γο Ï\80εÏ\81ιÎÏ\87ει Ï\84η βιβλιοθήκη 'libmeep' και Ï\84ην εÏ\86αÏ\81μογή 'meeper' για Ï\84ον Ï\84ελικÏ\8c Ï\87Ï\81ήÏ\83Ï\84η. Î¥Ï\80οθÎÏ\83Ï\84ε εÏ\80ίÏ\83ηÏ\82 Ï\8cÏ\84ι θα Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83οÏ\85με Ï\84ο autoconf και Ï\84ο automake. Î\95Ï\80ιÏ\80λÎον η ενÏ\8cÏ\84ηÏ\84α <link linkend="plain_makefiles">αÏ\81Ï\87εία makefiles ή άλλα Ï\83Ï\85Ï\83Ï\84ήμαÏ\84α ανάÏ\80Ï\84Ï\85ξηÏ\82</link> Ï\80εÏ\81ιγÏ\81άÏ\86ει Ï\84α βαÏ\83ικά Ï\80οÏ\85 Ï\87Ï\81ειάζονÏ\84αι για να δοÏ\85λÎÏ\88οÏ\85με Ï\83ε διαφορετικό έργο.</para>
+ <para>Î\9fι εÏ\80Ï\8cμενεÏ\82 ενÏ\8cÏ\84ηÏ\84εÏ\82 Ï\80εÏ\81ιγÏ\81άÏ\86οÏ\85ν Ï\84α βήμαÏ\84α Ï\80οÏ\85 αÏ\80αιÏ\84οÏ\8dνÏ\84αι για να ενÏ\83Ï\89μαÏ\84Ï\8eÏ\83εÏ\84ε Ï\84ο GTK-Doc Ï\83Ï\84ο ÎÏ\81γο Ï\83αÏ\82. Î\91Ï\85Ï\84ÎÏ\82 οι ενÏ\8cÏ\84ηÏ\84εÏ\82 Ï\80Ï\81οÏ\8bÏ\80οθÎÏ\84οÏ\85ν Ï\8cÏ\84ι εÏ\81γάζεÏ\83θε Ï\83ε Îνα ÎÏ\81γο Ï\80οÏ\85 λÎγεÏ\84αι 'meep'. Το ÎÏ\81γο Ï\80εÏ\81ιÎÏ\87ει Ï\84η βιβλιοθήκη 'libmeep' και Ï\84ην εÏ\86αÏ\81μογή 'meeper' για Ï\84ον Ï\84ελικÏ\8c Ï\87Ï\81ήÏ\83Ï\84η. Î Ï\81οÏ\8bÏ\80οÏ\84ίθεÏ\84αι εÏ\80ίÏ\83ηÏ\82 Ï\8cÏ\84ι θα Ï\87Ï\81ηÏ\83ιμοÏ\80οιείÏ\84ε Ï\84ο autoconf και Ï\84ο automake. Î\95Ï\80ιÏ\80λÎον, η ενÏ\8cÏ\84ηÏ\84α <link linkend="plain_makefiles">αÏ\81Ï\87εία makefiles ή άλλα Ï\83Ï\85Ï\83Ï\84ήμαÏ\84α ανάÏ\80Ï\84Ï\85ξηÏ\82</link> Ï\80εÏ\81ιγÏ\81άÏ\86ει Ï\84α βαÏ\83ικά Ï\80οÏ\85 Ï\87Ï\81ειάζονÏ\84αι για να δοÏ\85λÎÏ\88εÏ\84ε Ï\83ε Îνα διαφορετικό έργο.</para>
<sect1 id="settingup_docfiles">
<title>Δημιουργία του σκελετού τεκμηρίωσης</title>
<para>Εντός του ριζικού καταλόγου του έργου δημιουργήστε το φάκελο docs/reference (ώστε να μπορείτε να χρησιμοποιήσετε το όνομα docs/help για την τεκμηρίωση του τελικού χρήστη). Συνιστάται να δημιουργήσετε έναν ακόμη υποκατάλογο με το όνομα του πακέτου τεκμηρίωσης. Αυτό δε χρειάζεται για πακέτα που περιλαμβάνουν μόνο μία βιβλιοθήκη.</para>
- <para>Αυτό θα φαίνεται όπως είναι παρακάτω: <example><title>Παράδειγμα δομής καταλόγου</title>
+ <para>Αυτό θα φαίνεται, λοιπόν, όπως εμφανίζεται παρακάτω: <example><title>Παράδειγμα δομής καταλόγου</title>
<programlisting>
-
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+</programlisting>
</example></para>
</sect1>
<para>
<example><title>Ενσωμάτωση στο autoconf</title>
<programlisting>
-
# έλεγχος για gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+</programlisting>
</example>
</para>
- <para>Î\91Ï\85Ï\84Ï\8c θα εÏ\80αιÏ\84εί Ï\8cλοι οι Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 να ÎÏ\87οÏ\85ν εγκαÏ\84εÏ\83Ï\84ημÎνο Ï\84ο gtk-doc. Î\91ν είναι ενÏ\84άξει για Ï\84ο ÎÏ\81γο Ï\83αÏ\82 να ÎÏ\87εÏ\84ε εÏ\80ιÏ\80λÎον καÏ\84αÏ\83κεÏ\85ή Ï\81Ï\85θμίÏ\83εÏ\89ν για Ï\84ο api-doc, μÏ\80οÏ\81είÏ\84ε να Ï\84ο εÏ\80ιλÏ\8dÏ\83εÏ\84ε Ï\8cÏ\80Ï\89Ï\82 αναÏ\86ÎÏ\81εÏ\84ε Ï\80αÏ\81ακάÏ\84Ï\89. Î\91Ï\86ήÏ\83Ï\84ε Ï\84ο Ï\8cÏ\80Ï\89Ï\82 ÎÏ\87ει, Ï\8cÏ\83ο Ï\84ο gtkdocize Ï\88άÏ\87νει Ï\83την αρχή της σειράς για το <function>GTK_DOC_CHECK</function>. <example><title>Προαιρετικά κρατήστε το gtk-doc</title>
+ <para>Î\91Ï\85Ï\84Ï\8c αÏ\80αιÏ\84εί αÏ\80Ï\8c Ï\8cλοÏ\85Ï\82 Ï\84οÏ\85Ï\82 Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 να ÎÏ\87οÏ\85ν εγκαÏ\84εÏ\83Ï\84ημÎνο Ï\84ο gtk-doc. Î\91ν είναι ενÏ\84άξει για Ï\84ο ÎÏ\81γο Ï\83αÏ\82 να ÎÏ\87εÏ\84ε μια εÏ\80ιÏ\80λÎον καÏ\84αÏ\83κεÏ\85ή Ï\81Ï\85θμίÏ\83εÏ\89ν για Ï\84ο api-doc, μÏ\80οÏ\81είÏ\84ε να Ï\84ο εÏ\80ιλÏ\8dÏ\83εÏ\84ε Ï\8cÏ\80Ï\89Ï\82 αναÏ\86ÎÏ\81εÏ\84αι Ï\80αÏ\81ακάÏ\84Ï\89. Î\91Ï\86ήÏ\83Ï\84ε Ï\84ο Ï\89Ï\82 ÎÏ\87ει, Ï\8cÏ\83ο Ï\84ο gtkdocize αναζηÏ\84ά την αρχή της σειράς για το <function>GTK_DOC_CHECK</function>. <example><title>Προαιρετικά κρατήστε το gtk-doc</title>
<programlisting>
-
# έλεγχος για gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-
- </programlisting>
+</programlisting>
</example></para>
<para>Το πρώτο όρισμα χρησιμοποιείται για έλεγχο του gtkdocversion κατά τη ρύθμιση. Το δεύτερο, προαιρετικό όρισμα χρησιμοποιείται από το <application>gtkdocize</application>. Η μακροεντολή <symbol>GTK_DOC_CHECK</symbol> επίσης προσθέτει αρκετούς διακόπτες ρύθμισης:</para>
<orderedlist>
<listitem><para>--with-html-dir=ΔΙΑΔΡΟΜΗ : διαδρομή προς την εγκατεστημένη τεκμηρίωση</para></listitem>
- <listitem><para>--enable-gtk-doc : χρήση gtk-doc για την τεκμηρίωσης [default=no]</para></listitem>
+ <listitem><para>--enable-gtk-doc : χρήση gtk-doc για την τεκμηρίωση [default=no]</para></listitem>
<listitem><para>--enable-gtk-doc-html : παραγωγή τεκμηρίωσης σε μορφή html [default=yes]</para></listitem>
<listitem><para>--enable-gtk-doc-pdf : παραγωγή τεκμηρίωσης σε μορφή pdf [default=no]</para></listitem>
</orderedlist>
<important>
- <para>Î\97 Ï\80Ï\81οεÏ\80ιλογή είναι να είναι αÏ\80ενεÏ\81γοÏ\80οιημÎνο Ï\84ο GTK-Doc! Î\98Ï\85μηθείÏ\84ε να Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83εÏ\84ε Ï\84ην εÏ\80ιλογή <option>'--enable-gtk-doc'</option> Ï\83Ï\84ην εÏ\80Ï\8cμενη εκÏ\84ÎλεÏ\83η Ï\84οÏ\85 <filename>configure</filename>. Î\94ιαÏ\86οÏ\81εÏ\84ικά εγκαθίÏ\83Ï\84αÏ\84αι η Ï\80Ï\81οÏ\80αÏ\81αÏ\87θείÏ\83α Ï\84εκμηÏ\81ίÏ\89Ï\83η (δÏ\85ναÏ\84Ï\8cÏ\84ηÏ\84α Ï\87Ï\81ήÏ\83ιμη για Ï\84ο χρήστη, αλλά όχι για τον προγραμματιστή).</para>
+ <para>Το GTK-Doc είναι αÏ\80ενεÏ\81γοÏ\80οιημÎνο αÏ\80Ï\8c Ï\80Ï\81οεÏ\80ιλογή! Î\9dα θÏ\85μάÏ\83Ï\84ε να Ï\87Ï\81ηÏ\83ιμοÏ\80οιείÏ\84ε Ï\84ην εÏ\80ιλογή <option>'--enable-gtk-doc'</option> Ï\83Ï\84ην εÏ\80Ï\8cμενη εκÏ\84ÎλεÏ\83η Ï\84οÏ\85 <filename>configure</filename>. Î\94ιαÏ\86οÏ\81εÏ\84ικά, εγκαθίÏ\83Ï\84αÏ\84αι η Ï\80Ï\81οÏ\80αÏ\81αÏ\87θείÏ\83α Ï\84εκμηÏ\81ίÏ\89Ï\83η (δÏ\85ναÏ\84Ï\8cÏ\84ηÏ\84α Ï\87Ï\81ήÏ\83ιμη για Ï\84ον χρήστη, αλλά όχι για τον προγραμματιστή).</para>
</important>
<para>Επίσης, συνιστάται να προσθέσετε την ακόλουθη γραμμή στο σενάριο <filename>configure.ac</filename>. Επιτρέπει στο <filename>gtkdocize</filename> να αντιγράφει αυτόματα τον ορισμό της μακροεντολής <function>GTK_DOC_CHECK</function> στο έργο σας.</para>
<para>
<example><title>Προετοιμασία για το gtkdocize</title>
<programlisting>
-
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+</programlisting>
</example>
</para>
+ <para>Όταν όλες οι αλλαγές στο <filename>configure.ac</filename> έχουν γίνει, ενημερώστε το αρχείο <filename>ρύθμιση</filename>. Αυτό μπορείτε να το κάνετε επανεκετελώντας το <code>autoreconf -i</code> ή το <code>autogen.sh</code>.</para>
</sect1>
<sect1 id="settingup_automake">
<title>Ενσωμάτωση στο automake</title>
- <para>
- First copy the <filename>Makefile.am</filename> from the
- <filename class="directory">examples</filename> sub directory of the
- <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink>
- to your project's API documentation directory (
- <filename class="directory">./docs/reference/<package></filename>).
- A local copy should be available under e.g.
- <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>.
- If you have multiple doc-packages repeat this for each one.
- </para>
+ <para>Πρώτα αντιγράψτε το <filename>Makefile.am</filename> από τον υποκατάλογο με τα <filename class="directory">παραδείγματα</filename> των <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink> στον κατάλογο της τεκμηρίωσης API του έργου σας ( <filename class="directory">./docs/reference/<package></filename>). Ένα τοπικό αντίγραφο θα πρέπει να είναι διαθέσιμο π.χ. στο <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>. Αν έχετε πολλά doc-packages επαναλάβετε αυτό το βήμα για το καθένα απο αυτά.</para>
<para>Το επόμενο βήμα είναι να τροποποιήσετε τις ρυθμίσεις στο <filename>Makefile.am</filename>. Πριν από κάθε ρύθμιση υπάρχει ένα σχόλιο που εξηγεί τη χρησιμότητά της. Οι περισσότερες είναι σημαίες που στέλνονται στα αντίστοιχα εργαλεία. Κάθε εργαλείο διαθέτει μια μεταβλητή της μορφής <option><ΟΝΟΜΑ_ΕΡΓΑΛΕΙΟΥ>_ΕΠΙΛΟΓΕΣ</option>. όλα τα εργαλεία υποστηρίζουν την επιλογή <option>--help</option> για την παραγωγή λίστας με τις υποστηριζόμενες παραμέτρους.</para>
<sect1 id="settingup_autogen">
<title>Ενσωμάτωση στο autogen</title>
- <para>Τα περισσότερα έργα διαθέτουν ένα σενάριο <filename>autogen.sh</filename> για τη δημιουργία υποδομών μετά από το checkout από ένα το σύστημα ελέγχου εκδόσεων (π.χ., cvs/svn/git). Το GTK-Doc διαθέτει το εργαλείο <filename>gtkdocize</filename>, το οποίο μπορεί να χρησιμοποιηθεί για ένα τέτοιο σενάριο. Θα πρέπει να εκτελείται πριν το autoheader, το automake ή το autoconf.</para>
+ <para>Τα περισσότερα έργα διαθέτουν ένα σενάριο <filename>autogen.sh</filename> για τη δημιουργία υποδομών μετά από έναν έλεγχο από το σύστημα ελέγχου εκδόσεων (π.χ., cvs/svn/git). Το GTK-Doc διαθέτει το εργαλείο <filename>gtkdocize</filename>, το οποίο μπορεί να χρησιμοποιηθεί για ένα τέτοιο σενάριο. Θα πρέπει να εκτελείται πριν το autoheader, το automake ή το autoconf.</para>
<para>
<example><title>Εκτέλεση του gtkdocize από το autogen.sh</title>
<programlisting>
-
gtkdocize || exit 1
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Κατά την εκτέλεσή του, το <filename>gtkdocize</filename> αντιγράφει το <filename>gtk-doc.make</filename> στο ριζικό κατάλογο του έργου σας (ή στον κατάλογο που ορίζει η επιλογή <option>--docdir</option>). Επίσης, ελέγχει το σενάριο configure για να βρει την κλήση στο <function>GTK_DOC_CHECK</function>.</para>
- <para>Î\91Ï\81Ï\87ικά, Ï\84ο GTK-Doc δημιοÏ\85Ï\81γοÏ\8dÏ\83ε αÏ\81Ï\87εία Ï\80Ï\81οÏ\84Ï\8dÏ\80Ï\89ν εκεί Ï\80οÏ\85 οι Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 ειÏ\83ήγαγαν Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η. Î\94Ï\85Ï\83Ï\84Ï\85Ï\87Ï\8eÏ\82, αÏ\85Ï\84ή η Ï\80Ï\81οÏ\83ÎγγιÏ\83η δεν ήÏ\84αν ιδιαίÏ\84εÏ\81α εÏ\80ιÏ\84Ï\85Ï\87ήÏ\82 (Ï\80.Ï\87 η ανάγκη για Ï\84ην Ï\80αÏ\81αγÏ\89γή αÏ\81Ï\87είÏ\89ν Ï\83Ï\84ο Ï\83Ï\8dÏ\83Ï\84ημα ελÎγÏ\87οÏ\85 εκδÏ\8cÏ\83εÏ\89ν). Î\91Ï\80Ï\8c Ï\84ην ÎκδοÏ\83η 1.9 και μεÏ\84ά, Ï\84α Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α αÏ\81Ï\87εία δεν είναι Ï\80λÎον αÏ\80αÏ\81αίÏ\84ηÏ\84α. ΣαÏ\82 Ï\83Ï\85νιÏ\83Ï\84οÏ\8dμε να διαÏ\84ηÏ\81είÏ\84ε Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η Ï\83Ï\84ον κÏ\8eδικα. To <application>gtkdocize</application> Ï\85Ï\80οÏ\83Ï\84ηÏ\81ίζει Ï\80λÎον Ï\84ην εÏ\80ιλογή <option>--flavour no-tmpl</option> Ï\80οÏ\85 εÏ\80ιλÎγει Îνα αÏ\81Ï\87είο makefile Ï\80οÏ\85 δεν Ï\87Ï\81ηÏ\83ιμοÏ\80οιεί καθÏ\8cλοÏ\85 Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α tmpl. Î ÎÏ\81α αÏ\80Ï\8c Ï\84ην άμεÏ\83η Ï\80Ï\81οÏ\83θήκη Ï\84ηÏ\82 εÏ\80ιλογήÏ\82 Ï\83Ï\84ην κλήÏ\83η Ï\84ηÏ\82 ενÏ\84ολήÏ\82, μÏ\80οÏ\81εί να Ï\80Ï\81οÏ\83Ï\84εθεί και Ï\83ε μια μεÏ\84αβληÏ\84ή Ï\80εÏ\81ιβάλλονÏ\84οÏ\82 Ï\80οÏ\85 ονομάζεÏ\84αι <symbol>GTKDOCIZE_FLAGS</symbol> ή να οÏ\81ιÏ\83Ï\84εί ως δεύτερη παράμετρος στη μακροεντολή <symbol>GTK_DOC_CHECK</symbol> στο σενάριο configure. Αν δεν έχετε κάνει ποτέ αλλαγές με το χέρι σε αρχεία προτύπων και μεταβαίνετε από μια παλιότερη έκδοση του gtkdoc, παρακαλώ αφαιρέστε τον κατάλογο (π.χ. από το σύστημα ελέγχου εκδόσεων).</para>
+ <para>Î\91Ï\81Ï\87ικά, Ï\84ο GTK-Doc δημιοÏ\85Ï\81γοÏ\8dÏ\83ε αÏ\81Ï\87εία Ï\80Ï\81οÏ\84Ï\8dÏ\80Ï\89ν εκεί Ï\80οÏ\85 οι Ï\80Ï\81ογÏ\81αμμαÏ\84ιÏ\83Ï\84ÎÏ\82 ειÏ\83ήγαγαν Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η. Î\94Ï\85Ï\83Ï\84Ï\85Ï\87Ï\8eÏ\82, αÏ\85Ï\84ή η Ï\80Ï\81οÏ\83ÎγγιÏ\83η δεν ήÏ\84αν ιδιαίÏ\84εÏ\81α εÏ\80ιÏ\84Ï\85Ï\87ήÏ\82 (Ï\80.Ï\87 η ανάγκη για Ï\80αÏ\81αγÏ\89γή αÏ\81Ï\87είÏ\89ν Ï\83Ï\84ο Ï\83Ï\8dÏ\83Ï\84ημα ελÎγÏ\87οÏ\85 εκδÏ\8cÏ\83εÏ\89ν). Î\91Ï\80Ï\8c Ï\84ην ÎκδοÏ\83η 1.9 και μεÏ\84ά, Ï\84α Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α αÏ\81Ï\87εία δεν είναι Ï\80λÎον αÏ\80αÏ\81αίÏ\84ηÏ\84α. ΣαÏ\82 Ï\83Ï\85νιÏ\83Ï\84οÏ\8dμε να διαÏ\84ηÏ\81είÏ\84ε Ï\84ην Ï\84εκμηÏ\81ίÏ\89Ï\83η Ï\83Ï\84ον κÏ\8eδικα. To <application>gtkdocize</application> Ï\85Ï\80οÏ\83Ï\84ηÏ\81ίζει Ï\80λÎον Ï\84ην εÏ\80ιλογή <option>--flavour no-tmpl</option> Ï\80οÏ\85 εÏ\80ιλÎγει Îνα αÏ\81Ï\87είο makefile Ï\80οÏ\85 δεν Ï\87Ï\81ηÏ\83ιμοÏ\80οιεί καθÏ\8cλοÏ\85 Ï\80Ï\81Ï\8cÏ\84Ï\85Ï\80α tmpl. Î ÎÏ\81α αÏ\80Ï\8c Ï\84ην άμεÏ\83η Ï\80Ï\81οÏ\83θήκη Ï\84ηÏ\82 εÏ\80ιλογήÏ\82 Ï\83Ï\84ην κλήÏ\83η Ï\84ηÏ\82 ενÏ\84ολήÏ\82, μÏ\80οÏ\81εί να Ï\80Ï\81οÏ\83Ï\84εθεί και Ï\83ε μια μεÏ\84αβληÏ\84ή Ï\80εÏ\81ιβάλλονÏ\84οÏ\82 Ï\80οÏ\85 ονομάζεÏ\84αι <symbol>GTKDOCIZE_FLAGS</symbol> ή να οÏ\81ιÏ\83θεί ως δεύτερη παράμετρος στη μακροεντολή <symbol>GTK_DOC_CHECK</symbol> στο σενάριο configure. Αν δεν έχετε κάνει ποτέ αλλαγές με το χέρι σε αρχεία προτύπων και μεταβαίνετε από μια παλιότερη έκδοση του gtkdoc, παρακαλώ αφαιρέστε τον κατάλογο (π.χ. από το σύστημα ελέγχου εκδόσεων).</para>
</sect1>
<sect1 id="settingup_firstrun">
<title>Παραγωγή της τεκμηρίωσης</title>
- <para>Αφού ολοκληρωθούν τα προηγούμενα βήματα, προχωρήστε στην παραγωγή. Πρώτα, θα πρέπει να εκτελεστεί εκ νέου το <filename>autogen.sh</filename>. Αν το σενάριο εκτελεί και το configure, προσθέστε την επιλογή <option>--enable-gtk-doc</option>. Διαφορετικά, εκτελέστε εσείς το<filename>configure</filename> με αυτή την επιλογή.</para>
+ <para>Αφού ολοκληρωθούν τα προηγούμενα βήματα, προχωρήστε στην παραγωγή. Πρώτα, θα πρέπει να εκτελεσθεί εκ νέου το <filename>autogen.sh</filename>. Αν το σενάριο εκτελεί και το configure, προσθέστε την επιλογή <option>--enable-gtk-doc</option>. Διαφορετικά, εκτελέστε εσείς το<filename>configure</filename> με αυτή την επιλογή.</para>
<para>Η πρώτη εκτέλεση του make δημιουργεί μια σειρά από πρόσθετα αρχεία στους καταλόγους της τεκμηρίωσης. Τα σημαντικά είναι τα: <filename><package>.types</filename>, <filename><package>-docs.xml</filename> (στο παρελθόν .sgml), <filename><package>-sections.txt</filename>.</para>
<para>
<example><title>Παραγωγή της τεκμηρίωσης</title>
<programlisting>
-
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Τώρα, μπορείτε να εμφανίσετε το <filename>docs/reference/<package>/index.html</filename> στον περιηγητή σας. Είναι αλήθεια ότι προς το παρόν το αποτέλεσμα είναι μάλλον απογοητευτικό. Μην ανησυχείτε όμως. Στο επόμενο κεφάλαιο θα μάθετε πώς μπορείτε να ζωντανέψετε τις σελίδες σας.</para>
<sect1 id="settingup_vcs">
<title>Ενσωμάτωση σε συστήματα ελέγχου εκδόσεων</title>
- <para>Ο εμπειρικός κανόνας είναι ότι αυτά τα αρχεία που επεξεργαστήκατε πρέπει να περάσουν από τον έλεγχο έκδοσης. Για τυπικά έργα, πρόκειται για τα αρχεία: <filename><package>.types</filename>, <filename><package>-docs..xml</filename> (στο παρελθόν .sgml), <filename><package>-sections.txt</filename>, <filename>Makefile.am</filename></para>
+ <para>Ο εμπειρικός κανόνας είναι ότι αυτά τα αρχεία που επεξεργασθήκατε πρέπει να περάσουν από τον έλεγχο έκδοσης. Για τυπικά έργα, πρόκειται για τα αρχεία: <filename><package>.types</filename>, <filename><package>-docs..xml</filename> (στο παρελθόν .sgml), <filename><package>-sections.txt</filename>, <filename>Makefile.am</filename></para>
</sect1>
<sect1 id="plain_makefiles">
<title>Ενσωμάτωση στα αρχεία makefiles ή άλλα συστήματα ανάπτυξης</title>
- <para>Στην περίπτωση που κάποιος δεν θέλει να χρησιμοποιήσει το automake και επομένως το <filename>gtk-doc.mak</filename> θα χρειαστεί να καλέσει τα εργαλεία του gtkdoc στη σωστή σειρά στα makefiles (ή άλλα εργαλεία ανάπτυξης).</para>
+ <para>Στην περίπτωση που κάποιος δε θέλει να χρησιμοποιήσει το automake και, επομένως, το <filename>gtk-doc.mak</filename> θα χρειαστεί να καλέσει τα εργαλεία του gtkdoc στη σωστή σειρά στα makefiles (ή άλλα εργαλεία ανάπτυξης).</para>
<para>
<example><title>Βήματα παραγωγής τεκμηρίωσης</title>
<programlisting>
-
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Για να αποφύγετε αυτά τα προβλήματα, σας προτείνουμε να ενσωματώνετε την τεκμηρίωση στον πηγαίο κώδικα. Αυτή είναι και η μόνη μέθοδος που θα περιγράψουμε σε αυτό το εγχειρίδιο.</para>
</note>
- <para>Ο σαρωτής μπορεί να χειριστεί άνετα την πλειοψηφία των κεφαλίδων C . Σε περίπτωση που παίρνετε προειδοποιήσεις από τον σαρωτή οι οποίες μοιάζουν με έναν ειδικό χαρακτήρα, μπορείτε να υποδείξετε στο GTK-Doc να τους παραλείψει. <example><title>Μπλοκ σχολίου GTK-Doc</title>
+ <para>Ο σαρωτής μπορεί να χειρισθεί άνετα την πλειοψηφία των κεφαλίδων C . Σε περίπτωση που παίρνετε προειδοποιήσεις από τον σαρωτή οι οποίες μοιάζουν με έναν ειδικό χαρακτήρα, μπορείτε να υποδείξετε στο GTK-Doc να τους παραλείψει. <example><title>Μπλοκ σχολίου GTK-Doc</title>
<programlisting>
-
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-
- </programlisting>
+</programlisting>
</example></para>
<!-- -->
<para>Ένα σχόλιο πολλαπλών γραμμών που διαθέτει ένα επιπλέον «*» στην αρχή αποτελεί ένα μπλοκ τεκμηρίωσης που λαμβάνεται υπόψη από τα εργαλεία του GTK-Doc. <example><title>Μπλοκ σχολίου GTK-Doc</title>
<programlisting>
-
/**
* identifier:
* documentation ...
*/
-
- </programlisting>
+</programlisting>
</example></para>
<para>Το 'αναγνωριστικό' είναι μία γραμμή που περιέχει το όνομα του στοιχείου στο οποίο αναφέρεται το σχόλιο. Η σύνταξή του εξαρτάται από τον τύπο του στοιχείου. (ΜΕΛΛΟΝΤΙΚΑ: να προστεθεί πίνακας με τα αναγνωριστικά)</para>
</itemizedlist></para>
</tip>
- <para>Ένα πλεονέκτημα της χρήσης υπερκειμένου αντί για απλό κείμενο είναι η δυνατότητα προσθήκης συνδέσμων στο έγγραφο. Ωστόσο, η χρήση της σωστής σύνταξης για τη δημιουργία συνδέσμων μπορεί να είναι αρκετά κουραστική διαδικασία. Το GTK-Doc σας βοηθάει, παρέχοντάς σας μια σειρά από χρήσιμες συντμήσεις. <itemizedlist>
+ <para>Ένα πλεονέκτημα της χρήσης υπερκειμένου αντί για απλό κείμενο, είναι η δυνατότητα προσθήκης συνδέσμων στο έγγραφο. Ωστόσο, η χρήση της σωστής σύνταξης για τη δημιουργία συνδέσμων μπορεί να είναι αρκετά κουραστική διαδικασία. Το GTK-Doc σας βοηθάει, παρέχοντάς σας μια σειρά από χρήσιμες συντμήσεις. <itemizedlist>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή function() για αναÏ\86οÏ\81ÎÏ\82 σε συναρτήσεις ή μακροεντολές που δέχονται ορίσματα.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο function() για να αναÏ\86εÏ\81θείÏ\84ε σε συναρτήσεις ή μακροεντολές που δέχονται ορίσματα.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή @param για να αναφερθείτε σε παραμέτρους. Επίσης, χρησιμοποιήστε αυτή τη γραφή για να αναφερθείτε σε παραμέτρους άλλων συναρτήσεων, σχετικών με την περιγραφόμενη.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο @param για να αναφερθείτε σε παραμέτρους. Επίσης, χρησιμοποιήστε αυτή τη γραφή για να αναφερθείτε σε παραμέτρους άλλων συναρτήσεων, σχετικών με την περιγραφόμενη.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή %constant για να αναφερθείτε σε σταθερές, π.χ. %G_TRAVERSE_LEAFS.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο %constant για να αναφερθείτε σε σταθερές, π.χ. %G_TRAVERSE_LEAFS.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #symbol για να αναφερθείτε σε άλλους τύπους συμβόλων, π.χ. δομές, αριθμήσεις και μακροεντολές που δε δέχονται ορίσματα.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #symbol για να αναφερθείτε σε άλλους τύπους συμβόλων, π.χ. δομές, αριθμήσεις και μακροεντολές που δε δέχονται ορίσματα.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #Object::signal για να αναφερθείτε σε ένα σήμα GObject.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #Object::signal για να αναφερθείτε σε ένα σήμα GObject.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #Object::property για να αναφερθείτε σε μία ιδιότητα GObject.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #Object::property για να αναφερθείτε σε μία ιδιότητα GObject.</para>
</listitem>
<listitem>
- <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84η γÏ\81αÏ\86ή #Struct.field για να αναφερθείτε σε ένα πεδίο μέσα σε μια δομή και #GObjectClass.foo_bar() για να αναφερθείτε σε μια vmethod.</para>
+ <para>ΧÏ\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε Ï\84ο #Struct.field για να αναφερθείτε σε ένα πεδίο μέσα σε μια δομή και #GObjectClass.foo_bar() για να αναφερθείτε σε μια vmethod.</para>
</listitem>
</itemizedlist></para>
<para>Αν θέλετε να χρησιμοποιήσετε τους ειδικούς χαρακτήρες «<», «>», «()», «@», «%» ή «#» στην τεκμηρίωση, χωρίς να φοβάστε ότι θα τους αλλάξει το GTK-Doc, μπορείτε να χρησιμοποιήσετε τις οντότητες XML «&lt;», «&gt;», «&lpar;», «&rpar;», «&commat;», «&percnt;» και «&num;», αντίστοιχα, ή να χρησιμοποιήσετε την ανάποδη κάθετο «\» ως χαρακτήρα διαφυγής.</para>
</tip>
- <para>
- DocBook can do more than just links. One can also have lists,
- examples, headings, and images. As of version 1.20, the
- preferred way is to use a subset of the basic text formatting
- syntax called
- <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>.
- On older GTK-Doc versions any documentation that includes
- Markdown will be rendered as is. For example, list items will
- appear as lines starting with a dash.
- </para>
+ <para>Το DocBook μπορεί να κάνει παραπάνω από απλούς συνδέσμους. Μπορεί κάποιος να έχει και λίστες, παραδείγματα, κεφαλίδες και εικόνες. Από την έκδοση 1.20 και μετά, ο προτιμώμενος τρόπος είναι με τη χρήση ενός υποσυνόλου της βασικής σύνταξης για μορφοποίηση κειμένου που ονομάζεται <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>. Σε παλιότερες εκδόσεις GTK-Doc οποιαδήποτε τεκμηρίωση που περιλαμβάνει Markdown θα αποδίδεται ως έχει. Για παράδειγμα, οι καταχωρήσεις της λίστας θα εμφανίζονται σαν γραμμές που αρχίζουν με μια παύλα.</para>
- <para>
- In older GTK-Doc releases, if you need support for additional
- formatting, you would need to enable the usage of docbook
- SGML/XML tags inside doc-comments by
- putting <option>--xml-mode</option> or
- <option>--sgml-mode</option> in the variable
- <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</filename>.
- </para>
+ <para>Σε παλιότερες εκδόσεις του GTK-Doc, αν χρειάζεστε υποστήριξη για πρόσθετη μορφοποίηση, θα πρέπει να ενεργοποιήσετε τη χρήση των ετικετών docbook SGML/XML μέσα στα doc-comments θέτοντας το <option>--xml-mode</option> ή το <option>--sgml-mode</option> στη μεταβλητή <symbol>MKDB_OPTIONS</symbol> μέσα στο <filename>Makefile.am</filename>.</para>
<para>
- <example><title>GTK-Doc comment block using Markdown</title>
+ <example><title>Μπλοκ σχολίου GTK-Doc χρησιμοποιώντας Markdown</title>
<programlisting>
-<
+ * Μια άλλη παράγραφος. [Ένας σύνδεσμος στον ιστότοπο του GNOME](http://www.gnome.org/)
*
- * ![an inline image][plot-result.png]
+ * ![μια εικόνα inline][plot-result.png]
*
- * [A link to the heading anchor above][heading-two]
+ * [Ένας σύνδεσμος στον παραπάνω heading anchor][heading-two]
*
- * A C-language example:
- * |[<!-- language="C" -->
- * GtkWidget *label = gtk_label_new ("Gorgeous!");
+ * Ένα παράδειγμα γλώσσας-C:
+ * |[<!-- γλώσσα="C" -->
+ * GtkWidget *label = gtk_label_new ("Υπέροχη!");
* ]|
*/
-]]>
- </programlisting>
+</programlisting>
</example>
</para>
- <para>
- More examples of what markdown tags are supported can be found in the
- <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.
- </para>
+ <para>Μπορείτε να βρείτε περισσότερα παραδείγματα για το ποιες ετικέτες markdown υποστηρίζονται στη διεύθυνση <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.</para>
<tip>
- <para>Όπως αναφέρθηκε και προηγουμένως το GTK-Doc αναλαμβάνει την τεκμηρίωση του δημόσιου API. Άρα, δεν μπορεί να γραφτεί τεκμηρίωση για στατικά σύμβολα. Παρόλα αυτά, συνιστάται ο σχολιασμός και αυτών των συμβόλων, γιατί βοηθά στην κατανόηση του κώδικα. Σας προτείνουμε λοιπόν να τα σχολιάζετε χρησιμοποιώντας κανονικά σχόλια (χωρίς το δεύτερο «*» στην πρώτη γραμμή). Αν αργότερα χρειαστεί να μετατραπεί η συνάρτηση σε δημόσια, το μόνο που θα πρέπει να γίνει είναι να προστεθεί άλλο ένα «*» στο μπλοκ του σχολίου, και να εισαχθεί το όνομα του συμβόλου στην κατάλληλη θέση του αρχείου ενοτήτων.</para>
+ <para>Όπως αναφέρθηκε και προηγουμένως το GTK-Doc στοχεύει στην τεκμηρίωση του δημόσιου API. Άρα, δεν μπορεί κάποιος να γράψει τεκμηρίωση για στατικά σύμβολα. Παρόλα αυτά, συνιστάται ο σχολιασμός και αυτών των συμβόλων, γιατί βοηθά στην κατανόηση του κώδικα. Σας προτείνουμε λοιπόν να τα σχολιάζετε χρησιμοποιώντας κανονικά σχόλια (χωρίς το δεύτερο «*» στην πρώτη γραμμή). Αν αργότερα χρειαστεί να μετατραπεί η συνάρτηση σε δημόσια, το μόνο που θα πρέπει να γίνει είναι να προστεθεί άλλο ένα «*» στο μπλοκ του σχολίου, και να εισαχθεί το όνομα του συμβόλου στην κατάλληλη θέση του αρχείου ενοτήτων.</para>
</tip>
</sect1>
<para>
<example><title>Μπλοκ σχολίου ενότητας</title>
<programlisting>
-
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Ιδιωτική - Διεπαφή που μπορεί να χρησιμοποιηθεί εντός της στοίβας του GNOME, αλλά δε διαθέτει τεκμηρίωση που να απευθύνεται στους τελικούς χρήστες. Τέτοιου είδους συναρτήσεις μπορούν να χρησιμοποιούνται μόνο στο πλαίσιο σαφώς καθορισμένων και τεκμηριωμένων διαδικασιών.</para>
</listitem>
<listitem>
- <para>Εσωτερική - Μια διεπαφή που είναι εσωτερική σε ένα module δεν απαιτεί την ύπαρξη τεκμηρίωσης για τον τελικό χρήστη. Οι συναρτήσεις που δεν περιέχουν τεκμηρίωση θεωρείται ότι είναι εσωτερικές.</para>
+ <para>Εσωτερική - Μια διεπαφή που είναι εσωτερική σε ένα άρθρωμα και δεν απαιτεί την ύπαρξη τεκμηρίωσης για τον τελικό χρήστη. Οι συναρτήσεις που δεν περιέχουν τεκμηρίωση εκλαμβάνονται ως εσωτερικές.</para>
</listitem>
</itemizedlist></para>
</listitem>
<para>Μπορείτε να προσθέσετε πληροφορίες εκδόσεων σε όλα τα στοιχεία της τεκμηρίωσης για να πείτε πότε εισήχθηκε ένα API, ή πότε καταργήθηκε.</para>
- <variablelist><title>Ετικέτες εκδόσεων</title>
- <varlistentry><term>Since:</term>
+ <variablelist><title>Εκδόσεις Ετικετών</title>
+ <varlistentry><term>Από:</term>
<listitem>
- <para>ΠεÏ\81ιγÏ\81αÏ\86ή για Ï\80οια ÎκδοÏ\83η Ï\84οÏ\85 κÏ\8eδικα είναι διαθέσιμο το API.</para>
+ <para>ΠεÏ\81ιγÏ\81αÏ\86ή οÏ\80Ï\8c Ï\80οια ÎκδοÏ\83η Ï\84οÏ\85 κÏ\8eδικα και μεÏ\84ά είναι διαθέσιμο το API.</para>
</listitem>
</varlistentry>
- <varlistentry><term>Deprecated:</term>
+ <varlistentry><term>Παρωχημένη:</term>
<listitem>
- <para>Παράγραφος που ενημερώνει ότι θα πρέπει να σταματήσει η χρήση της συνάρτησης. Η περιγραφή θα πρέπει να παραπέμπει τον αναγνώστη στο νέο API.</para>
+ <para>Παράγραφος που επισημαίνει ότι θα πρέπει να σταματήσει η χρήση της συνάρτησης. Η περιγραφή θα πρέπει να παραπέμπει τον αναγνώστη στο νέο API.</para>
</listitem>
</varlistentry>
</variablelist>
<example><title>Γενικές ετικέτες</title>
<programlisting>
-
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<para>Τεκμηριώσετε κατά πόσο οι παράμετροι μπορούν να είναι μηδενικές (NULL) και τι συμβαίνει αν είναι.</para>
</listitem>
<listitem>
- <para>Αναφέρετε ενδιαφέρουσες προ-υποθέσεις και μετα-υποθέσεις όπου χρειάζεται.</para>
+ <para>Αναφέρετε ενδιαφέρουσες προ-καταστάσεις και μετα-καταστάσεις όπου χρειάζεται.</para>
</listitem>
</itemizedlist></para>
<example><title>Μπλοκ σχολίου συνάρτησης</title>
<programlisting>
-
/**
* function_name:
- * @par1: description of parameter 1. These can extend over more than
- * one line.
- * @par2: description of parameter 2
- * @...: a %NULL-terminated list of bars
+ * @par1: περιγραφή της παραμέτρου 1. Αυτά μπορουν να επεκταθούν επί πολύ περισσότερο από
+ * μια γραμμή.
+ * @par2: περιγραφή της παραμέτρου 2
+ * @...: a %NULL-terminated λίστα γραμμών
*
- * The function description goes here. You can use @par1 to refer to parameters
- * so that they are highlighted in the output. You can also use %constant
- * for constants, function_name2() for functions and #GtkWidget for links to
- * other declarations (which may be documented elsewhere).
+ * Η περιγραφή παραμέτρου πηγαίνει εδώ. Μπορείτε να χρησιμοποιήσετε το @par1 για να αναφερθείτε στις παραμέτρους
+ * έτσι ώστε να τονίζονται έντονα στην έξοδο. Μπορείτε επίσης να χρησιμοποιήσετε το %constant
+ * για τις σταθερές, το function_name2() για τις συναρτήσεις και το #GtkWidget για συνδέσμους σε
+ * άλλες δηλώσεις (που μπορεί να τεκμηριώνονται αλλού).
*
- * Returns: an integer.
+ * Επιστρέφει: έναν ακέραιο.
*
- * Since: 2.2
- * Deprecated: 2.18: Use other_function() instead.
+ * Από την: 2.2
+ * Παρωχημένη: 2.18: Χρησιμοποιήστε αντιθέτως μια άλλη_συνάρτηση().
*/
- </programlisting>
+</programlisting>
</example>
<variablelist><title>Ετικέτες συναρτήσεων</title>
</varlistentry>
<varlistentry><term>@...:</term>
<listitem>
- <para>Σε περίπτωση που η μεταβλητή μπορεί να δεκτεί μεταβλητό αριθμό ορισμάτων (variadic), πρέπει να χρησιμοποιήσετε αυτή την ετικέτα (η ετικέτα @Varargs: λειτουργεί επίσης, για ιστορικούς λόγους).</para>
+ <para>Σε περίπτωση που η μεταβλητή μπορεί να δεχθεί μεταβλητό αριθμό ορισμάτων (variadic), πρέπει να χρησιμοποιήσετε αυτή την ετικέτα (η ετικέτα @Varargs: λειτουργεί επίσης, για ιστορικούς λόγους).</para>
</listitem>
</varlistentry>
</variablelist>
<example><title>Μπλοκ σχολίου ιδιότητας</title>
<programlisting>
-
/**
* SomeWidget:some-property:
*
- * Here you can document a property.
+ * Εδώ μπορείτε να τεκμηριώσετε μια ιδιότητα.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<para>Παρακαλούμε να θυμηθείτε να: <itemizedlist>
<listitem>
- <para>ΤεκμηÏ\81ιÏ\8eÏ\83Ï\84ε Ï\80Ï\8cÏ\84ε εκÏ\80ÎμÏ\80εÏ\84αι Ï\84ο Ï\83ήμα και αν εκπέμπεται πριν ή μετά από άλλα σήματα.</para>
+ <para>ΤεκμηÏ\81ιÏ\8eÏ\83Ï\84ε Ï\80Ï\8cÏ\84ε εκÏ\80ÎμÏ\80εÏ\84αι Ï\84ο Ï\83ήμα και καÏ\84ά Ï\80Ï\8cÏ\83ο εκπέμπεται πριν ή μετά από άλλα σήματα.</para>
</listitem>
<listitem>
<para>Τεκμηριώστε τι μπορεί να κάνει μια εφαρμογή στον διαχειριστή σημάτων.</para>
<example><title>Μπλοκ σχολίου σήματος</title>
<programlisting>
-
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
* @foo: some foo
* @bar: some bar
*
- * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
+ * Το ::foobar-οποιημένο σήμα εκπέμπεται κάθε φορά που κάποιος προσπαθεί να foobar-οποιήσει το @widget.
*/
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<sect2><title>Μπλοκ σχολίου δομής</title>
<example><title>Μπλοκ σχολίου δομής</title>
<programlisting>
-
/**
* FooWidget:
* @bar: some #gboolean
*
- * This is the best widget, ever.
+ * Αυτό είναι το καλύτερο widget που υπήρξε ποτέ.
*/
typedef struct _FooWidget {
/*< private >*/
/*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+</programlisting>
</example>
<para>Χρησιμοποιήστε το <code>/*< private >*/</code> πριν από πεδία ιδιωτικών δομών που θέλετε να αποκρύψετε. Χρησιμοποιήστε το <code>/*< public >*/</code>για την αντίστροφη συμπεριφορά.</para>
<sect2><title>Μπλοκ σχολίου Enum</title>
<example><title>Μπλοκ σχολίου Enum</title>
<programlisting>
-
/**
* Something:
* @SOMETHING_FOO: something foo
* @SOMETHING_BAR: something bar
*
- * Τιμές απαρίθμησης χρησιμοποιούνται για το πράγμα, για τον ορισμό του πράγματος.
+ * ΤιμÎÏ\82 αÏ\80αÏ\81ίθμηÏ\83ηÏ\82 Ï\80οÏ\85 Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dνÏ\84αι για Ï\84ο Ï\80Ï\81άγμα, για Ï\84ον οÏ\81ιÏ\83μÏ\8c Ï\84οÏ\85 Ï\80Ï\81άγμαÏ\84οÏ\82.
*/
typedef enum {
SOMETHING_FOO,
/*< private >*/
SOMETHING_COUNT
} Something·
-
- </programlisting>
+</programlisting>
</example>
<para>Χρησιμοποιήστε το <code>/*< private >*/</code> πριν από ιδιωτικές τιμές enum που θέλετε να αποκρύψετε. Χρησιμοποιήστε το <code>/*< public >*/</code> για την αντίστροφη συμπεριφορά.</para>
<para>Ακολουθούν ορισμένες ετικέτες DocBook, ιδιαίτερα χρήσιμες για την τεκμηρίωση του κώδικα.</para>
- <para>Î\93ια να Ï\83Ï\85νδÎÏ\83ετε με μια άλλη ενότητα στην τεκμηρίωση GTK: <informalexample>
+ <para>Î\93ια να Ï\83Ï\85νδεθείτε με μια άλλη ενότητα στην τεκμηρίωση GTK: <informalexample>
<programlisting>
-
<link linkend="glib-Hash-Tables">Hash Tables</link>
-
- </programlisting>
+</programlisting>
</informalexample> Ο προορισμός είναι το id του SGML/XML στο πρώτο στοιχείο της σελίδας στην οποία παραπέμπει ο σύνδεσμος. Για τις περισσότερες σελίδες είναι το ("gtk", "gdk", glib"), ακολουθούμενο από τον τίτλο της σελίδας («Πίνακες Hash»). Για τα γραφικά συστατικά είναι το όνομα της κλάσης. Τα διαστήματα και τα «_» μετατρέπονται σε «-» για να υπάρχει συμμόρφωση με το SGML/XML.</para>
<para>Αναφορά σε εξωτερική συνάρτηση, π.χ. τυποποιημένη συνάρτηση C: <informalexample>
<programlisting>
-
<function>...</function>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Συμπερίληψη παραδειγμάτων κώδικα: <informalexample>
<programlisting>
-
<example>
- <title>Using a GHashTable.</title>
+ <title>Χρησιμοποιώντας έναν πίνακα GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-
- </programlisting>
+</programlisting>
</informalexample> ή, ενδεχομένως, για πολύ σύντομο κώδικα που δεν χρειάζεται τίτλο: <informalexample>
<programlisting>
-
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-
- </programlisting>
+</programlisting>
</informalexample>. Στην τελευταία περίπτωση το GTK-Doc υποστηρίζει επίσης τη σύντμηση: |[ ... ]|</para>
<para>Συμπερίληψη λιστών με κουκίδες: <informalexample>
<programlisting>
-
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Συμπερίληψη σημειώσεων που ξεχωρίζουν από το υπόλοιπο κείμενο: <informalexample>
<programlisting>
-
<note>
<para>
- Make sure you free the data after use.
+ Βεβαιωθείτε πως απελυεθερώνετε τα δεδομένα μετά τη χρήση.
</para>
</note>
-
- </programlisting>
+</programlisting>
</informalexample></para>
- <para>Î\91ναÏ\86οÏ\81ά Ï\83ε τύπο: <informalexample>
+ <para>Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îναν τύπο: <informalexample>
<programlisting>
-
-<type>unsigned char</type>
-
- </programlisting>
+<type>μη υπογεγραμμένος χαρακτήρας char</type>
+</programlisting>
</informalexample></para>
- <para>Î\91ναÏ\86οÏ\81ά Ï\83ε εξωτερική δομή (που δεν περιγράφεται στην τεκμηρίωση GTK): <informalexample>
+ <para>Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε μια εξωτερική δομή (που δεν περιγράφεται στην τεκμηρίωση GTK): <informalexample>
<programlisting>
-
<structname>XFontStruct</structname>
-
- </programlisting>
+</programlisting>
</informalexample></para>
- <para>Î\91ναÏ\86οÏ\81ά Ï\83ε πεδίο μιας δομής: <informalexample>
+ <para>Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα πεδίο μιας δομής: <informalexample>
<programlisting>
-
<structfield>len</structfield>
-
- </programlisting>
+</programlisting>
</informalexample></para>
- <para>Î\91ναÏ\86οÏ\81ά Ï\83ε Ï\8cνομα κλάÏ\83ηÏ\82. Î\9cία δÏ\85ναÏ\84Ï\8cÏ\84ηÏ\84α είναι το : <informalexample>
+ <para>Î\93ια να αναÏ\86εÏ\81θείÏ\84ε Ï\83ε Îνα Ï\8cνομα κλάÏ\83ηÏ\82, θα μÏ\80οÏ\81οÏ\8dÏ\83αÏ\84ε να Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83εÏ\84ε το : <informalexample>
<programlisting>
-
<classname>GtkWidget</classname>
-
- </programlisting>
+</programlisting>
</informalexample>, αλλά μάλλον θα χρησιμοποιήσετε το #GtkWidget (για αυτόματη δημιουργία συνδέσμου προς τη σελίδα GtkWidget, δείτε <link linkend="documenting_syntax">τις συντμήσεις</link>).</para>
<para>Χρήση έντονων χαρακτήρων: <informalexample>
<programlisting>
-
-<emphasis>This is important</emphasis>
-
- </programlisting>
+<emphasis>Αυτό είναι σημαντικό;/emphasis>
+</programlisting>
</informalexample></para>
- <para>Î\9fνÏ\8cμαÏ\84α αÏ\81Ï\87είÏ\89ν: <informalexample>
+ <para>Î\93ια ονÏ\8cμαÏ\84α αÏ\81Ï\87είÏ\89ν Ï\87Ï\81ηÏ\83ιμοÏ\80οιήÏ\83Ï\84ε: <informalexample>
<programlisting>
-
<filename>/home/user/documents</filename>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Για να αναφερθείτε σε κλειδιά χρησιμοποιήστε: <informalexample>
<programlisting>
-
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+</programlisting>
</informalexample></para>
</sect1>
</chapter>
<chapter id="metafiles">
- <title>Συμπλήρωση επιπλέον αρχείων</title>
+ <title>Συμπλήρωση των επιπλέον αρχείων</title>
<para>Υπάρχουν ορισμένα επιπλέον αρχεία που πρέπει να ενημερώνονται παράλληλα με τα σχόλια εντός του πηγαίου κώδικα: <filename><package>.types</filename>, <filename><package>-docs.xml</filename> (στο παρελθόν .sgml), <filename><package>-sections.txt</filename>.</para>
<para>
<example><title>Υπόδειγμα αποσπάσματος αρχείου types</title>
<programlisting>
-
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>
<example><title>Κεφαλίδα κύριου εγγράφου</title>
<programlisting>
-
<bookinfo>
- <title>MODULENAME Reference Manual</title>
+ <title>MODULENAME Εγχειρίδιο αναφοράς;/title>
<releaseinfo>
- for MODULENAME [VERSION]
- The latest version of this documentation can be found on-line at
+ για το MODULENAME [ΕΚΔΟΣΗ]
+ Η πιο πρόσφατη έκδοση αυτή της τεκμηρίωσης μπορούν να εντοπισθούν on-line στη διεύθυνση
<ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
</releaseinfo>
</bookinfo>
<chapter>
<title>[Insert title here]</title>
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Μπορείτε επίσης να δείτε τα αρχεία που παράγονται από το σαρωτή του πηγαίου κώδικα: <filename><package>-decl-list.txt</filename> και <filename><package>-decl.txt</filename>. Το πρώτο μπορεί να συγκριθεί με το αρχείο της ενότητας, αν αυτό συντηρείται χειροκίνητα. Το δεύτερο περιέχει όλες τις δηλώσεις από τις κεφαλίδες. Αν ένα σύμβολο λείπει μπορείτε να ελέγξετε αν περιέχεται σε αυτό το αρχείο.</para>
- <para>
- If the project is GObject based, one can also look into the files produced
- by the object scanner:
- <filename><package>.args.txt</filename>,
- <filename><package>.hierarchy.txt</filename>,
- <filename><package>.interfaces.txt</filename>,
- <filename><package>.prerequisites.txt</filename> and
- <filename><package>.signals.txt</filename>. If there are missing
- symbols in any of those, one can ask GTK-Doc to keep the intermediate
- scanner file for further analysis, by running it as
- <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.
- </para>
+ <para>Αν το έργο βασίζεται στο GObject, μπορείτε επίσης να δείτε τα αρχεία που παράγονται από το σαρωτή αντικειμένων: <filename><package>.args.txt</filename>, <filename><package>.hierarchy.txt</filename>, <filename><package>.interfaces.txt</filename>, <filename><package>.prerequisites.txt</filename> και <filename><package>.signals.txt</filename>. Αν υπάρχουν σύμβολα που λείπουν από οποιοδήποτε από αυτά, μπορείτε να ζητήσετε από το gtkdoc να κρατήσει το ενδιάμεσο αρχείο σάρωσης για περαιτέρω ανάλυση, εκτελώντας το ως μια εντολή <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.</para>
</chapter>
<chapter id="modernizing">
- <title>Modernizing the documentation</title>
+ <title>Εκσυγχρονίζοντας την τεκμηρίωση</title>
- <para>
- GTK-Doc has been around for quite some time. In this section we list new
- features together with the version since when it is available.
- </para>
+ <para>Το GTK-Doc κυκλοφορεί εδώ και αρκετό καιρό. Σε αυτό το κεφάλαιο θα παραθέσουμε τα νέα χαρακτηρηστικά μαζί με την έκδοση στην οποία είναι διαθέσιμα.</para>
<sect1 id="modernizing-gtk-doc-1-9">
<title>GTK-Doc 1.9</title>
- <para>
- When using xml instead of sgml, one can actually name the master
- document <filename><package>-docs.xml</filename>.
- </para>
+ <para>Όταν χρησιμοποιείτε το xml αντί για το sgml, μπορείτε πράγματι να ονομάσετε το κύριο έγγραφο <filename><package>-docs.xml</filename>.</para>
- <para>
- This version supports <option>SCAN_OPTIONS=--rebuild-sections</option>
- in <filename>Makefile.am</filename>. When this is enabled, the
- <filename><package>-sections.txt</filename> is autogenerated and
- can be removed from the vcs. This only works nicely for projects that
- have a very regular structure (e.g. each .{c,h} pair will create new
- section). If one organize a project close to that updating a manually
- maintained section file can be as simple as running
- <code>meld <package>-decl-list.txt <package>-sections.txt</code>.
- </para>
+ <para>Αυτή η έκδοση υποστηρίζει <option>SCAN_OPTIONS=--rebuild-sections</option> στο <filename>Makefile.am</filename>. Αν αυτό ενεργοποιηθεί, το <filename><package>-sections.txt</filename> αυτοδημιουργείται και μπορεί να αφαιρεθεί από το vcs. Αυτό λειτουργεί ωραία μόνο για έργα που έχουν μια πολύ κανονική δομή (π.χ. το κάθε ζεύγος .{c,h} θα δημιουργεί μια νέα ενότητα). Αν κάποιος οργανώσει ένα έργο κοντά σε αυτό, τότε η ενημέρωση μιας ενότητας αρείων που συντηρούνται χειρονακτικά μπορεί να είναι τόσο απλή όσο και το να εκτελούμε <code>meld <package>-decl-list.txt <package>-sections.txt</code>.</para>
- <para>
- Version 1.8 already introduced the syntax for documenting sections in
- the sources instead of the separate files under <filename class="directory">tmpl</filename>.
- This version adds options to switch the whole doc module to not use the
- extra tmpl build step at all, by using <option>--flavour no-tmpl</option>
- in <filename>configure.ac</filename>.
- </para>
+ <para>Η εκδοση 1.8 εισήγαγε ήδη τη σύνταξη για τις ενότητες τεκμηρίωσης στις πηγές, αντί για τα ξεχωριστά αρχεία, κάτω από το <filename class="directory">tmpl</filename>. Αυτή η έκδοση προσθέτει επιλογές για τη μετατροπή ολόκληρου του αρθρώματος doc ώστε να μη χρησιμοποιεί καθόλου το επιπλέον στάδιο tmpl build, με τη χρήση της επιλογής <option>--flavour no-tmpl</option> στο <filename>configure.ac</filename>.</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-10">
<title>GTK-Doc 1.10</title>
- <para>
- This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in
- <filename>Makefile.am</filename>. When this is enabled, the
- <filename><package>.types</filename> is autogenerated and can be
- removed from the vcs. When using this feature it is important to also
- setup the <varname>IGNORE_HFILES</varname> in
- <filename>Makefile.am</filename> for code that is build conditionally.
- </para>
+ <para>Αυτή η έκδοση υποστηρίζει τα <option>SCAN_OPTIONS=--rebuild-types</option> στο <filename>Makefile.am</filename>. Αν αυτό ενεργοποιηθεί, το <filename><package>.types</filename> αυτοδημιουργείται και μπορεί να αφαιρεθεί από το vcs. Όταν χρησιμοποιείτε αυτό το χαρακτηριστικό είναι σημαντικό να ρυθμίσετε και το <varname>IGNORE_HFILES</varname> στο <filename>Makefile.am</filename> για τον κώδικα που δημιουργείται υπό όρους.</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-16">
<title>GTK-Doc 1.16</title>
- <para>
- This version includes a new tool called gtkdoc-check. This tool can run
- a set of sanity checks on your documentation. It is enabled by adding
- these lines to the end of <filename>Makefile.am</filename>.
- <example><title>Enable gtkdoc-check</title>
+ <para>Αυτή η έκδοση περιλαμβάνει ένα νέο εργαλείο που λέγεται gtkdoc-check. Αυτό το εργαλείο μπορέι να εκτελεί ένα σύνολο ελέγχων υγείας στην τεκμηρίωσή σας. Ενεργοποιείται προσθέτοντας αυτές τις γραμμές στο τέλος του <filename>Makefile.am</filename>. <example><title>Ενεργοποίηση του gtkdoc-check</title>
<programlisting>
-<![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
- </example>
- </para>
+</programlisting>
+ </example></para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-20">
<title>GTK-Doc 1.20</title>
- <para>
- Version 1.18 brought some initial markdown support. Using markdown in
- doc comments is less intrusive than writing docbook xml. This version
- improves a lot on this and add a lot more styles. The section that
- explains the <link linkend="documenting_syntax">comment syntax</link>
- has all the details.
- </para>
+ <para>Η έκδοση 1.18 έφερε μια αρχική υποστήριξη για το markdown. Η χρήση markdown στα σχόλια του doc είναι λιγότερο ενοχλητική από το να γράφει κανείς docbook xml. Αυτή η έκδοση επιφέρει μεγάλες βελτιώσεις σε αυτό, και σε πολλές άλλες τεχνοτροπίες (styles). Η ενότητα που εξηγεί τη <link linkend="documenting_syntax">σύνταξη σχολίων</link> έχει όλες τις λεπτομέρειες.</para>
</sect1>
</chapter>
<chapter id="documenting-others">
<title>Τεκμηρίωση άλλων διεπαφών</title>
- <para>ΤÏ\8cÏ\83ο καιÏ\81Ï\8c Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dÏ\83αμε Ï\84ο GTK-Doc για να καÏ\84αγÏ\81άÏ\88οÏ\85με Ï\84ο API Ï\84οÏ\85 κÏ\8eδικα. Î\9fι εÏ\80Ï\8cμενεÏ\82 Ï\83Ï\85νεδÏ\81ίεÏ\82 Ï\80εÏ\81ιÎÏ\87οÏ\85ν Ï\80Ï\81οÏ\84άÏ\83ειÏ\82 για Ï\84ο Ï\80Ï\8eÏ\82 Ï\84α εÏ\81γαλεία μÏ\80οÏ\81οÏ\8dν να Ï\87Ï\81ηÏ\83ιμοÏ\80οιηθοÏ\8dν Ï\8eÏ\83Ï\84ε να καÏ\84αγÏ\81άÏ\88ετε και άλλες επιφάνειες.</para>
+ <para>Î\9cÎÏ\87Ï\81 Ï\84Ï\8eÏ\81α, Ï\87Ï\81ηÏ\83ιμοÏ\80οιοÏ\8dÏ\83αμε Ï\84ο GTK-Doc για να καÏ\84αγÏ\81άÏ\86οÏ\85με Ï\84ο API Ï\84οÏ\85 κÏ\8eδικα. Î\9fι εÏ\80Ï\8cμενεÏ\82 Ï\83Ï\85νεδÏ\81ίεÏ\82 Ï\80εÏ\81ιÎÏ\87οÏ\85ν Ï\80Ï\81οÏ\84άÏ\83ειÏ\82 για Ï\84ο Ï\80Ï\8eÏ\82 Ï\84α εÏ\81γαλεία μÏ\80οÏ\81οÏ\8dν να Ï\87Ï\81ηÏ\83ιμοÏ\80οιηθοÏ\8dν για να καÏ\84αγÏ\81άÏ\86ετε και άλλες επιφάνειες.</para>
<sect1 id="commandline-interfaces">
<title>Επιλογές γραμμής εντολών και σελίδες τεκμηρίωσης man</title>
<para>
<example><title>Έξτρα έλεγχοι διαμόρφωσης</title>
<programlisting>
-
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
- [regenerate man pages from Docbook [default=no]])],enable_man=yes,
+ [αναδημιουργία σελίδων βοήθειας man από το Docbook [default=no]])],enable_man=yes,
enable_man=no)
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
<sect2 id="commandline-interfaces-make">
- <title>Î Ï\81οÏ\83θήκη Ï\84Ï\89ν ÎξÏ\84Ï\81α κανόνων makefile</title>
+ <title>Î Ï\81οÏ\83θήκη Ï\84Ï\89ν εÏ\80ιÏ\80λÎον κανόνων makefile</title>
<para>
<example><title>Έξτρα έλεγχοι διαμόρφωσης</title>
<programlisting>
-
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
</sect1>
<sect1 id="dbus-interfaces">
- <title>DBus interfaces</title>
+ <title>Διεπαφές DBus</title>
<para>(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)</para>
</sect1>
</seglistitem>
<seglistitem>
<seg>Εξακολουθεί να μην υπάρχει ιεραρχία κλάσεων.</seg>
- <seg>Î
\95λλιÏ
\80ήÏ
\82 ή λαÎ
¸Îµμένη ονομασία στο αρχείο <filename><package>-sections.txt</filename> (δείτε την <ulink url="http://mail.gnome.org/archives/gtk-doc-list/2003-October/msg00006.html">αιτιολόγηση</ulink>).</seg>
+ <seg>Î
\95λλιÏ
\80ήÏ
\82 ή λαÎ
½Î¸Î±Ï\83μένη ονομασία στο αρχείο <filename><package>-sections.txt</filename> (δείτε την <ulink url="http://mail.gnome.org/archives/gtk-doc-list/2003-October/msg00006.html">αιτιολόγηση</ulink>).</seg>
</seglistitem>
<seglistitem>
- <seg>Î άλι δεν έχω ιεραρχία κλάσεων.</seg>
+ <seg>ΣÏ\84ο καλÏ\8c Ï\84οÏ\85, Ï\80άλι δεν έχω ιεραρχία κλάσεων.</seg>
<seg>Ελέγξτε αν το όνομα του αντικειμένου (δηλαδή το όνομα του συγκεκριμένου παραδείγματος της δομής, π.χ. <type>GtkWidget</type>) περιλαμβάνεται στην κανονική ενότητα (δεν πρέπει να βρίσκεται εντός υποενότητας Standard ή Private).</seg>
</seglistitem>
<seglistitem>
</seglistitem>
<seglistitem>
<seg>Μια νέα κλάση δεν εμφανίζεται στην τεκμηρίωση.</seg>
- <seg>ΣÏ\85μÏ\80εÏ\81ιλαμβάνεÏ\84αι μÎÏ\83Ï\89 xi:included η νÎα Ï\83ελίδα από το <filename><package>-docs.{xml,sgml}</filename>;</seg>
+ <seg>ΣÏ\85μÏ\80εÏ\81ιλαμβάνεÏ\84αι η νÎα Ï\83ελίδα xi:included από το <filename><package>-docs.{xml,sgml}</filename>;</seg>
</seglistitem>
<seglistitem>
<seg>Ένα νέο σύμβολο δεν εμφανίζεται στην τεκμηρίωση.</seg>
- <seg>Î\95ίναι Ï\84ο doc-comment κανονικά μορφοποιημένο; Ελέγξτε για συντακτικά λάθη στην αρχή του σχολίου. Ελέγξτε αν το gtkdoc-fixxref προειδοποιεί για ανεπίλυτα xref. Ελέγξτε αν το σύμβολο είναι σωστά καταχωρημένο στο <filename><package>-sections.txt</filename> σε μια δημόσια υποενότητα.</seg>
+ <seg>Το doc-comment είναι κανονικά μορφοποιημένο; Ελέγξτε για συντακτικά λάθη στην αρχή του σχολίου. Ελέγξτε αν το gtkdoc-fixxref προειδοποιεί για ανεπίλυτα xref. Ελέγξτε αν το σύμβολο είναι σωστά καταχωρημένο στο <filename><package>-sections.txt</filename> σε μια δημόσια υποενότητα.</seg>
</seglistitem>
<seglistitem>
<seg>Λείπει ένας τύπος από την ιεραρχία κλάσεων.</seg>
<title>0. ΠΡΟΟΙΜΙΟ</title>
<para>Σκοπός της παρούσας Άδειας είναι η δημιουργία εγχειριδίων, συγγραμμάτων ή άλλων εγγράφων που είναι <quote>ελεύθερα</quote> υπό την έννοια ότι παρέχουν σε όλους πραγματική ελευθερία αντιγραφής και αναδιανομής τους, με ή χωρίς τροποποιήσεις, για εμπορικούς ή μη εμπορικούς σκοπούς. Δευτερευόντως, η παρούσα Άδεια παρέχει έναν τρόπο για να αναγνωρίζεται το έργο του συγγραφέα και του εκδότη ενός έργου, χωρίς να μπορούν να θεωρηθούν υπεύθυνοι για τροποποιήσεις που έγιναν από τρίτους.</para>
- <para>Η παρούσα Άδεια είναι άδεια τύπου <quote>copyleft</quote>, το οποίο σημαίνει ότι τα παράγωγα έργα του εγγράφου θα πρέπει να είναι και αυτά ελεύθερα υπό την ίδια έννοια. Πρόκειται για άδεια συμπληρωματική της Γενικής Άδειας Δημόσιας Χρήσης GNU, που είναι άδεια copyleft σχεδιασμένη για ελεύθερο λογισμικό.</para>
+ <para>Î\97 Ï\80αÏ\81οÏ\8dÏ\83α Î\86δεια είναι μια άδεια Ï\84Ï\8dÏ\80οÏ\85 <quote>copyleft</quote>, Ï\84ο οÏ\80οίο Ï\83ημαίνει Ï\8cÏ\84ι Ï\84α Ï\80αÏ\81άγÏ\89γα ÎÏ\81γα Ï\84οÏ\85 εγγÏ\81άÏ\86οÏ\85 θα Ï\80Ï\81ÎÏ\80ει να είναι και αÏ\85Ï\84ά ελεÏ\8dθεÏ\81α Ï\85Ï\80Ï\8c Ï\84ην ίδια Îννοια. Î Ï\81Ï\8cκειÏ\84αι για άδεια Ï\83Ï\85μÏ\80ληÏ\81Ï\89μαÏ\84ική Ï\84ηÏ\82 Î\93ενικήÏ\82 Î\86δειαÏ\82 Î\94ημÏ\8cÏ\83ιαÏ\82 ΧÏ\81ήÏ\83ηÏ\82 GNU, Ï\80οÏ\85 είναι άδεια copyleft Ï\83Ï\87εδιαÏ\83μÎνη για ελεÏ\8dθεÏ\81ο λογιÏ\83μικÏ\8c.</para>
<para>Σχεδιάσαμε αυτήν την Άδεια για χρήση με εγχειρίδια ελεύθερου λογισμικού, γιατί το ελεύθερο λογισμικό χρειάζεται και ελεύθερη τεκμηρίωση: τα ελεύθερα προγράμματα πρέπει να συνοδεύονται από εγχειρίδια που παρέχουν τις ίδιες ελευθερίες που παρέχει και το λογισμικό. Ωστόσο, αυτή η Άδεια δεν περιορίζεται στα εγχειρίδια λογισμικού· μπορεί να χρησιμοποιηθεί για οποιοδήποτε έργο κειμένου, ανεξάρτητα από το θέμα του ή από το αν εκδίδεται σε έντυπη μορφή. Συνιστούμε αυτή την Άδεια, κυρίως, για διδακτικό υλικό ή έργα αναφοράς.</para>
</sect1>
<listitem>
<formalpara>
<title>ΙΔ</title>
- <para>Μη μετατρέπετε τον τίτλο καμίας προϋπάρχουσας ενότητας στον τίτλο <quote>Έγκριση</quote> ή σε τίτλο που συγκρούεται με τον τίτλο <link linkend="fdl-invariant">Αμετάβλητης Ενότητας</link>.</para>
+ <para>Μην αλλάζετε τον τίτλο καμίας προϋπάρχουσας ενότητα σε <quote>Έγκριση</quote> ή σε τίτλο που να συγκρούεται με τον τίτλο οποιασδήποτε <link linkend="fdl-invariant">Αμετάβλητης Ενότητας</link>.</para>
</formalpara>
</listitem>
</itemizedlist>
<book id="index" lang="en-GB">
<bookinfo>
<title>GTK-Doc Manual</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>User manual for developers with instructions on GTK-Doc usage.</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>Requirements</title>
<para><guilabel>Perl v5</guilabel> — the main scripts are in Perl.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> — This is the DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> — This is a DSSSL processor for converting SGML to various formats. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code to convert DocBook to HTML (and a few other formats). It's used together with jade. The DSSSL code has been customised slightly, in gtk-doc.dsl, to colour the program code listings/declarations, and to support global cross-reference indices in the generated HTML. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> — if you want to create man pages from the DocBook. The 'translation spec' has been customised slightly, to capitalise section headings and add the 'GTK Library' title at the top of the pages and the revision date at the bottom. There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> NOTE: This does not work yet.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>There is no standard place where the DocBook Modular Stylesheets are installed.</para>
<para>
- GTK-Doc's configure script searches these 3 directories automatically:
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
+ </para>
+ <para>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
- <para><filename>/usr/lib/sgml/stylesheets/nwalsh-modular</filename> (used by Red Hat)</para>
- <para><filename>/usr/lib/dsssl/stylesheets/docbook</filename> (used by Debian)</para>
- <para><filename>/usr/share/sgml/docbkdsl</filename> (used by SuSE)</para>
<para>
- If you have the stylesheets installed somewhere else, you need to configure
- GTK-Doc using the option:
- <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>About GTK-Doc</title>
<para>(FIXME)</para>
- <para>(History, authors, web pages, licence, future plans, comparison with other similar systems.)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Integration with autoconf</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Preparation for gtkdocize</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Running gtkdocize from autogen.sh</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>Running the doc build</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Now you can point your browser to <filename>docs/reference/<replaceable>package</replaceable>/index.html</filename>. Yes, it's a bit disappointing still. But hang on; during the next chapter we tell you how to fill the pages with life.</para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Section comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<example><title>General tags</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Function comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Function tags</title>
<sect2><title>Property comment block</title>
<example><title>Property comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Signal comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct comment block</title>
<example><title>Struct comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum comment block</title>
<example><title>Enum comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Master document header</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
msgid ""
msgstr ""
"Project-Id-Version: gtk-doc-help.master\n"
-"POT-Creation-Date: 2014-02-10 13:30+0000\n"
-"PO-Revision-Date: 2014-02-11 10:35+0100\n"
+"POT-Creation-Date: 2014-02-20 22:28+0000\n"
+"PO-Revision-Date: 2014-02-24 17:24+0100\n"
"Last-Translator: Daniel Mustieles <daniel.mustieles@gmail.com>\n"
"Language-Team: Español <gnome-es-list@gnome.org>\n"
"Language: \n"
#. (itstool) path: bookinfo/edition
#: C/index.docbook:13
-msgid "1.18.1"
-msgstr "1.18.1"
+msgid "1.20"
+msgstr "1.20"
#. (itstool) path: abstract/para
#: C/index.docbook:14
#. (itstool) path: authorgroup/author
#: C/index.docbook:34
+#| msgid ""
+#| "<firstname>Stefan</firstname> <surname>Kost</surname> <affiliation> "
+#| "<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
msgid ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
msgstr ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
#. (itstool) path: publisher/publishername
#. (itstool) path: bookinfo/copyright
#: C/index.docbook:52
-msgid "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
-msgstr "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
+msgid "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
+msgstr "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
#. (itstool) path: legalnotice/para
#: C/index.docbook:65
#. (itstool) path: revhistory/revision
#: C/index.docbook:83
msgid ""
-"<revnumber>1.
19.1</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
+"<revnumber>1.
20.1</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
"authorinitials> <revremark>development version</revremark>"
msgstr ""
-"<revnumber>1.19.1</revnumber> <date>05 de junio de 2013</date> "
+"<revnumber>1.20.1</revnumber> <date>16 de febrero de 2014</date> "
"<authorinitials>ss</authorinitials> <revremark>versión de desarrollo</"
"revremark>"
#. (itstool) path: revhistory/revision
#: C/index.docbook:89
msgid ""
+"<revnumber>1.20</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
+"authorinitials> <revremark>bug fixes, markdown support, style improvements</"
+"revremark>"
+msgstr ""
+"<revnumber>1.20</revnumber> <date>16 de febrero de 2014</date> "
+"<authorinitials>ss</authorinitials> <revremark>errores corregidos, soporte "
+"de marcado, mejoras en los estilos</revremark>"
+
+#. (itstool) path: revhistory/revision
+#: C/index.docbook:95
+msgid ""
"<revnumber>1.19</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes</revremark>"
msgstr ""
"revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:95
+#: C/index.docbook:101
msgid ""
"<revnumber>1.18</revnumber> <date>14 Sep 2011</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes, speedups, markdown support</revremark>"
"mejoras en la velocidad y soporte de marcado</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:101
+#: C/index.docbook:107
msgid ""
"<revnumber>1.17</revnumber> <date>26 Feb 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>urgent bug fix update</revremark>"
"corrección de error</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:107
+#: C/index.docbook:113
msgid ""
"<revnumber>1.16</revnumber> <date>14 Jan 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes, layout improvements</revremark>"
"mejoras en la distribución</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:113
+#: C/index.docbook:119
msgid ""
"<revnumber>1.15</revnumber> <date>21 May 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bug and regression fixes</revremark>"
"regresiones</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:119
+#: C/index.docbook:125
msgid ""
"<revnumber>1.14</revnumber> <date>28 March 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes and performance improvements</revremark>"
"mejoras en el rendimiento</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:125
+#: C/index.docbook:131
msgid ""
"<revnumber>1.13</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>broken tarball update</"
"roto</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:131
+#: C/index.docbook:137
msgid ""
"<revnumber>1.12</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>new tool features and "
"nuevas características</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:137
+#: C/index.docbook:143
msgid ""
"<revnumber>1.11</revnumber> <date>16 November 2008</date> "
"<authorinitials>mal</authorinitials> <revremark>GNOME doc-utils migration</"
"revremark>"
#. (itstool) path: chapter/title
-#: C/index.docbook:150
+#: C/index.docbook:156
msgid "Introduction"
msgstr "Introducción"
#. (itstool) path: chapter/para
-#: C/index.docbook:152
+#: C/index.docbook:158
msgid ""
"This chapter introduces GTK-Doc and gives an overview of what it is and how "
"it is used."
"es y cómo usarlo."
#. (itstool) path: sect1/title
-#: C/index.docbook:158
+#: C/index.docbook:164
msgid "What is GTK-Doc?"
msgstr "¿Qué es GTK-Doc?"
#. (itstool) path: sect1/para
-#: C/index.docbook:160
+#: C/index.docbook:166
msgid ""
"GTK-Doc is used to document C code. It is typically used to document the "
"public API of libraries, such as the GTK+ and GNOME libraries. But it can "
"Pero también se puede usar para documentar código de aplicaciones."
#. (itstool) path: sect1/title
-#: C/index.docbook:168
+#: C/index.docbook:174
msgid "How Does GTK-Doc Work?"
msgstr "¿Cómo funciona GTK-Doc?"
#. (itstool) path: sect1/para
-#: C/index.docbook:170
+#: C/index.docbook:176
msgid ""
"GTK-Doc works by using documentation of functions placed inside the source "
"files in specially-formatted comment blocks, or documentation added to the "
"archivos de cabecera; no produce salida para funciones estáticas)."
#. (itstool) path: sect1/para
-#: C/index.docbook:177
+#: C/index.docbook:183
msgid ""
"GTK-Doc consists of a number of perl scripts, each performing a different "
"step in the process."
"diferente en el proceso."
#. (itstool) path: sect1/para
-#: C/index.docbook:182
+#: C/index.docbook:188
msgid "There are 5 main steps in the process:"
msgstr "Existen 5 pasos importantes en el proceso:"
#. (itstool) path: listitem/para
-#: C/index.docbook:189
+#: C/index.docbook:195
msgid ""
"<guilabel>Writing the documentation.</guilabel> The author fills in the "
"source files with the documentation for each function, macro, union etc. (In "
"lo que ya no se recomienda)."
#. (itstool) path: listitem/para
-#: C/index.docbook:199
+#: C/index.docbook:205
msgid ""
"<guilabel>Gathering information about the code.</guilabel> "
"<application>gtkdoc-scan</application> scans the header files of the code "
"txt</filename> dentro de <filename><module>-overrides.txt</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:216
+#: C/index.docbook:222
msgid ""
"<application>gtkdoc-scangobj</application> can also be used to dynamically "
"query a library about any GObject subclasses it exports. It saves "
"que proporciona."
#. (itstool) path: listitem/para
-#: C/index.docbook:222
+#: C/index.docbook:228
msgid ""
"<application>gtkdoc-scanobj</application> should not be used anymore. It was "
"needed in the past when GObject was still GtkObject inside gtk+."
"necesitó en el pasado, cuando GObject todavía era GtkObject dentro de GTK+."
#. (itstool) path: listitem/para
-#: C/index.docbook:229
+#: C/index.docbook:235
msgid ""
"<guilabel>Generating the \"template\" files.</guilabel> <application>gtkdoc-"
"mktmpl</application> creates a number of files in the <filename class="
"Intentará asegurarse de que la documentación nunca se pierde.)"
#. (itstool) path: note/para
-#: C/index.docbook:238
+#: C/index.docbook:244
msgid ""
"Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep "
"documentation in the code. <application>gtkdocize</application> supports now "
"ejemplo, desde el sistema de control de versiones)."
#. (itstool) path: listitem/para
-#: C/index.docbook:250
+#: C/index.docbook:256
msgid ""
"<guilabel>Generating the SGML/XML and HTML/PDF.</guilabel> "
"<application>gtkdoc-mkdb</application> turns the template files into SGML or "
"recomienda usar Docbook XML."
#. (itstool) path: listitem/para
-#: C/index.docbook:261
+#: C/index.docbook:267
msgid ""
"<application>gtkdoc-mkhtml</application> turns the SGML/XML files into HTML "
"files in the <filename class=\"directory\">html/</filename> subdirectory. "
"paquete>.pdf</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:267
+#: C/index.docbook:273
msgid ""
"Files in <filename class=\"directory\">sgml/</filename> or <filename class="
"\"directory\">xml/</filename> and <filename class=\"directory\">html/</"
"directamente."
#. (itstool) path: listitem/para
-#: C/index.docbook:275
+#: C/index.docbook:281
msgid ""
"<guilabel>Fixing up cross-references between documents.</guilabel> After "
"installing the HTML files, <application>gtkdoc-fixxref</application> can be "
"esa documentación está instalada)."
#. (itstool) path: sect1/title
-#: C/index.docbook:293
+#: C/index.docbook:299
msgid "Getting GTK-Doc"
msgstr "Obtener GTK-Doc"
#. (itstool) path: sect2/title
-#: C/index.docbook:296
+#: C/index.docbook:302
msgid "Requirements"
msgstr "Requerimientos"
#. (itstool) path: sect2/para
-#: C/index.docbook:297
+#: C/index.docbook:303
msgid "<guilabel>Perl v5</guilabel> - the main scripts are in Perl."
msgstr "<guilabel>Perl v5</guilabel>: los scripts principales están en Perl."
#. (itstool) path: sect2/para
-#: C/index.docbook:300
+#: C/index.docbook:306
msgid ""
-"<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. <ulink "
-"url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel> - the xslt processor from libxslt <ulink url="
+"\"http://xmlsoft.org/XSLT/\" type=\"http\">xmlsoft.org/XSLT/</ulink>"
msgstr ""
-"<guilabel>DocBook DTD v3.0</guilabel>: Este es el DocBook SGML DTD. <ulink "
-"url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel>: el procesador xslt de libxslt <ulink url="
+"\"http://xmlsoft.org/XSLT/\" type=\"http\">xmlsoft.org/XSLT/</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:304
+#: C/index.docbook:310
msgid ""
-"<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
-"SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
-"\"http\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets <ulink url="
+"\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type=\"http"
+"\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
msgstr ""
-"<guilabel>Jade v1.1</guilabel>: Este es el procesador DSSSL para convertir "
-"SGML a varios formatos. <ulink url=\"http://www.jclark.com/jade\" type=\"http"
-"\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel>: las hojas de estilo XLS de docbook <ulink "
+"url=\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type="
+"\"http\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:308
-msgid ""
-"<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code to "
-"convert DocBook to HTML (and a few other formats). It's used together with "
-"jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour the "
-"program code listings/declarations, and to support global cross-reference "
-"indices in the generated HTML. <ulink url=\"http://nwalsh.com/docbook/dsssl"
-"\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
-msgstr ""
-"<guilabel>Hojas de estilo DocBook modulares:</guilabel> Éste es el código "
-"DSSSL para convertir DocBook a HTML (y otros cuantos formatos). Se usa junto "
-"con jade. El código DSSSL está algo personalizado, en GTK-Doc dsl, para "
-"colorear el código de listas/declaraciones del programa y soportar índices "
-"de referencias cruzadas globales en el HTML generado. <ulink url=\"http://"
-"nwalsh.com/docbook/dsssl\" type=\"http\">http://nwalsh.com/docbook/dsssl</"
-"ulink>."
+#: C/index.docbook:314
+msgid "<guilabel>Python</guilabel> - optional - for gtkdoc-depscan"
+msgstr "<guilabel>Python</guilabel>: opcional, para gtkdoc-depscan"
#. (itstool) path: sect2/para
#: C/index.docbook:317
msgid ""
-"<guilabel>docbook-to-man</guilabel> - if you want to create man pages from "
-"the DocBook. I've customized the 'translation spec' slightly, to capitalise "
-"section headings and add the 'GTK Library' title at the top of the pages and "
-"the revision date at the bottom. There is a link to this on <ulink url="
-"\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/davenport</"
-"ulink> NOTE: This does not work yet."
-msgstr ""
-"<guilabel>docbook-to-man</guilabel>: Si quiere crear páginas man desde el "
-"DocBook. «translation spec» se ha personalizado un poco para capitalizar la "
-"sección de cabeceras y añadir un título de «Biblioteca GTK» en la parte "
-"superior de las páginas y la fecha de revisión al final. Existe un enlace "
-"acerca de esto en <ulink url=\"http://www.ora.com/davenport\" type=\"http"
-"\">http://www.ora.com/davenport</ulink>. NOTA: Esto aún no funciona."
-
-#. (itstool) path: sect2/title
-#: C/index.docbook:328
-msgid "Installation"
-msgstr "Instalación"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:329
-msgid ""
-"There is no standard place where the DocBook Modular Stylesheets are "
-"installed."
-msgstr ""
-"No existe ningún sitio estándar donde se instalan las hojas de estilo "
-"modulares de DocBook."
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:332
-msgid "GTK-Doc's configure script searches these 3 directories automatically:"
-msgstr ""
-"El script de configuración de GTK-Doc busca estas tres carpetas "
-"automáticamente:"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:335
-msgid ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
-"RedHat)"
-msgstr ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado por "
-"RedHat)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:338
-msgid ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
-msgstr ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado por Debian)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:341
-msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
-msgstr "<filename> /usr/share/sgml/docbkdsl </filename> (usado por SuSE)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:344
-msgid ""
-"If you have the stylesheets installed somewhere else, you need to configure "
-"GTK-Doc using the option: <command> --with-dsssl-dir=<"
-"PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+"One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> "
+"or <guilabel>vim</guilabel> - optional - used for syntax highlighting of "
+"examples"
msgstr ""
-"Si tiene las hojas de estilo instaladas en algún otro sitio, deberá "
-"configurar GTK-Doc usando la opción: <command> --with-dsssl-dir=<"
-"RUTA_A_LA_CARPETA_DE_NIVEL_SUPERIOR_DE_LAS_HOJAS_DE_ESTILO> </command>"
+"Una de <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> "
+"o <guilabel>vim</guilabel>: opcional, usada para el resaltado de sintaxis de "
+"los ejemplos."
#. (itstool) path: sect1/title
-#: C/index.docbook:368
+#: C/index.docbook:325
msgid "About GTK-Doc"
msgstr "Acerca de GTK-Doc"
#. (itstool) path: sect1/para
-#: C/index.docbook:370 C/index.docbook:384
+#: C/index.docbook:327 C/index.docbook:341
msgid "(FIXME)"
msgstr "(ARRÉGLAME)"
#. (itstool) path: sect1/para
-#: C/index.docbook:374
+#: C/index.docbook:331
+#| msgid ""
+#| "(History, authors, web pages, license, future plans, comparison with "
+#| "other similar systems.)"
msgid ""
-"(History, authors, web pages, license, future plans, comparison with other "
-"similar systems.)"
+"(History, authors, web pages, mailing list, license, future plans, "
+"comparison with other similar systems.)"
msgstr ""
-"(Historia, autores, páginas web, licencias, planes futuros, comparación con "
-"otros sistemas similares.)"
+"(Historia, autores, páginas web, listas de correo, licencias, planes "
+"futuros, comparación con otros sistemas similares.)"
#. (itstool) path: sect1/title
-#: C/index.docbook:382
+#: C/index.docbook:339
msgid "About this Manual"
msgstr "Acerca de este manual"
#. (itstool) path: sect1/para
-#: C/index.docbook:388
+#: C/index.docbook:345
msgid "(who it is meant for, where you can get it, license)"
msgstr "(a quién está dirigido, dónde puede obtenerse, licencia)"
#. (itstool) path: chapter/title
-#: C/index.docbook:397
+#: C/index.docbook:354
msgid "Setting up your project"
msgstr "Configurando su proyecto"
#. (itstool) path: chapter/para
-#: C/index.docbook:399
+#: C/index.docbook:356
msgid ""
"The next sections describe what steps to perform to integrate GTK-Doc into "
"your project. Theses sections assume we work on a project called 'meep'. "
"construcción diferente."
#. (itstool) path: sect1/title
-#: C/index.docbook:410
+#: C/index.docbook:367
msgid "Setting up a skeleton documentation"
msgstr "Configurar el esquema de la documentación"
#. (itstool) path: sect1/para
-#: C/index.docbook:412
+#: C/index.docbook:369
msgid ""
"Under your top-level project directory create folders called docs/reference "
"(this way you can also have docs/help for end-user documentation). It is "
"Para paquetes con una sola biblioteca este paso no es necesario."
#. (itstool) path: example/title
-#: C/index.docbook:421
+#: C/index.docbook:378
msgid "Example directory structure"
msgstr "Ejemplo de estructura de carpetas"
#. (itstool) path: example/programlisting
-#: C/index.docbook:422
+#: C/index.docbook:379
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "meep/\n"
+#| " docs/\n"
+#| " reference/\n"
+#| " libmeep/\n"
+#| " meeper/\n"
+#| " src/\n"
+#| " libmeep/\n"
+#| " meeper/\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:419
+#: C/index.docbook:376
msgid "This can then look as shown below: <_:example-1/>"
msgstr "Esto después aparecerá como se muestra debajo: <_:example-1/>"
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:439 C/index.docbook:446
+#: C/index.docbook:394 C/index.docbook:401
msgid "Integration with autoconf"
msgstr "Integración con autoconf"
#. (itstool) path: sect1/para
-#: C/index.docbook:441
+#: C/index.docbook:396
msgid ""
"Very easy! Just add one line to your <filename>configure.ac</filename> "
"script."
"filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:447
+#: C/index.docbook:402
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "# check for gtk-doc\n"
+#| "GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"# check for gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
#. (itstool) path: example/title
-#: C/index.docbook:461
+#: C/index.docbook:414
msgid "Keep gtk-doc optional"
msgstr "Mantener gtk-doc como opcional"
#. (itstool) path: example/programlisting
-#: C/index.docbook:462
+#: C/index.docbook:415
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "# check for gtk-doc\n"
+#| "m4_ifdef([GTK_DOC_CHECK], [\n"
+#| "GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
+#| "],[\n"
+#| "AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
+#| "])\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"# check for gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:456
+#: C/index.docbook:409
msgid ""
"This will require all developers to have gtk-doc installed. If it is okay "
"for your project to have optional api-doc build setup, you can solve this as "
"<_:example-1/>"
#. (itstool) path: sect1/para
-#: C/index.docbook:475
+#: C/index.docbook:426
msgid ""
"The first argument is used to check for the gtkdocversion at configure time. "
"The 2nd, optional argument is used by <application>gtkdocize</application>. "
"symbol> también añade diversas opciones de configuración:"
#. (itstool) path: listitem/para
-#: C/index.docbook:481
+#: C/index.docbook:432
msgid "--with-html-dir=PATH : path to installed docs"
msgstr "--with-html-dir=RUTA: ruta a los documentos instalados"
#. (itstool) path: listitem/para
-#: C/index.docbook:482
+#: C/index.docbook:433
msgid "--enable-gtk-doc : use gtk-doc to build documentation [default=no]"
msgstr ""
"--enable-gtk-doc: usar gtk-doc para construir la documentación "
"[predeterminado=no]"
#. (itstool) path: listitem/para
-#: C/index.docbook:483
+#: C/index.docbook:434
msgid ""
"--enable-gtk-doc-html : build documentation in html format [default=yes]"
msgstr ""
"[predeterminado=sí]"
#. (itstool) path: listitem/para
-#: C/index.docbook:484
+#: C/index.docbook:435
msgid "--enable-gtk-doc-pdf : build documentation in pdf format [default=no]"
msgstr ""
"--enable-gtk-doc: usar gtk-doc para construir la documentación "
"[predeterminado=no]"
#. (itstool) path: important/para
-#: C/index.docbook:488
+#: C/index.docbook:439
msgid ""
"GTK-Doc is disabled by default! Remember to pass the option <option>'--"
"enable-gtk-doc'</option> to the next <filename>configure</filename> run. "
"desarrolladores)."
#. (itstool) path: sect1/para
-#: C/index.docbook:496
+#: C/index.docbook:447
msgid ""
"Furthermore it is recommended that you have the following line inside you "
"<filename>configure.ac</filename> script. This allows "
"<function>GTK_DOC_CHECK</function> a su proyecto."
#. (itstool) path: example/title
-#: C/index.docbook:504
+#: C/index.docbook:455
msgid "Preparation for gtkdocize"
msgstr "Preparación para gtkdocize"
#. (itstool) path: example/programlisting
-#: C/index.docbook:505
+#: C/index.docbook:456
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "AC_CONFIG_MACRO_DIR(m4)\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:461
+msgid ""
+"After all changes to <filename>configure.ac</filename> are made, update the "
+"<filename>configure</filename> file. This can be done by re-running "
+"<code>autoreconf -i</code> or <code>autogen.sh</code>."
+msgstr ""
+"Después de hacer los cambios en el <filename>configure.ac</filename> "
+"actualice el archivo <filename>configure</filename>. Esto se puede hacer "
+"volviendo a ejecutar <code>autoreconf -i</code> o <code>autogen.sh</code>."
#. (itstool) path: sect1/title
-#: C/index.docbook:515
+#: C/index.docbook:469
msgid "Integration with automake"
msgstr "Integración con automake"
#. (itstool) path: sect1/para
-#: C/index.docbook:517
+#: C/index.docbook:471
msgid ""
"First copy the <filename>Makefile.am</filename> from the <filename class="
"\"directory\">examples</filename> sub directory of the <ulink url=\"https://"
"repítalo para cada uno de ellos."
#. (itstool) path: sect1/para
-#: C/index.docbook:528
+#: C/index.docbook:482
msgid ""
"The next step is to edit the settings inside the <filename>Makefile.am</"
"filename>. All the settings have a comment above that describes their "
"soportan <option>--help</option> para listar los parámetros que soportan."
#. (itstool) path: sect1/title
-#: C/index.docbook:542
+#: C/index.docbook:496
msgid "Integration with autogen"
msgstr "Integración con autogen"
#. (itstool) path: sect1/para
-#: C/index.docbook:544
+#: C/index.docbook:498
msgid ""
"Most projects will have an <filename>autogen.sh</filename> script to setup "
"the build infrastructure after a checkout from version control system (such "
"automake o autoconf."
#. (itstool) path: example/title
-#: C/index.docbook:553
+#: C/index.docbook:507
msgid "Running gtkdocize from autogen.sh"
msgstr "Ejecutar gtkdocize desde autogen.sh"
#. (itstool) path: example/programlisting
-#: C/index.docbook:554
+#: C/index.docbook:508
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "gtkdocize || exit 1\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:562
+#: C/index.docbook:514
msgid ""
"When running <application>gtkdocize</application> it copies <filename>gtk-"
"doc.make</filename> to your project root (or any directory specified by the "
"<application>gtkdocize</application>."
#. (itstool) path: sect1/para
-#: C/index.docbook:571
+#: C/index.docbook:523
msgid ""
"Historically GTK-Doc was generating template files where developers entered "
"the docs. This turned out to be not so good (e.g. the need for having "
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:588 C/index.docbook:605
+#: C/index.docbook:540 C/index.docbook:557
msgid "Running the doc build"
msgstr "Ejecutar la construcción de la documentación"
#. (itstool) path: sect1/para
-#: C/index.docbook:590
+#: C/index.docbook:542
msgid ""
"After the previous steps it's time to run the build. First we need to rerun "
"<filename>autogen.sh</filename>. If this script runs configure for you, then "
"<filename>configure</filename> con esta opción."
#. (itstool) path: sect1/para
-#: C/index.docbook:597
+#: C/index.docbook:549
msgid ""
"The first make run generates several additional files in the doc-"
"directories. The important ones are: <filename><package>.types</"
"pasado), <filename><paquete>-sections.txt</filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:606
+#: C/index.docbook:558
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "./autogen.sh --enable-gtk-doc\n"
+#| "make\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:614
+#: C/index.docbook:564
msgid ""
"Now you can point your browser to <filename>docs/reference/<package>/"
"index.html</filename>. Yes, it's a bit disappointing still. But hang-on, "
"información."
#. (itstool) path: sect1/title
-#: C/index.docbook:622
+#: C/index.docbook:572
msgid "Integration with version control systems"
msgstr "Integración con los sistemas de control de versiones"
#. (itstool) path: sect1/para
-#: C/index.docbook:624
+#: C/index.docbook:574
msgid ""
"As a rule of the thumb, it's those files you edit, that should go under "
"version control. For typical projects it's these files: <filename><"
"filename> y <filename>Makefile.am</filename>."
#. (itstool) path: sect1/title
-#: C/index.docbook:635
+#: C/index.docbook:585
msgid "Integration with plain makefiles or other build systems"
msgstr "Integración con makefiles u otros sistemas de construcción"
#. (itstool) path: sect1/para
-#: C/index.docbook:637
+#: C/index.docbook:587
msgid ""
"In the case one does not want to use automake and therefore <filename>gtk-"
"doc.mak</filename> one will need to call the gtkdoc tools in the right order "
"makefiles propios (o en otras herramientas de construcción)."
#. (itstool) path: example/title
-#: C/index.docbook:644
+#: C/index.docbook:594
msgid "Documentation build steps"
msgstr "Pasos de construcción de la documentación"
#. (itstool) path: example/programlisting
-#: C/index.docbook:645
+#: C/index.docbook:595
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "DOC_MODULE=meep\n"
+#| "// sources have changed\n"
+#| "gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
+#| "gtkdoc-scangobj --module=$(DOC_MODULE)\n"
+#| "gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml\n"
+#| "// xml files have changed\n"
+#| "mkdir html\n"
+#| "cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
+#| "gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// sources have changed\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// sources have changed\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:661
+#: C/index.docbook:609
msgid ""
"One will need to look at the <filename>Makefile.am</filename> and "
"<filename>gtk-doc.mak</filename> to pick the extra options needed."
"doc.mak</filename> para elegir las opciones adicionales necesarias."
#. (itstool) path: chapter/title
-#: C/index.docbook:670
+#: C/index.docbook:618
msgid "Documenting the code"
msgstr "Documentar el código"
#. (itstool) path: chapter/para
-#: C/index.docbook:672
+#: C/index.docbook:620
msgid ""
"GTK-Doc uses source code comment with a special syntax for code "
"documentation. Further it retrieves information about your project structure "
"acerca de la sintaxis de los comentarios."
#. (itstool) path: note/title
-#: C/index.docbook:680
+#: C/index.docbook:628
msgid "Documentation placement"
msgstr "Ubicación de la documentación"
#. (itstool) path: note/para
-#: C/index.docbook:681
+#: C/index.docbook:629
msgid ""
"In the past most documentation had to be filled into files residing inside "
"the <filename>tmpl</filename> directory. This has the disadvantages that the "
"conflictos con los sistemas de control de versiones."
#. (itstool) path: note/para
-#: C/index.docbook:687
+#: C/index.docbook:635
msgid ""
"The avoid the aforementioned problems we suggest putting the documentation "
"inside the sources. This manual will only describe this way of documenting "
"documentar el código."
#. (itstool) path: example/title
-#: C/index.docbook:698 C/index.docbook:717
+#: C/index.docbook:646 C/index.docbook:663
msgid "GTK-Doc comment block"
msgstr "Bloque de comentario de GTK-Doc"
#. (itstool) path: example/programlisting
-#: C/index.docbook:699
+#: C/index.docbook:647
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "#ifndef __GTK_DOC_IGNORE__\n"
+#| "/* unparseable code here */\n"
+#| "#endif\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* unparseable code here */\n"
"#endif\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* unparseable code here */\n"
"#endif\n"
-"\n"
-" "
#. (itstool) path: chapter/para
-#: C/index.docbook:694
+#: C/index.docbook:642
msgid ""
"The scanner can handle the majority of C headers fine. In the case of "
"receiving warnings from the scanner that look like a special case, one can "
"GTK-Doc que los omita. <_:example-1/>"
#. (itstool) path: sect1/title
-#: C/index.docbook:712
+#: C/index.docbook:658
msgid "Documentation comments"
msgstr "Comentarios de la documentación"
#. (itstool) path: example/programlisting
-#: C/index.docbook:718
+#: C/index.docbook:664
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * identifier:\n"
+#| " * documentation ...\n"
+#| " */\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" * documentation ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" * documentation ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:714
+#: C/index.docbook:660
msgid ""
"A multiline comment that starts with an additional '*' marks a documentation "
"block that will be processed by the GTK-Doc tools. <_:example-1/>"
"bloque de documentación que GTK-Doc tools procesarán. <_:example-1/>"
#. (itstool) path: sect1/para
-#: C/index.docbook:729
+#: C/index.docbook:673
msgid ""
"The 'identifier' is one line with the name of the item the comment is "
"related to. The syntax differs a little depending on the item. (TODO add "
"hacer: añadir una tabla mostrando los identificadores)"
#. (itstool) path: sect1/para
-#: C/index.docbook:735
+#: C/index.docbook:679
msgid ""
"The 'documentation' block is also different for each symbol type. Symbol "
"types that get parameters such as functions or macros have the parameter "
"espacio). Esto es útil para texto preformateado (listados de código)."
#. (itstool) path: listitem/para
-#: C/index.docbook:752
+#: C/index.docbook:696
msgid ""
"What it is: The name for a class or function can sometimes be misleading for "
"people coming from a different background."
"personas que provengan de otros entornos."
#. (itstool) path: listitem/para
-#: C/index.docbook:758
+#: C/index.docbook:702
msgid ""
"What it does: Tell about common uses. Put it in relation with the other API."
msgstr "Qué hace: indique los usos comunes, en relación con las otras API."
#. (itstool) path: tip/para
-#: C/index.docbook:748
+#: C/index.docbook:692
msgid "When documenting code, describe two aspects: <_:itemizedlist-1/>"
msgstr "Al documentar código, describa dos aspectos: <_:itemizedlist-1/>"
#. (itstool) path: listitem/para
-#: C/index.docbook:773
+#: C/index.docbook:717
msgid "Use function() to refer to functions or macros which take arguments."
msgstr ""
"Use función() para referirse a funciones o macros que toman argumentos."
#. (itstool) path: listitem/para
-#: C/index.docbook:778
+#: C/index.docbook:722
msgid ""
"Use @param to refer to parameters. Also use this when referring to "
"parameters of other functions, related to the one being described."
"parámetros de otras funciones, relacionados al que se describe."
#. (itstool) path: listitem/para
-#: C/index.docbook:784
+#: C/index.docbook:728
msgid "Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS."
msgstr "Use %constant para referirse a una constante, ej: %G_TRAVERSE_LEAFS."
#. (itstool) path: listitem/para
-#: C/index.docbook:789
+#: C/index.docbook:733
msgid ""
"Use #symbol to refer to other types of symbol, e.g. structs and enums and "
"macros which don't take arguments."
"estructuras, enumeraciones y macros que no toman argumentos."
#. (itstool) path: listitem/para
-#: C/index.docbook:795
+#: C/index.docbook:739
msgid "Use #Object::signal to refer to a GObject signal."
msgstr "Use #Object::signal para referirse a una señal de GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:800
+#: C/index.docbook:744
msgid "Use #Object:property to refer to a GObject property."
msgstr "Use #Object:property para referirse a una propiedad de GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:805
+#: C/index.docbook:749
msgid ""
"Use #Struct.field to refer to a field inside a structure and #GObjectClass."
"foo_bar() to refer to a vmethod."
"#GObjectClass.foo_bar() para referirse a un vmethod."
#. (itstool) path: sect1/para
-#: C/index.docbook:767
+#: C/index.docbook:711
msgid ""
"One advantage of hyper-text over plain-text is the ability to have links in "
"the document. Writing the correct markup for a link can be tedious though. "
"itemizedlist-1/>"
#. (itstool) path: tip/para
-#: C/index.docbook:814
+#: C/index.docbook:758
msgid ""
"If you need to use the special characters '<', '>', '()', '@', '%', or "
"'#' in your documentation without GTK-Doc changing them you can use the XML "
"doble «\\»."
#. (itstool) path: sect1/para
-#: C/index.docbook:823
+#: C/index.docbook:767
msgid ""
-"DocBook can do more than just links. One can also have lists, tables and "
-"examples. To enable the usage of docbook SGML/XML tags inside doc-comments "
-"you need to have <option>--xml-mode</option> or <option>--sgml-mode</option> "
-"in the variable <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</"
-"filename>."
+"DocBook can do more than just links. One can also have lists, examples, "
+"headings, and images. As of version 1.20, the preferred way is to use a "
+"subset of the basic text formatting syntax called <ulink url=\"http://"
+"daringfireball.net/projects/markdown/\">Markdown</ulink>. On older GTK-Doc "
+"versions any documentation that includes Markdown will be rendered as is. "
+"For example, list items will appear as lines starting with a dash."
msgstr ""
-"DocBook puede hacer más que insertar enlaces. Puede tener listas, tablas y "
-"ejemplos. Para activar el uso de etiquetas SGML/XML dentro de comentarios en "
-"la documentación debe tener <option>--xml-mode</option> o <option>--sgml-"
-"mode</option> en la variable <symbol>MKDB_OPTIONS</symbol> dentro de "
+"DocBook puede crear algo más que enlaces. También se pueden tener listas, "
+"ejemplos, cabeceras e imágenes. En la versión 1.20, la manera prefefira de "
+"hacer esto es usando un subconjunto de la sintaxis básica de formateado de "
+"texto llamada <ulink url=\"http://daringfireball.net/projects/markdown/"
+"\">Marcado</ulink>. En versiones anteriores de GTK-Doc, cualquier "
+"documentación que incluya marcado se renderizará como tal. Por ejemplo, los "
+"elementos de una lista aparecerán como líneas que empiezan con un guión."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:778
+msgid ""
+"In older GTK-Doc releases, if you need support for additional formatting, "
+"you would need to enable the usage of docbook SGML/XML tags inside doc-"
+"comments by putting <option>--xml-mode</option> or <option>--sgml-mode</"
+"option> in the variable <symbol>MKDB_OPTIONS</symbol> inside "
"<filename>Makefile.am</filename>."
+msgstr ""
+"En versiones anteriores de GTK-Doc, si necesitaba soporte para formato "
+"adicional, necesitaba activar el uso de etiquetas SGML/XML dentro de "
+"comentarios en la documentación poniendo <option>--xml-mode</option> o "
+"<option>--sgml-mode</option> en la variable <symbol>MKDB_OPTIONS</symbol> "
+"dentro de <filename>Makefile.am</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:837
-msgid "GTK-Doc comment block using markdown"
+#: C/index.docbook:788
+msgid "GTK-Doc comment block using Markdown"
msgstr "Bloque de comentario de GTK-Doc usando marcado"
#. (itstool) path: example/programlisting
-#: C/index.docbook:838
+#: C/index.docbook:789
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * identifier:\n"
+#| " *\n"
+#| " * documentation paragraph ...\n"
+#| " *\n"
+#| " * # Sub Heading #\n"
+#| " *\n"
+#| " * ## Second Sub Heading\n"
+#| " *\n"
+#| " * # Sub Heading With a Link Anchor # {#heading-two}\n"
+#| " *\n"
+#| " * more documentation:\n"
+#| " *\n"
+#| " * - list item 1\n"
+#| " *\n"
+#| " * Paragraph inside a list item.\n"
+#| " *\n"
+#| " * - list item 2\n"
+#| " *\n"
+#| " * 1. numbered list item\n"
+#| " *\n"
+#| " * 2. another numbered list item\n"
+#| " *\n"
+#| " * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n"
+#| " *\n"
+#| " * ![an inline image][plot-result.png]\n"
+#| " *\n"
+#| " * [A link to the heading anchor above][heading-two]\n"
+#| " *\n"
+#| " * A C-language example:\n"
+#| " * |[<!-- language=\"C\" -->\n"
+#| " * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n"
+#| " * ]|\n"
+#| " */\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" *\n"
-" * documentation ...\n"
+" * documentation paragraph ...\n"
+" *\n"
+" * # Sub Heading #\n"
" *\n"
-" * # Sub heading #\n"
+" * ## Second Sub Heading\n"
+" *\n"
+" * # Sub Heading With a Link Anchor # {#heading-two}\n"
" *\n"
" * more documentation:\n"
+" *\n"
" * - list item 1\n"
+" *\n"
+" * Paragraph inside a list item.\n"
+" *\n"
" * - list item 2\n"
" *\n"
-" * Even more docs.\n"
+" * 1. numbered list item\n"
+" *\n"
+" * 2. another numbered list item\n"
+" *\n"
+" * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n"
+" *\n"
+" * ![an inline image][plot-result.png]\n"
+" *\n"
+" * [A link to the heading anchor above][heading-two]\n"
+" *\n"
+" * A C-language example:\n"
+" * |[<!-- language=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" *\n"
-" * documentation ...\n"
+" * documentation paragraph ...\n"
+" *\n"
+" * # Sub Heading #\n"
" *\n"
-" * # Sub heading #\n"
+" * ## Second Sub Heading\n"
+" *\n"
+" * # Sub Heading With a Link Anchor # {#heading-two}\n"
" *\n"
" * more documentation:\n"
+" *\n"
" * - list item 1\n"
+" *\n"
+" * Paragraph inside a list item.\n"
+" *\n"
" * - list item 2\n"
" *\n"
-" * Even more docs.\n"
+" * 1. numbered list item\n"
+" *\n"
+" * 2. another numbered list item\n"
+" *\n"
+" * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n"
+" *\n"
+" * ![an inline image][plot-result.png]\n"
+" *\n"
+" * [A link to the heading anchor above][heading-two]\n"
+" *\n"
+" * A C-language example:\n"
+" * |[<!-- language=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:831
-#| msgid ""
-#| "Since GTK-Doc-1.18 the tool supports a subset of the <ulink url=\"http://"
-#| "daringfireball.net/projects/markdown/\">markdown language</ulink>. One "
-#| "can use it for sub-headings and simple itemized lists. On older GTK-Doc "
-#| "versions the content will be rendered as it (the list items will appear "
-#| "in one line separated by dashes). <_:example-1/>"
-msgid ""
-"Since GTK-Doc-1.18 the tool supports a subset of the <ulink url=\"http://"
-"daringfireball.net/projects/markdown/\">markdown language</ulink>. The "
-"support has improved a lot with version 1.20. On older GTK-Doc versions the "
-"content will be rendered as it (the list items will appear in one line "
-"separated by dashes). <_:example-1/>"
-msgstr ""
-"Desde GTK-Doc-1.18 la herramienta soporta un subconjunto de <ulink url="
-"\"http://daringfireball.net/projects/markdown/\">lenguajes de marcado</"
-"ulink>. En la versión 1.20 se ha mejorado ucho este soporte. En versiones "
-"más antiguas de GTK-Doc el contenido se puede renderizar como tal (la lista "
-"de elementos aparecerá en una línea separada por guiones). <_:example-1/>"
-
-#. (itstool) path: sect1/para
-#: C/index.docbook:858
+#: C/index.docbook:828
msgid ""
"More examples of what markdown tags are supported can be found in the <ulink "
-"url=\"http://git.gnome.org/browse/gtk-doc/tree/tests\">gtk-doc test suite</"
-"ulink>."
+"url=\"https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown"
+"\">GTK+ Documentation Markdown Syntax Reference</ulink>."
msgstr ""
"Se pueden encontrar más ejemplos de las etiquetas de marcado soportadas en "
-"el <ulink url=\"http://git.gnome.org/browse/gtk-doc/tree/tests\">conjunto de "
-"pruebas de gtk-doc</ulink>."
+"el <ulink url=\"https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/"
+"Markdown\">Manual de referencia de sintaxis de marcado de documentación de "
+"GTK+</ulink>."
#. (itstool) path: tip/para
-#: C/index.docbook:864
+#: C/index.docbook:834
msgid ""
"As already mentioned earlier GTK-Doc is for documenting public API. Thus one "
"cannot write documentation for static symbols. Nevertheless it is good to "
"secciones."
#. (itstool) path: sect1/title
-#: C/index.docbook:878
+#: C/index.docbook:848
msgid "Documenting sections"
msgstr "Documentar secciones"
#. (itstool) path: sect1/para
-#: C/index.docbook:880
+#: C/index.docbook:850
msgid ""
"Each section of the documentation contains information about one class or "
"module. To introduce the component one can write a section block. The short "
"los campos @ son opcionales."
#. (itstool) path: example/title
-#: C/index.docbook:888
+#: C/index.docbook:858
msgid "Section comment block"
msgstr "Bloque de comentarios en una sección"
#. (itstool) path: example/programlisting
-#: C/index.docbook:889
+#: C/index.docbook:859
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * SECTION:meepapp\n"
+#| " * @short_description: the application class\n"
+#| " * @title: Meep application\n"
+#| " * @section_id:\n"
+#| " * @see_also: #MeepSettings\n"
+#| " * @stability: Stable\n"
+#| " * @include: meep/app.h\n"
+#| " * @image: application.png\n"
+#| " *\n"
+#| " * The application class handles ...\n"
+#| " */\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: the application class\n"
" *\n"
" * The application class handles ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: the application class\n"
" *\n"
" * The application class handles ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: varlistentry/term
-#: C/index.docbook:910
+#: C/index.docbook:878
msgid "SECTION:<name>"
msgstr "SECCIÓN <nombre>"
#. (itstool) path: listitem/para
-#: C/index.docbook:912
+#: C/index.docbook:880
msgid ""
"The name links the section documentation to the respective part in the "
"<filename><package>-sections.txt</filename> file. The name give here "
"archivo <filename><paquete>-sections.txt</filename>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:921
+#: C/index.docbook:889
msgid "@short_description"
msgstr "@short_description"
#. (itstool) path: listitem/para
-#: C/index.docbook:923
+#: C/index.docbook:891
msgid ""
"A one line description of the section, that later will appear after the "
"links in the TOC and at the top of the section page."
"TOC y en la página de la sección."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:930
+#: C/index.docbook:898
msgid "@title"
msgstr "@title"
#. (itstool) path: listitem/para
-#: C/index.docbook:932
+#: C/index.docbook:900
msgid ""
"The section title defaults to <name> from the SECTION declaration. It "
"can be overridden with the @title field."
"declaración SECTION. Se puede sobrescribir con el campo @title."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:939
+#: C/index.docbook:907
msgid "@section_id"
msgstr "@section_id"
#. (itstool) path: listitem/para
-#: C/index.docbook:941
+#: C/index.docbook:909
msgid ""
"Overrides the use of title as a section identifier. For GObjects the <"
"title> is used as a section_id and for other sections it is <"
"para otra sección es <MÓDULO>-<title>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:949
+#: C/index.docbook:917
msgid "@see_also"
msgstr "@see_also"
#. (itstool) path: listitem/para
-#: C/index.docbook:951
+#: C/index.docbook:919
msgid "A list of symbols that are related to this section."
msgstr "Una lista de símbolos relacionados con esta sección."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:957
+#: C/index.docbook:925
msgid "@stability"
msgstr "@stability"
#. (itstool) path: listitem/para
-#: C/index.docbook:964
+#: C/index.docbook:932
msgid ""
"Stable - The intention of a Stable interface is to enable arbitrary third "
"parties to develop applications to these interfaces, release them, and have "
"de haberlos habrá buenas razones para ello."
#. (itstool) path: listitem/para
-#: C/index.docbook:976
+#: C/index.docbook:944
msgid ""
"Unstable - Unstable interfaces are experimental or transitional. They are "
"typically used to give outside developers early access to new or rapidly "
"publicación menor a la siguiente."
#. (itstool) path: listitem/para
-#: C/index.docbook:988
+#: C/index.docbook:956
msgid ""
"Private - An interface that can be used within the GNOME stack itself, but "
"that is not documented for end-users. Such functions should only be used in "
"deberían usar de formas especificadas y documentadas."
#. (itstool) path: listitem/para
-#: C/index.docbook:997
+#: C/index.docbook:965
msgid ""
"Internal - An interface that is internal to a module and does not require "
"end-user documentation. Functions that are undocumented are assumed to be "
"son internas."
#. (itstool) path: listitem/para
-#: C/index.docbook:959
+#: C/index.docbook:927
msgid ""
"An informal description of the stability level this API has. We recommend "
"the use of one of these terms: <_:itemizedlist-1/>"
"recomienda el uso de uno de estos términos: <_:itemizedlist-1/>"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1009
+#: C/index.docbook:977
msgid "@include"
msgstr "@include"
#. (itstool) path: listitem/para
-#: C/index.docbook:1011
+#: C/index.docbook:979
msgid ""
"The <literal>#include</literal> files to show in the section synopsis (a "
"comma separated list), overriding the global value from the <link linkend="
"línea de comandos. Este elemento es opcional."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1020
+#: C/index.docbook:988
msgid "@image"
msgstr "@image"
#. (itstool) path: listitem/para
-#: C/index.docbook:1022
+#: C/index.docbook:990
msgid ""
"The image to display at the top of the reference page for this section. This "
"will often be some sort of a diagram to illustrate the visual appearance of "
"Este elemento es opcional."
#. (itstool) path: tip/para
-#: C/index.docbook:1033
+#: C/index.docbook:1001
msgid ""
"To avoid unnecessary recompilation after doc-changes put the section docs "
"into the c-source where possible."
"sea posible."
#. (itstool) path: sect1/title
-#: C/index.docbook:1042
+#: C/index.docbook:1010
msgid "Documenting symbols"
msgstr "Documentar símbolos"
#. (itstool) path: sect1/para
-#: C/index.docbook:1044
+#: C/index.docbook:1012
msgid ""
"Each symbol (function, macro, struct, enum, signal and property) is "
"documented in a separate block. The block is best placed close to the "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1052 C/index.docbook:1081
+#: C/index.docbook:1020 C/index.docbook:1049
msgid "General tags"
msgstr "Etiquetas generales"
#. (itstool) path: sect2/para
-#: C/index.docbook:1054
+#: C/index.docbook:1022
msgid ""
"You can add versioning information to all documentation elements to tell "
"when an API was introduced, or when it was deprecated."
"obsoleta."
#. (itstool) path: variablelist/title
-#: C/index.docbook:1059
+#: C/index.docbook:1027
msgid "Versioning Tags"
msgstr "Versionado de etiquetas"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1060
+#: C/index.docbook:1028
msgid "Since:"
msgstr "Desde:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1062
+#: C/index.docbook:1030
msgid "Description since which version of the code the API is available."
msgstr "Descripción desde qué versión del código está disponible la API."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1067
+#: C/index.docbook:1035
msgid "Deprecated:"
msgstr "Obsoleto:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1069
+#: C/index.docbook:1037
msgid ""
"Paragraph denoting that this function should no be used anymore. The "
"description should point the reader to the new API."
"debería informar al lector de la nueva API."
#. (itstool) path: sect2/para
-#: C/index.docbook:1077
+#: C/index.docbook:1045
msgid "(FIXME : Stability information)"
msgstr "(ARREGLAR: estabilidad de la información)"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1082
+#: C/index.docbook:1050
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * foo_get_bar:\n"
+#| " * @foo: some foo\n"
+#| " *\n"
+#| " * Retrieves @foo's bar.\n"
+#| " *\n"
+#| " * Returns: @foo's bar\n"
+#| " *\n"
+#| " * Since: 2.6\n"
+#| " * Deprecated: 2.12: Use foo_baz_get_bar() instead.\n"
+#| " */\n"
+#| "Bar *\n"
+#| "foo_get_bar(Foo *foo)\n"
+#| "{\n"
+#| "...\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: some foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: some foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1104 C/index.docbook:1140
+#: C/index.docbook:1070 C/index.docbook:1106
msgid "Function comment block"
msgstr "Bloque de comentario de función"
#. (itstool) path: listitem/para
-#: C/index.docbook:1110
+#: C/index.docbook:1076
msgid ""
"Document whether returned objects, lists, strings, etc, should be freed/"
"unrefed/released."
"debería liberarse/desreferenciarse/etc."
#. (itstool) path: listitem/para
-#: C/index.docbook:1116
+#: C/index.docbook:1082
msgid "Document whether parameters can be NULL, and what happens if they are."
msgstr ""
"El documento, dependiendo de si sus parámetros pueden ser nulos, y qué "
"sucede si lo son."
#. (itstool) path: listitem/para
-#: C/index.docbook:1121
+#: C/index.docbook:1087
msgid ""
"Mention interesting pre-conditions and post-conditions where appropriate."
msgstr ""
"Mencionar precondiciones y postcondiciones interesantes donde sea apropiado."
#. (itstool) path: sect2/para
-#: C/index.docbook:1106 C/index.docbook:1203
+#: C/index.docbook:1072 C/index.docbook:1165
msgid "Please remember to: <_:itemizedlist-1/>"
msgstr "Recuerde: <_:itemizedlist-1/>"
#. (itstool) path: sect2/para
-#: C/index.docbook:1128
+#: C/index.docbook:1094
msgid ""
"Gtk-doc assumes all symbols (macros, functions) starting with '_' are "
"private. They are treated like static functions."
"«_» son privados. Se tratan como funciones estáticas."
#. (itstool) path: sect2/para
-#: C/index.docbook:1133
+#: C/index.docbook:1099
msgid ""
"Also, take a look at GObject Introspection annotation tags: http://live."
"gnome.org/GObjectIntrospection/Annotations"
"GObject: http://live.gnome.org/GObjectIntrospection/Annotations"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1141
+#: C/index.docbook:1107
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * function_name:\n"
+#| " * @par1: description of parameter 1. These can extend over more than\n"
+#| " * one line.\n"
+#| " * @par2: description of parameter 2\n"
+#| " * @...: a %NULL-terminated list of bars\n"
+#| " *\n"
+#| " * The function description goes here. You can use @par1 to refer to parameters\n"
+#| " * so that they are highlighted in the output. You can also use %constant\n"
+#| " * for constants, function_name2() for functions and #GtkWidget for links to\n"
+#| " * other declarations (which may be documented elsewhere).\n"
+#| " *\n"
+#| " * Returns: an integer.\n"
+#| " *\n"
+#| " * Since: 2.2\n"
+#| " * Deprecated: 2.18: Use other_function() instead.\n"
+#| " */\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * function_name:\n"
" * @par1: description of parameter 1. These can extend over more than\n"
" * Since: 2.2\n"
" * Deprecated: 2.18: Use other_function() instead.\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * function_name:\n"
" * @par1: description of parameter 1. These can extend over more than\n"
" * Since: 2.2\n"
" * Deprecated: 2.18: Use other_function() instead.\n"
" */\n"
-"\n"
-" "
#. (itstool) path: variablelist/title
-#: C/index.docbook:1164
+#: C/index.docbook:1128
msgid "Function tags"
msgstr "Etiquetas de funciones"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1165
+#: C/index.docbook:1129
msgid "Returns:"
msgstr "Devuelve:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1167
+#: C/index.docbook:1131
msgid "Paragraph describing the returned result."
msgstr "Párrafo que describe el resultado devuelto."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1172
+#: C/index.docbook:1136
msgid "@...:"
msgstr "@...:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1174
+#: C/index.docbook:1138
msgid ""
"In case the function has variadic arguments, you should use this tag "
"(@Varargs: does also work for historic reasons)."
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1184 C/index.docbook:1186
+#: C/index.docbook:1148 C/index.docbook:1150
msgid "Property comment block"
msgstr "Bloque de comentario de propiedad"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1187
+#: C/index.docbook:1151
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * SomeWidget:some-property:\n"
+#| " *\n"
+#| " * Here you can document a property.\n"
+#| " */\n"
+#| "g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * SomeWidget:some-property:\n"
" *\n"
" * Here you can document a property.\n"
" */\n"
"g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * SomeWidget:some-property:\n"
" *\n"
" * Here you can document a property.\n"
" */\n"
"g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1201 C/index.docbook:1220
+#: C/index.docbook:1163 C/index.docbook:1182
msgid "Signal comment block"
msgstr "Bloque de comentario de señal"
#. (itstool) path: listitem/para
-#: C/index.docbook:1207
+#: C/index.docbook:1169
msgid ""
"Document when the signal is emitted and whether it is emitted before or "
"after other signals."
"otras señales."
#. (itstool) path: listitem/para
-#: C/index.docbook:1213
+#: C/index.docbook:1175
msgid "Document what an application might do in the signal handler."
msgstr "Documentar qué aplicación debe gestionar las señales."
#. (itstool) path: example/programlisting
-#: C/index.docbook:1221
+#: C/index.docbook:1183
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * FooWidget::foobarized:\n"
+#| " * @widget: the widget that received the signal\n"
+#| " * @foo: some foo\n"
+#| " * @bar: some bar\n"
+#| " *\n"
+#| " * The ::foobarized signal is emitted each time someone tries to foobarize @widget.\n"
+#| " */\n"
+#| "foo_signals[FOOBARIZE] =\n"
+#| " g_signal_new (\"foobarize\",\n"
+#| " ...\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarized:\n"
" * @widget: the widget that received the signal\n"
"foo_signals[FOOBARIZE] =\n"
" g_signal_new (\"foobarize\",\n"
" ...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarized:\n"
" * @widget: the widget that received the signal\n"
"foo_signals[FOOBARIZE] =\n"
" g_signal_new (\"foobarize\",\n"
" ...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1240 C/index.docbook:1241
+#: C/index.docbook:1200 C/index.docbook:1201
msgid "Struct comment block"
msgstr "Bloque de comentario de estructura"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1242
+#: C/index.docbook:1202
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * FooWidget:\n"
+#| " * @bar: some #gboolean\n"
+#| " *\n"
+#| " * This is the best widget, ever.\n"
+#| " */\n"
+#| "typedef struct _FooWidget {\n"
+#| " /*< private >*/\n"
+#| " GtkWidget parent;\n"
+#| "\n"
+#| " /*< public >*/\n"
+#| " gboolean bar;\n"
+#| "} FooWidget;\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: some #gboolean\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: some #gboolean\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1261
+#: C/index.docbook:1219
msgid ""
"Use <code>/*< private >*/</code> before the private struct fields you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
"revertir el comportamiento anterior."
#. (itstool) path: sect2/para
-#: C/index.docbook:1267
+#: C/index.docbook:1225
msgid ""
"Struct comment blocks can also be used for GObjects and GObjectClasses. It "
"is usually a good idea to add a comment block for a class, if it has "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1279 C/index.docbook:1280
+#: C/index.docbook:1237 C/index.docbook:1238
msgid "Enum comment block"
msgstr "Enumerar bloques de comentarios"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1281
+#: C/index.docbook:1239
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "/**\n"
+#| " * Something:\n"
+#| " * @SOMETHING_FOO: something foo\n"
+#| " * @SOMETHING_BAR: something bar\n"
+#| " *\n"
+#| " * Enum values used for the thing, to specify the thing.\n"
+#| " */\n"
+#| "typedef enum {\n"
+#| " SOMETHING_FOO,\n"
+#| " SOMETHING_BAR,\n"
+#| " /*< private >*/\n"
+#| " SOMETHING_COUNT\n"
+#| "} Something;\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"/**\n"
" * Something:\n"
" * @SOMETHING_FOO: something foo\n"
" /*< private >*/\n"
" SOMETHING_COUNT\n"
"} Something;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * Something:\n"
" * @SOMETHING_FOO: something foo\n"
" /*< private >*/\n"
" SOMETHING_COUNT\n"
"} Something;\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1300
+#: C/index.docbook:1256
msgid ""
"Use <code>/*< private >*/</code> before the private enum values you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
"comportamiento anterior."
#. (itstool) path: sect1/title
-#: C/index.docbook:1310
+#: C/index.docbook:1266
msgid "Useful DocBook tags"
msgstr "Etiquetas DocBook útiles"
#. (itstool) path: sect1/para
-#: C/index.docbook:1312
+#: C/index.docbook:1268
msgid ""
"Here are some DocBook tags which are most useful when documenting the code."
msgstr ""
"Aquí están varias etiquetas de DocBook muy útiles al documentar código."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1321
+#: C/index.docbook:1277
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1317
+#: C/index.docbook:1273
msgid ""
"To link to another section in the GTK docs: <_:informalexample-1/> The "
"linkend is the SGML/XML id on the top item of the page you want to link to. "
"ajustarse a SGML/XML."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1336
+#: C/index.docbook:1290
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<function>...</function>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1333
+#: C/index.docbook:1287
msgid ""
"To refer to an external function, e.g. a standard C function: <_:"
"informalexample-1/>"
"informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1347
+#: C/index.docbook:1299
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<example>\n"
+#| " <title>Using a GHashTable.</title>\n"
+#| " <programlisting>\n"
+#| " ...\n"
+#| " </programlisting>\n"
+#| "</example>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<example>\n"
" <title>Using a GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<example>\n"
" <title>Using a GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1360
+#: C/index.docbook:1310
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<informalexample>\n"
+#| " <programlisting>\n"
+#| " ...\n"
+#| " </programlisting>\n"
+#| "</informalexample>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1344
+#: C/index.docbook:1296
msgid ""
"To include example code: <_:informalexample-1/> or possibly this, for very "
"short code fragments which don't need a title: <_:informalexample-2/> For "
"informalexample-2/>. El último GTK-Doc también soporta abreviación: |[ ... ]|"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1381
+#: C/index.docbook:1329
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<itemizedlist>\n"
+#| " <listitem>\n"
+#| " <para>\n"
+#| " ...\n"
+#| " </para>\n"
+#| " </listitem>\n"
+#| " <listitem>\n"
+#| " <para>\n"
+#| " ...\n"
+#| " </para>\n"
+#| " </listitem>\n"
+#| "</itemizedlist>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1378
+#: C/index.docbook:1326
msgid "To include bulleted lists: <_:informalexample-1/>"
msgstr "Para incluir listas de topos: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1403
+#: C/index.docbook:1349
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<note>\n"
+#| " <para>\n"
+#| " Make sure you free the data after use.\n"
+#| " </para>\n"
+#| "</note>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
" Make sure you free the data after use.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
" Make sure you free the data after use.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1400
+#: C/index.docbook:1346
msgid ""
"To include a note which stands out from the text: <_:informalexample-1/>"
msgstr "Para incluir una nota que sobresale del texto: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1418
+#: C/index.docbook:1362
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<type>unsigned char</type>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<type>unsigned char</type>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<type>unsigned char</type>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1415
+#: C/index.docbook:1359
msgid "To refer to a type: <_:informalexample-1/>"
msgstr "Para referirse a un tipo: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1429
+#: C/index.docbook:1371
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<structname>XFontStruct</structname>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1426
+#: C/index.docbook:1368
msgid ""
"To refer to an external structure (not one described in the GTK docs): <_:"
"informalexample-1/>"
"de GTK): <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1440
+#: C/index.docbook:1380
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<structfield>len</structfield>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1437
+#: C/index.docbook:1377
msgid "To refer to a field of a structure: <_:informalexample-1/>"
msgstr "Para referirse a un campo o a una estructura: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1451
+#: C/index.docbook:1389
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<classname>GtkWidget</classname>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1448
+#: C/index.docbook:1386
msgid ""
"To refer to a class name, we could possibly use: <_:informalexample-1/> but "
"you'll probably be using #GtkWidget instead (to automatically create a link "
"\"documenting_syntax\">abreviaciones</link>)."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1464
+#: C/index.docbook:1400
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<emphasis>This is important</emphasis>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<emphasis>This is important</emphasis>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<emphasis>This is important</emphasis>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1461
+#: C/index.docbook:1397
msgid "To emphasize text: <_:informalexample-1/>"
msgstr "Para enfatizar un texto: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1475
+#: C/index.docbook:1409
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<filename>/home/user/documents</filename>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<filename>/home/user/documents</filename>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<filename>/home/user/documents</filename>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1472
+#: C/index.docbook:1406
msgid "For filenames use: <_:informalexample-1/>"
msgstr "Para uso de nombres de archivo: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1486
+#: C/index.docbook:1418
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1483
+#: C/index.docbook:1415
msgid "To refer to keys use: <_:informalexample-1/>"
msgstr "Para referirse a claves: <_:informalexample-1/>"
#. (itstool) path: chapter/title
-#: C/index.docbook:1498
+#: C/index.docbook:1428
msgid "Filling the extra files"
msgstr "Rellenar campos adicionales"
#. (itstool) path: chapter/para
-#: C/index.docbook:1500
+#: C/index.docbook:1430
msgid ""
"There are a couple of extra files, that need to be maintained along with the "
"inline source code comments: <filename><package>.types</filename>, "
"pasado) y <filename><paquete>-sections.txt</filename>."
#. (itstool) path: sect1/title
-#: C/index.docbook:1509
+#: C/index.docbook:1439
msgid "Editing the types file"
msgstr "Editar los tipos de archivo"
#. (itstool) path: sect1/para
-#: C/index.docbook:1511
+#: C/index.docbook:1441
msgid ""
"If your library or application includes GObjects, you want their signals, "
"arguments/parameters and position in the hierarchy to be shown in the "
"<filename><paquete>.types</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:1520
+#: C/index.docbook:1450
msgid "Example types file snippet"
msgstr "Fragmento de ejemplo de tipos de archivo"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1521
+#: C/index.docbook:1451
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "#include <gtk/gtk.h>\n"
+#| "\n"
+#| "gtk_accel_label_get_type\n"
+#| "gtk_adjustment_get_type\n"
+#| "gtk_alignment_get_type\n"
+#| "gtk_arrow_get_type\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1534
+#: C/index.docbook:1462
msgid ""
"Since GTK-Doc 1.8 <application>gtkdoc-scan</application> can generate this "
"list for you. Just add \"--rebuild-types\" to SCAN_OPTIONS in "
"los tipos de archivo ni tenerlos bajo el control de versiones."
#. (itstool) path: sect1/title
-#: C/index.docbook:1543
+#: C/index.docbook:1471
msgid "Editing the master document"
msgstr "Editar la sección maestra del documento"
#. (itstool) path: sect1/para
-#: C/index.docbook:1545
+#: C/index.docbook:1473
msgid ""
"GTK-Doc produces documentation in DocBook SGML/XML. When processing the "
"inline source comments, the GTK-Doc tools generate one documentation page "
"documento maestro las incluye y ordena."
#. (itstool) path: sect1/para
-#: C/index.docbook:1552
+#: C/index.docbook:1480
msgid ""
"While GTK-Doc creates a template master document for you, later run will not "
"touch it again. This means that one can freely structure the documentation. "
"vez en cuando para ver si se han introducido algunas mejoras."
#. (itstool) path: tip/para
-#: C/index.docbook:1562
+#: C/index.docbook:1490
msgid ""
"Do not create tutorials as extra documents. Just write extra chapters. The "
"benefit of directly embedding the tutorial for your library into the API "
"el tutorial junto con la biblioteca son mayores."
#. (itstool) path: sect1/para
-#: C/index.docbook:1571
+#: C/index.docbook:1499
msgid ""
"So what are the things to change inside the master document? For a start is "
"only a little. There are some placeholders (text in square brackets) there "
"que habría que encargarse."
#. (itstool) path: example/title
-#: C/index.docbook:1578
+#: C/index.docbook:1506
msgid "Master document header"
msgstr "Cabecera del documento maestro"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1579
+#: C/index.docbook:1507
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "<bookinfo>\n"
+#| " <title>MODULENAME Reference Manual</title>\n"
+#| " <releaseinfo>\n"
+#| " for MODULENAME [VERSION]\n"
+#| " The latest version of this documentation can be found on-line at\n"
+#| " <ulink role=\"online-location\" url=\"http://[SERVER]/MODULENAME/index.html\">http://[SERVER]/MODULENAME/</ulink>.\n"
+#| " </releaseinfo>\n"
+#| "</bookinfo>\n"
+#| "\n"
+#| "<chapter>\n"
+#| " <title>[Insert title here]</title>\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"<bookinfo>\n"
" <title>MODULENAME Reference Manual</title>\n"
" <releaseinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insert title here]</title>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<bookinfo>\n"
" <title>MODULENAME Reference Manual</title>\n"
" <releaseinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insert title here]</title>\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1600
+#: C/index.docbook:1526
msgid "Editing the section file"
msgstr "Editar el archivo de sección"
#. (itstool) path: sect1/para
-#: C/index.docbook:1602
+#: C/index.docbook:1528
msgid ""
"The section file is used to organise the documentation output by GTK-Doc. "
"Here one specifies which symbol belongs to which module or class and control "
"y el control de la visibilidad (pública o privada)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1608
+#: C/index.docbook:1534
msgid ""
"The section file is a plain text file with XML-like syntax (using tags). "
"Blank lines are ignored and lines starting with a '#' are treated as comment "
"comiencen con «#» se tratan como comentarios."
#. (itstool) path: sect1/para
-#: C/index.docbook:1614
+#: C/index.docbook:1540
msgid ""
"The <FILE> ... </FILE> tag is used to specify the file name, "
"without any suffix. For example, using '<FILE>gnome-config</"
"clase de GObject convertido a minúscula.)"
#. (itstool) path: sect1/para
-#: C/index.docbook:1626
+#: C/index.docbook:1552
msgid ""
"The <TITLE> ... </TITLE> tag is used to specify the title of the "
"section. It is only useful before the templates (if used) are initially "
"obsoleto."
#. (itstool) path: sect1/para
-#: C/index.docbook:1633
+#: C/index.docbook:1559
msgid ""
"You can group items in the section by using the <SUBSECTION> tag. "
"Currently it outputs a blank line between subsections in the synopsis "
"públicas (variables, vmethods)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1652
+#: C/index.docbook:1578
msgid ""
"You can also use <INCLUDE> ... </INCLUDE> to specify the "
"#include files which are shown in the synopsis sections. It contains a comma-"
"a esa sección."
#. (itstool) path: chapter/title
-#: C/index.docbook:1666
+#: C/index.docbook:1592
msgid "Controlling the result"
msgstr "Controlar el resultado"
#. (itstool) path: chapter/para
-#: C/index.docbook:1668
+#: C/index.docbook:1594
msgid ""
"A GTK-Doc run generates report files inside the documentation directory. The "
"generated files are named: <filename><package>-undocumented.txt</"
"archivos de texto plano y se pueden ver y posprocesar fácilmente."
#. (itstool) path: chapter/para
-#: C/index.docbook:1677
+#: C/index.docbook:1603
msgid ""
"The <filename><package>-undocumented.txt</filename> file starts with "
"the documentation coverage summary. Below are two sections divided by blank "
"documentación pero dónde; p.e. se ha añadido un parámetro nuevo."
#. (itstool) path: chapter/para
-#: C/index.docbook:1686
+#: C/index.docbook:1612
msgid ""
"The <filename><package>-undeclared.txt</filename> file lists symbols "
"given in the <filename><package>-sections.txt</filename> but not found "
"eliminado o no se han escrito correctamente."
#. (itstool) path: chapter/para
-#: C/index.docbook:1693
+#: C/index.docbook:1619
msgid ""
"The <filename><package>-unused.txt</filename> file lists symbol names, "
"where the GTK-Doc scanner has found documentation, but does not know where "
"todavía al archivo <filename><paquete>-sections.txt</filename>."
#. (itstool) path: tip/para
-#: C/index.docbook:1701
+#: C/index.docbook:1627
msgid ""
"Enable or add the <option>TESTS=$(GTKDOC_CHECK)</option> line in Makefile."
"am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during "
"de integridad durante la ejecución de make check."
#. (itstool) path: chapter/para
-#: C/index.docbook:1708
+#: C/index.docbook:1634
msgid ""
"One can also look at the files produced by the source code scanner: "
"<filename><package>-decl-list.txt</filename> and <filename><"
"si este archivo lo contiene."
#. (itstool) path: chapter/para
-#: C/index.docbook:1717
-#| msgid ""
-#| "If the project is GObject based, one can also look into the files "
-#| "produced by the object scanner: <filename><package>.args.txt</"
-#| "filename>, <filename><package>.hierarchy.txt</filename>, "
-#| "<filename><package>.interfaces.txt</filename>, <filename><"
-#| "package>.prerequisites.txt</filename> and <filename><package>."
-#| "signals.txt</filename>. If there are missing symbols in any of those, one "
-#| "can ask gtkdoc to keep the intermediate scanner file for further "
-#| "analysis, by running it as <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</"
-#| "command>."
+#: C/index.docbook:1643
msgid ""
"If the project is GObject based, one can also look into the files produced "
"by the object scanner: <filename><package>.args.txt</filename>, "
"ejecutándolo como <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
#. (itstool) path: chapter/title
-#: C/index.docbook:1732
+#: C/index.docbook:1658
msgid "Modernizing the documentation"
msgstr "Modernizar la documentación"
#. (itstool) path: chapter/para
-#: C/index.docbook:1734
+#: C/index.docbook:1660
msgid ""
"GTK-Doc has been around for quite some time. In this section we list new "
"features together with the version since when it is available."
"características nuevas junto con la versión desde la que están disponibles."
#. (itstool) path: sect1/title
-#: C/index.docbook:1740
+#: C/index.docbook:1666
msgid "GTK-Doc 1.9"
msgstr "GTK-Doc 1.9"
#. (itstool) path: sect1/para
-#: C/index.docbook:1742
-#| msgid ""
-#| "Is the new page xi:included from <filename><package>-docs.{xml,sgml}"
-#| "</filename>."
+#: C/index.docbook:1668
msgid ""
"When using xml instead of sgml, one can actually name the master document "
"<filename><package>-docs.xml</filename>."
"maestro <filename><paquete>-docs.xml</filename>."
#. (itstool) path: sect1/para
-#: C/index.docbook:1747
+#: C/index.docbook:1673
msgid ""
"This version supports <option>SCAN_OPTIONS=--rebuild-sections</option> in "
"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
"paquete>-decl-list.txt <paquete>-sections.txt</code>."
#. (itstool) path: sect1/para
-#: C/index.docbook:1758
+#: C/index.docbook:1684
msgid ""
"Version 1.8 already introduced the syntax for documenting sections in the "
"sources instead of the separate files under <filename class=\"directory"
"<filename>configure.ac</filename>."
#. (itstool) path: sect1/title
-#: C/index.docbook:1768
+#: C/index.docbook:1694
msgid "GTK-Doc 1.10"
msgstr "GTK-Doc 1.10"
#. (itstool) path: sect1/para
-#: C/index.docbook:1770
+#: C/index.docbook:1696
msgid ""
"This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in "
"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
"condicional."
#. (itstool) path: sect1/title
-#: C/index.docbook:1781
+#: C/index.docbook:1707
msgid "GTK-Doc 1.16"
msgstr "GTK-Doc 1.16"
#. (itstool) path: example/title
-#: C/index.docbook:1787
+#: C/index.docbook:1713
msgid "Enable gtkdoc-check"
msgstr "Activar gtkdoc-check"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1788
+#: C/index.docbook:1714
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "if ENABLE_GTK_DOC\n"
+#| "TESTS_ENVIRONMENT = \\\n"
+#| " DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
+#| " SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
+#| "TESTS = $(GTKDOC_CHECK)\n"
+#| "endif\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"if ENABLE_GTK_DOC\n"
"TESTS_ENVIRONMENT = \\\n"
" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
"TESTS = $(GTKDOC_CHECK)\n"
"endif\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"if ENABLE_GTK_DOC\n"
"TESTS_ENVIRONMENT = \\\n"
" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
"TESTS = $(GTKDOC_CHECK)\n"
"endif\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1783
+#: C/index.docbook:1709
msgid ""
"This version includes a new tool called gtkdoc-check. This tool can run a "
"set of sanity checks on your documentation. It is enabled by adding these "
"archivo <filename>Makefile.am</filename>. <_:example-1/>"
#. (itstool) path: sect1/title
-#: C/index.docbook:1803
+#: C/index.docbook:1727
msgid "GTK-Doc 1.20"
msgstr "GTK-Doc 1.20"
#. (itstool) path: sect1/para
-#: C/index.docbook:1805
+#: C/index.docbook:1729
msgid ""
"Version 1.18 brought some initial markdown support. Using markdown in doc "
"comments is less intrusive than writing docbook xml. This version improves a "
"comentarios</link> contiene todos los detalles."
#. (itstool) path: chapter/title
-#: C/index.docbook:1816
+#: C/index.docbook:1740
msgid "Documenting other interfaces"
msgstr "Documentar otras interfaces"
#. (itstool) path: chapter/para
-#: C/index.docbook:1818
+#: C/index.docbook:1742
msgid ""
"So far we have been using GTK-Doc to document the API of code. The next "
"sections contain suggestions how the tools can be used to document other "
"herramientas para documentar otras interfaces."
#. (itstool) path: sect1/title
-#: C/index.docbook:1825
+#: C/index.docbook:1749
msgid "Command line options and man pages"
msgstr "Opciones de la línea de comandos y páginas man"
#. (itstool) path: sect1/para
-#: C/index.docbook:1827
+#: C/index.docbook:1751
msgid ""
"As one can generate man pages for a docbook refentry as well, it sounds like "
"a good idea to use it for that purpose. This way the interface is part of "
"interfaz es parte de la referencia y se obtienen las páginas man sin trabajo."
#. (itstool) path: sect2/title
-#: C/index.docbook:1834
+#: C/index.docbook:1758
msgid "Document the tool"
msgstr "Documentar la herramienta"
#. (itstool) path: sect2/para
-#: C/index.docbook:1836
+#: C/index.docbook:1760
msgid ""
"Create one refentry file per tool. Following <link linkend="
"\"settingup_docfiles\">our example</link> we would call it <filename>meep/"
"así como los ejemplos en, por ejemplo, glib."
#. (itstool) path: sect2/title
-#: C/index.docbook:1846
+#: C/index.docbook:1770
msgid "Adding the extra configure check"
msgstr "Añadir la comprobación de configuración adicional"
#. (itstool) path: example/title
-#: C/index.docbook:1849 C/index.docbook:1869
+#: C/index.docbook:1773 C/index.docbook:1791
msgid "Extra configure checks"
msgstr "Comprobaciones de configuración adicionales"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1850
+#: C/index.docbook:1774
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "AC_ARG_ENABLE(man,\n"
+#| " [AC_HELP_STRING([--enable-man],\n"
+#| " [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
+#| " enable_man=no)\n"
+#| "\n"
+#| "AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
+#| "AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
#. (itstool) path: sect2/title
-#: C/index.docbook:1866
+#: C/index.docbook:1788
msgid "Adding the extra makefile rules"
msgstr "Añadir reglas de makefile adicionales"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1870
+#: C/index.docbook:1792
#, no-wrap
+#| msgid ""
+#| "\n"
+#| "\n"
+#| "man_MANS = \\\n"
+#| " meeper.1\n"
+#| "\n"
+#| "if ENABLE_GTK_DOC\n"
+#| "if ENABLE_MAN\n"
+#| "\n"
+#| "%.1 : %.xml\n"
+#| " @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<\n"
+#| "\n"
+#| "endif\n"
+#| "endif\n"
+#| "\n"
+#| "BUILT_EXTRA_DIST = $(man_MANS)\n"
+#| "EXTRA_DIST += meep.xml\n"
+#| "\n"
+#| " "
msgid ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1894
+#: C/index.docbook:1814
msgid "DBus interfaces"
msgstr "Interfaces de DBus"
#. (itstool) path: sect1/para
-#: C/index.docbook:1896
+#: C/index.docbook:1816
msgid ""
"(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://"
"cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
"cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
#. (itstool) path: chapter/title
-#: C/index.docbook:1905
+#: C/index.docbook:1825
msgid "Frequently asked questions"
msgstr "Preguntas más frecuentes"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1909
+#: C/index.docbook:1829
msgid "Question"
msgstr "Pregunta"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1910
+#: C/index.docbook:1830
msgid "Answer"
msgstr "Respuesta"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1912
+#: C/index.docbook:1832
msgid "No class hierarchy."
msgstr "Sin jerarquía de clases."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1913
+#: C/index.docbook:1833
msgid ""
"The objects <function>xxx_get_type()</function> function has not been "
"entered into the <filename><package>.types</filename> file."
"introducido en el archivo <filename><package>.types</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1919
+#: C/index.docbook:1839
msgid "Still no class hierarchy."
msgstr "Aún sin jerarquía de clases."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1920
+#: C/index.docbook:1840
msgid ""
"Missing or wrong naming in <filename><package>-sections.txt</filename> "
"file (see <ulink url=\"http://mail.gnome.org/archives/gtk-doc-list/2003-"
"doc-list/2003-October/msg00006.html\">explicación</ulink>)."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1926
+#: C/index.docbook:1846
msgid "Damn, I have still no class hierarchy."
msgstr "Maldición, aún no hay una jerarquía de clases."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1927
+#: C/index.docbook:1847
msgid ""
"Is the object name (name of the instance struct, e.g. <type>GtkWidget</"
"type>) part of the normal section (don't put this into Standard or Private "
"Estándar o Privado)."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1934
+#: C/index.docbook:1854
msgid "No symbol index."
msgstr "Sin índice de símbolos."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1935
+#: C/index.docbook:1855
msgid ""
"Does the <filename><package>-docs.{xml,sgml}</filename> contain a "
"index that xi:includes the generated index?"
"«xi:includes» el índice generado?"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1941
+#: C/index.docbook:1861
msgid "Symbols are not linked to their doc-section."
msgstr "Los símbolos no se enlazan con su sección en el documento."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1942
+#: C/index.docbook:1862
msgid ""
"Is the doc-comment using the correct markup (added #,% or ())? Check if the "
"gtkdoc-fixxref warns about unresolvable xrefs."
"si gtk-doc-fixxref avisa de alguna referencia xref sin resolver."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1948
+#: C/index.docbook:1868
msgid "A new class does not appear in the docs."
msgstr "Una clase nueva no aparece en la documentación."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1949
+#: C/index.docbook:1869
msgid ""
"Is the new page xi:included from <filename><package>-docs.{xml,sgml}</"
"filename>."
"sgml}</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1955
+#: C/index.docbook:1875
msgid "A new symbol does not appear in the docs."
msgstr "Un símbolo nuevo no aparece en la documentación."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1956
+#: C/index.docbook:1876
msgid ""
"Is the doc-comment properly formatted. Check for spelling mistakes in the "
"begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable "
"txt</filename> en una subsección pública."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1964
+#: C/index.docbook:1884
msgid "A type is missing from the class hierarchy."
msgstr "Falta un tipo en la clase de jerarquías"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1965
+#: C/index.docbook:1885
msgid ""
"If the type is listed in <filename><package>.hierarchy</filename> but "
"not in <filename>xml/tree_index.sgml</filename> then double check that the "
"privada."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1974
+#: C/index.docbook:1894
msgid "I get foldoc links for all gobject annotations."
msgstr ""
"Obtengo enlaces de seguimiento de documentos para todas las anotaciones "
"gobject."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1975
+#: C/index.docbook:1895
msgid ""
"Check that <filename>xml/annotation-glossary.xml</filename> is xi:included "
"from <filename><package>-docs.{xml,sgml}</filename>."
"included» desde <filename><package>-docs.{xml,sgml}</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1983
+#: C/index.docbook:1903
msgid "Parameter described in source code comment block but does not exist"
msgstr ""
"Parámetro descrito en el bloque de comentarios del código fuente pero no "
"existe"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1984
+#: C/index.docbook:1904
msgid ""
"Check if the prototype in the header has different parameter names as in the "
"source."
"diferentes de la fuente."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1989
+#: C/index.docbook:1909
msgid "multiple \"IDs\" for constraint linkend: XYZ"
msgstr "múltiples «ID» para la restricción enlazada: XYZ"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1990
+#: C/index.docbook:1910
msgid ""
"Symbol XYZ appears twice in <filename><package>-sections.txt</"
"filename> file."
"sections.txt</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1993
+#: C/index.docbook:1913
msgid ""
"Element typename in namespace '' encountered in para, but no template "
"matches."
"coincide."
#. (itstool) path: chapter/title
-#: C/index.docbook:2000
+#: C/index.docbook:1920
msgid "Tools related to gtk-doc"
msgstr "Herramientas relacionadas con GTK-Doc"
#. (itstool) path: chapter/para
-#: C/index.docbook:2002
+#: C/index.docbook:1922
msgid ""
"GtkDocPlugin - a <ulink url=\"http://trac-hacks.org/wiki/GtkDocPlugin\">Trac "
"GTK-Doc</ulink> integration plugin, that adds API docs to a trac site and "
"a un sitio «trac» y se integra con la búsqueda de «trac»."
#. (itstool) path: chapter/para
-#: C/index.docbook:2007
+#: C/index.docbook:1927
msgid ""
"Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since "
"tags in the API to determine the minimum required version."
"libre que usted elija, como la <_:ulink-1/>, para permitir su uso en "
"software libre."
+#~ msgid ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink>"
+#~ msgstr ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel>: Este es el DocBook SGML DTD. "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
+#~ "SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
+#~ "\"http\">http://www.jclark.com/jade</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Jade v1.1</guilabel>: Este es el procesador DSSSL para "
+#~ "convertir SGML a varios formatos. <ulink url=\"http://www.jclark.com/jade"
+#~ "\" type=\"http\">http://www.jclark.com/jade</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code "
+#~ "to convert DocBook to HTML (and a few other formats). It's used together "
+#~ "with jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to "
+#~ "colour the program code listings/declarations, and to support global "
+#~ "cross-reference indices in the generated HTML. <ulink url=\"http://nwalsh."
+#~ "com/docbook/dsssl\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Hojas de estilo DocBook modulares:</guilabel> Éste es el código "
+#~ "DSSSL para convertir DocBook a HTML (y otros cuantos formatos). Se usa "
+#~ "junto con jade. El código DSSSL está algo personalizado, en GTK-Doc dsl, "
+#~ "para colorear el código de listas/declaraciones del programa y soportar "
+#~ "índices de referencias cruzadas globales en el HTML generado. <ulink url="
+#~ "\"http://nwalsh.com/docbook/dsssl\" type=\"http\">http://nwalsh.com/"
+#~ "docbook/dsssl</ulink>."
+
+#~ msgid ""
+#~ "<guilabel>docbook-to-man</guilabel> - if you want to create man pages "
+#~ "from the DocBook. I've customized the 'translation spec' slightly, to "
+#~ "capitalise section headings and add the 'GTK Library' title at the top of "
+#~ "the pages and the revision date at the bottom. There is a link to this on "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink> NOTE: This does not work yet."
+#~ msgstr ""
+#~ "<guilabel>docbook-to-man</guilabel>: Si quiere crear páginas man desde el "
+#~ "DocBook. «translation spec» se ha personalizado un poco para capitalizar "
+#~ "la sección de cabeceras y añadir un título de «Biblioteca GTK» en la "
+#~ "parte superior de las páginas y la fecha de revisión al final. Existe un "
+#~ "enlace acerca de esto en <ulink url=\"http://www.ora.com/davenport\" type="
+#~ "\"http\">http://www.ora.com/davenport</ulink>. NOTA: Esto aún no funciona."
+
+#~ msgid "Installation"
+#~ msgstr "Instalación"
+
+#~ msgid ""
+#~ "There is no standard place where the DocBook Modular Stylesheets are "
+#~ "installed."
+#~ msgstr ""
+#~ "No existe ningún sitio estándar donde se instalan las hojas de estilo "
+#~ "modulares de DocBook."
+
+#~ msgid ""
+#~ "GTK-Doc's configure script searches these 3 directories automatically:"
+#~ msgstr ""
+#~ "El script de configuración de GTK-Doc busca estas tres carpetas "
+#~ "automáticamente:"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
+#~ "RedHat)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado "
+#~ "por RedHat)"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado por "
+#~ "Debian)"
+
+#~ msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
+#~ msgstr "<filename> /usr/share/sgml/docbkdsl </filename> (usado por SuSE)"
+
+#~ msgid ""
+#~ "If you have the stylesheets installed somewhere else, you need to "
+#~ "configure GTK-Doc using the option: <command> --with-dsssl-dir=<"
+#~ "PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+#~ msgstr ""
+#~ "Si tiene las hojas de estilo instaladas en algún otro sitio, deberá "
+#~ "configurar GTK-Doc usando la opción: <command> --with-dsssl-dir=<"
+#~ "RUTA_A_LA_CARPETA_DE_NIVEL_SUPERIOR_DE_LAS_HOJAS_DE_ESTILO> </command>"
+
+#~ msgid "1.18.1"
+#~ msgstr "1.18.1"
+
+#~ msgid ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identifier:\n"
+#~ " *\n"
+#~ " * documentation ...\n"
+#~ " *\n"
+#~ " * # Sub heading #\n"
+#~ " *\n"
+#~ " * more documentation:\n"
+#~ " * - list item 1\n"
+#~ " * - list item 2\n"
+#~ " *\n"
+#~ " * Even more docs.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+#~ msgstr ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identifier:\n"
+#~ " *\n"
+#~ " * documentation ...\n"
+#~ " *\n"
+#~ " * # Sub heading #\n"
+#~ " *\n"
+#~ " * more documentation:\n"
+#~ " * - list item 1\n"
+#~ " * - list item 2\n"
+#~ " *\n"
+#~ " * Even more docs.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+
+#~| msgid ""
+#~| "Since GTK-Doc-1.18 the tool supports a subset of the <ulink url=\"http://"
+#~| "daringfireball.net/projects/markdown/\">markdown language</ulink>. One "
+#~| "can use it for sub-headings and simple itemized lists. On older GTK-Doc "
+#~| "versions the content will be rendered as it (the list items will appear "
+#~| "in one line separated by dashes). <_:example-1/>"
+#~ msgid ""
+#~ "Since GTK-Doc-1.18 the tool supports a subset of the <ulink url=\"http://"
+#~ "daringfireball.net/projects/markdown/\">markdown language</ulink>. The "
+#~ "support has improved a lot with version 1.20. On older GTK-Doc versions "
+#~ "the content will be rendered as it (the list items will appear in one "
+#~ "line separated by dashes). <_:example-1/>"
+#~ msgstr ""
+#~ "Desde GTK-Doc-1.18 la herramienta soporta un subconjunto de <ulink url="
+#~ "\"http://daringfireball.net/projects/markdown/\">lenguajes de marcado</"
+#~ "ulink>. En la versión 1.20 se ha mejorado ucho este soporte. En versiones "
+#~ "más antiguas de GTK-Doc el contenido se puede renderizar como tal (la "
+#~ "lista de elementos aparecerá en una línea separada por guiones). <_:"
+#~ "example-1/>"
+
#~ msgid ""
#~ "You may also want to enable GTK-Doc for the distcheck make target. Just "
#~ "add the one line shown in the next example to your top-level "
<book id="index" lang="es">
<bookinfo>
<title>Manual de GTK-Doc</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>Manual del usuario para desarrolladores con instrucciones del uso de GTK-Doc.</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author><firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
</authorgroup>
<publisher role="maintainer"><publishername>Proyecto GTK-Doc</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth and Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright><year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder></copyright>
<!-- translators: uncomment this:
<copyright>
</legalnotice>
<revhistory>
- <revision><revnumber>1.19.1</revnumber> <date>05 de junio de 2013</date> <authorinitials>ss</authorinitials> <revremark>versión de desarrollo</revremark></revision>
+ <revision><revnumber>1.20.1</revnumber> <date>16 de febrero de 2014</date> <authorinitials>ss</authorinitials> <revremark>versión de desarrollo</revremark></revision>
+ <revision><revnumber>1.20</revnumber> <date>16 de febrero de 2014</date> <authorinitials>ss</authorinitials> <revremark>errores corregidos, soporte de marcado, mejoras en los estilos</revremark></revision>
<revision><revnumber>1.19</revnumber> <date>05 de junio de 2013</date> <authorinitials>ss</authorinitials> <revremark>correcciones de errores</revremark></revision>
<revision><revnumber>1.18</revnumber> <date>14 de septiembre de 2011</date> <authorinitials>ss</authorinitials> <revremark>correcciones de errores, mejoras en la velocidad y soporte de marcado</revremark></revision>
<revision><revnumber>1.17</revnumber> <date>26 de febrero de 2011</date> <authorinitials>sk</authorinitials> <revremark>actualización urgente de corrección de error</revremark></revision>
<sect2 id="requirements">
<title>Requerimientos</title>
<para><guilabel>Perl v5</guilabel>: los scripts principales están en Perl.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel>: Este es el DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel>: Este es el procesador DSSSL para convertir SGML a varios formatos. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Hojas de estilo DocBook modulares:</guilabel> Éste es el código DSSSL para convertir DocBook a HTML (y otros cuantos formatos). Se usa junto con jade. El código DSSSL está algo personalizado, en GTK-Doc dsl, para colorear el código de listas/declaraciones del programa y soportar índices de referencias cruzadas globales en el HTML generado. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>.</para>
- <para><guilabel>docbook-to-man</guilabel>: Si quiere crear páginas man desde el DocBook. «translation spec» se ha personalizado un poco para capitalizar la sección de cabeceras y añadir un título de «Biblioteca GTK» en la parte superior de las páginas y la fecha de revisión al final. Existe un enlace acerca de esto en <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>. NOTA: Esto aún no funciona.</para>
+ <para><guilabel>xsltproc</guilabel>: el procesador xslt de libxslt <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink></para>
+ <para><guilabel>docbook-xsl</guilabel>: las hojas de estilo XLS de docbook <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink></para>
+ <para><guilabel>Python</guilabel>: opcional, para gtkdoc-depscan</para>
+ <para>Una de <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> o <guilabel>vim</guilabel>: opcional, usada para el resaltado de sintaxis de los ejemplos.</para>
</sect2>
-
- <sect2 id="installation">
- <title>Instalación</title>
- <para>No existe ningún sitio estándar donde se instalan las hojas de estilo modulares de DocBook.</para>
- <para>El script de configuración de GTK-Doc busca estas tres carpetas automáticamente:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado por RedHat)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado por Debian)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (usado por SuSE)</para>
- <para>Si tiene las hojas de estilo instaladas en algún otro sitio, deberá configurar GTK-Doc usando la opción: <command> --with-dsssl-dir=<RUTA_A_LA_CARPETA_DE_NIVEL_SUPERIOR_DE_LAS_HOJAS_DE_ESTILO> </command></para>
- </sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>Acerca de GTK-Doc</title>
<para>(ARRÉGLAME)</para>
- <para>(Historia, autores, páginas web, licencias, planes futuros, comparación con otros sistemas similares.)</para>
+ <para>(Historia, autores, páginas web, listas de correo, licencias, planes futuros, comparación con otros sistemas similares.)</para>
</sect1>
<para>Esto después aparecerá como se muestra debajo: <example><title>Ejemplo de estructura de carpetas</title>
<programlisting>
-
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+</programlisting>
</example></para>
</sect1>
<para>
<example><title>Integración con autoconf</title>
<programlisting>
-
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Esto requerirá que todos los desarrolladores tengan gtk-doc instalado. Si para su proyecto es correcto tener una configuración de construcción de api-doc opcional, puede resolver esto como sigue. Manténgalo como está, ya que gtkdocize busca en <function>GTK_DOC_CHECK</function> al inicio de la línea. <example><title>Mantener gtk-doc como opcional</title>
<programlisting>
-
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-
- </programlisting>
+</programlisting>
</example></para>
<para>El primer argumento se usa para comprobar gtkdocversion durante la configuración. El segundo, y opcional, argumento lo usa <application>gtkdocize</application>. La macro <symbol>GTK_DOC_CHECK</symbol> también añade diversas opciones de configuración:</para>
<para>
<example><title>Preparación para gtkdocize</title>
<programlisting>
-
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+</programlisting>
</example>
</para>
+ <para>Después de hacer los cambios en el <filename>configure.ac</filename> actualice el archivo <filename>configure</filename>. Esto se puede hacer volviendo a ejecutar <code>autoreconf -i</code> o <code>autogen.sh</code>.</para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Ejecutar gtkdocize desde autogen.sh</title>
<programlisting>
-
gtkdocize || exit 1
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>
<example><title>Ejecutar la construcción de la documentación</title>
<programlisting>
-
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Ahora puede apuntar su navegador a <filename>docs/reference/<paquete>/index.html</filename>. Sí, aún es un poco decepcionante. Pero espere, durante el siguiente capítulo aprenderá a rellenar las páginas con información.</para>
<para>
<example><title>Pasos de construcción de la documentación</title>
<programlisting>
-
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>El analizador puede manejar bien la mayoría de cabeceras de C. En el caso de recibir avisos del analizador que parecen casos especiales, puede sugerir a GTK-Doc que los omita. <example><title>Bloque de comentario de GTK-Doc</title>
<programlisting>
-
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-
- </programlisting>
+</programlisting>
</example></para>
<!-- -->
<para>Un comentario de varias líneas que comienza con un «*» adicional marca un bloque de documentación que GTK-Doc tools procesarán. <example><title>Bloque de comentario de GTK-Doc</title>
<programlisting>
-
/**
* identifier:
* documentation ...
*/
-
- </programlisting>
+</programlisting>
</example></para>
<para>El «identificador» es una línea con el nombre del elemento relacionado con el comentario. La sintaxis difiere un poco dependiendo del elemento. (Por hacer: añadir una tabla mostrando los identificadores)</para>
<para>Si necesita usar los caracteres especiales «<», «>», «()», «@», «%», o «#» en su documentación sin que GTK-Doc los cambie, puede usar las entidades XML «&lt;», «&gt;», «amp;lpar;», «amp;rpar;», «amp;commat;» «&percnt;» y «&num;» respectivamente o escaparlas con una contrabarra doble «\».</para>
</tip>
- <para>
- DocBook can do more than just links. One can also have lists,
- examples, headings, and images. As of version 1.20, the
- preferred way is to use a subset of the basic text formatting
- syntax called
- <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>.
- On older GTK-Doc versions any documentation that includes
- Markdown will be rendered as is. For example, list items will
- appear as lines starting with a dash.
- </para>
+ <para>DocBook puede crear algo más que enlaces. También se pueden tener listas, ejemplos, cabeceras e imágenes. En la versión 1.20, la manera prefefira de hacer esto es usando un subconjunto de la sintaxis básica de formateado de texto llamada <ulink url="http://daringfireball.net/projects/markdown/">Marcado</ulink>. En versiones anteriores de GTK-Doc, cualquier documentación que incluya marcado se renderizará como tal. Por ejemplo, los elementos de una lista aparecerán como líneas que empiezan con un guión.</para>
- <para>
- In older GTK-Doc releases, if you need support for additional
- formatting, you would need to enable the usage of docbook
- SGML/XML tags inside doc-comments by
- putting <option>--xml-mode</option> or
- <option>--sgml-mode</option> in the variable
- <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</filename>.
- </para>
+ <para>En versiones anteriores de GTK-Doc, si necesitaba soporte para formato adicional, necesitaba activar el uso de etiquetas SGML/XML dentro de comentarios en la documentación poniendo <option>--xml-mode</option> o <option>--sgml-mode</option> en la variable <symbol>MKDB_OPTIONS</symbol> dentro de <filename>Makefile.am</filename>.</para>
<para>
- <example><title>GTK-Doc comment block using Markdown</title>
+ <example><title>Bloque de comentario de GTK-Doc usando marcado</title>
<programlisting>
-<![CDATA[
/**
* identifier:
*
* [A link to the heading anchor above][heading-two]
*
* A C-language example:
- * |[<!-- language="C" -->
+ * |[<!-- language="C" -->
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+</programlisting>
</example>
</para>
- <para>
- More examples of what markdown tags are supported can be found in the
- <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.
- </para>
+ <para>Se pueden encontrar más ejemplos de las etiquetas de marcado soportadas en el <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">Manual de referencia de sintaxis de marcado de documentación de GTK+</ulink>.</para>
<tip>
<para>Tal y como se ha mencionado antes, la documentación anterior de GTK-Doc es para documentar la API pública .Por ello, no se puede escribir documentación para los símbolos estáticos. No obstante es una buena práctica comentar los símbolos. Esto ayuda a que otros entiendan su código. Por ello se recomienda comentarlos usando comentarios normales (sin el segundo «*» en la primera línea). Si la función, posteriormente, se debe hacer pública, todo lo que el programador debe hacer es añadir otro «*» en el bloque de comentario e introducir el nombre del símbolo en la parte derecha dentro del archivo de secciones.</para>
<para>
<example><title>Bloque de comentarios en una sección</title>
<programlisting>
-
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-
- </programlisting>
+</programlisting>
</example>
</para>
<example><title>Etiquetas generales</title>
<programlisting>
-
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<example><title>Bloque de comentario de función</title>
<programlisting>
-
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-
- </programlisting>
+</programlisting>
</example>
<variablelist><title>Etiquetas de funciones</title>
<example><title>Bloque de comentario de propiedad</title>
<programlisting>
-
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<example><title>Bloque de comentario de señal</title>
<programlisting>
-
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<sect2><title>Bloque de comentario de estructura</title>
<example><title>Bloque de comentario de estructura</title>
<programlisting>
-
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+</programlisting>
</example>
<para>Use <code>/*< private >*/</code> antes de campos de estructuras privadas que quiera ocultar. Use <code>/*< public >*/</code> para revertir el comportamiento anterior.</para>
<sect2><title>Enumerar bloques de comentarios</title>
<example><title>Enumerar bloques de comentarios</title>
<programlisting>
-
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-
- </programlisting>
+</programlisting>
</example>
<para>Use <code>/*< private >*/</code> antes de enumerar valores privados que quiera ocultar. Use <code>/*< public >*/</code> para revertir el comportamiento anterior.</para>
<para>Para enlazar otra sección en GTK docs: <informalexample>
<programlisting>
-
<link linkend="glib-Hash-Tables">Hash Tables</link>
-
- </programlisting>
+</programlisting>
</informalexample>. El enlace es el id SGML en el elemento superior de la página a la que quiere enlazar. Para la mayoría de las páginas esta es la parte («gtk», «gdk», «glib») y después el título de página («Tablas hash»). Para los widgets es simplemente el nombre de la clase. Los espacios y guiones bajos se convierten a «-» para ajustarse a SGML/XML.</para>
<para>Para referirse a una función externa, ej. una función de C estándar: <informalexample>
<programlisting>
-
<function>...</function>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para incluir un código de ejemplo: <informalexample>
<programlisting>
-
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-
- </programlisting>
+</programlisting>
</informalexample> o posiblemente este, para fragmentos de código muy cortos que no necesitan título: <informalexample>
<programlisting>
-
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-
- </programlisting>
+</programlisting>
</informalexample>. El último GTK-Doc también soporta abreviación: |[ ... ]|</para>
<para>Para incluir listas de topos: <informalexample>
<programlisting>
-
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para incluir una nota que sobresale del texto: <informalexample>
<programlisting>
-
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para referirse a un tipo: <informalexample>
<programlisting>
-
<type>unsigned char</type>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para referirse a una estructura externa (no una descrita en la documentación de GTK): <informalexample>
<programlisting>
-
<structname>XFontStruct</structname>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para referirse a un campo o a una estructura: <informalexample>
<programlisting>
-
<structfield>len</structfield>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para referirse a un nombre de clase, se podría usar: <informalexample>
<programlisting>
-
<classname>GtkWidget</classname>
-
- </programlisting>
+</programlisting>
</informalexample> pero probablemente estará usando #GtkWidget en su lugar (para crear automáticamente un enlace a la página GtkWidget; consulte <link linkend="documenting_syntax">abreviaciones</link>).</para>
<para>Para enfatizar un texto: <informalexample>
<programlisting>
-
<emphasis>This is important</emphasis>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para uso de nombres de archivo: <informalexample>
<programlisting>
-
<filename>/home/user/documents</filename>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para referirse a claves: <informalexample>
<programlisting>
-
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+</programlisting>
</informalexample></para>
</sect1>
<para>
<example><title>Fragmento de ejemplo de tipos de archivo</title>
<programlisting>
-
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>
<example><title>Cabecera del documento maestro</title>
<programlisting>
-
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Esta versión incluye una herramienta nueva llamada gtkdoc-check. Esta herramienta puede ejecutar una serie de comprobaciones de integridad de la documentación. Se activa añadiendo las siguientes líneas al final del archivo <filename>Makefile.am</filename>. <example><title>Activar gtkdoc-check</title>
<programlisting>
-
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-
- </programlisting>
+</programlisting>
</example></para>
</sect1>
<para>
<example><title>Comprobaciones de configuración adicionales</title>
<programlisting>
-
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Comprobaciones de configuración adicionales</title>
<programlisting>
-
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n!=1);\n"
+"Plural-Forms: nplurals=2; plural=n>1;\n"
#. Put one translator per line, in the form NAME <EMAIL>, YEAR1, YEAR2
msgctxt "_"
<book id="index" lang="fr">
<bookinfo>
<title>Manuel de GTK-Doc</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>Manuel utilisateur pour les développeurs contenant les instructions sur l'usage de GTK-Doc.</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author>
+ <firstname>Stefan</firstname>
+ <surname>Sauer (Kost)</surname>
+ <affiliation>
+ <address>
+ <email>ensonic@users.sf.net</email>
+ </address>
+ </affiliation>
+ </author>
</authorgroup>
<publisher role="maintainer"><publishername>Projet GTK-Doc</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth et Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright>
+ <year>2007-2014</year>
+ <holder>Stefan Sauer (Kost)</holder>
+ </copyright>
<!-- translators: uncomment this:
<copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>Pré-requis</title>
<para><guilabel>Perl v5</guilabel> - les principaux scripts sont écrits en Perl.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - ce sont les DTD DocBook SGML. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - c'est un moteur DSSSL pour convertir le SGML en divers formats. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modular DocBook Stylesheets</guilabel> - c'est le code DSSSL utilisé pour convertir de DocBook vers HTML (ainsi que quelques autres formats). Il est utilisé conjointement avec Jade. J'ai légèrement personnalisé le code DSSSL, dans gtk-doc.dsl, pour coloriser les listings de code du programme et les déclarations ainsi que pour prendre en charge les indices globaux des références croisées dans le HTML généré. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - si vous souhaitez créer des pages de manuel depuis DocBook. J'ai légèrement adapté les « spécifications de traduction » pour mettre en majuscule les en-têtes de section et pour ajouter le titre « GTK Library » en haut des pages et la date de révision en bas. Il y a un lien sur cela ici <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>. Note : cela ne fonctionne pas encore.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>Il n'y a pas d'emplacement standard pour l'installation des feuilles de styles modulaires de DocBook.</para>
- <para>Les scripts d'installation de GTK-Doc cherchent dans ces trois répertoires automatiquement :</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (utilisé par Red Hat)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (utilisé par Debian)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (utilisé par SuSE)</para>
- <para>Si les feuilles de styles sont installées autre part, vous devez configurer GTK-Doc en utilisant l'option : <command>--with-dsssl-dir=<CHEMIN_VERS_REPERTOIRE_RACINE_FEUILLES2STYLEs></command>.</para>
+ <para>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
+ </para>
+ <para>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
+ </para>
</sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>À propos de GTK-Doc</title>
<para>(À COMPLETER)</para>
- <para>(Historique, auteurs, pages Web, licence, projets futurs, comparaison avec des systèmes similaires.)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>Dans le répertoire racine de votre projet, créez les répertoires appelés docs/reference (de la même façon, vous pouvez avoir docs/help pour la documentation utilisateur). Il est recommandé de créer un autre sous-répertoire portant le nom du paquet de documentation. Pour les paquets qui contiennent seulement une bibliothèque, cette étape n'est pas nécessaire.</para>
<para>Cela peut ressembler à ce qui suit : <example><title>Exemple d'arborescence de répertoires</title>
- <programlisting>
-
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+]]></programlisting>
</example></para>
</sect1>
<para>
<example><title>Intégration avec autoconf</title>
- <programlisting>
-
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Cela impose à tous les développeurs d'installer gtk-doc. Si pour votre projet, vous pouvez avoir une configuration de construction api-doc optionnelle, vous pouvez résoudre ce problème comme ci-dessous. Ne le modifiez pas car gtkdocize recherche <function>GTK_DOC_CHECK</function> au début d'une ligne. <example><title>Laisser gtk-doc optionnel</title>
- <programlisting>
-
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-
- </programlisting>
+]]></programlisting>
</example></para>
<para>Le premier argument est utilisé pour vérifier le paramètre gtkdocversion au moment de la configuration. Le second, en option, est utilisé par <application>gtkdocize</application>. La macro <symbol>GTK_DOC_CHECK</symbol> ajoute également plusieurs drapeaux de configuration :</para>
<para>
<example><title>Préparation pour gtkdocize</title>
- <programlisting>
-
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Exécution de gtkdocize depuis autogen.sh</title>
- <programlisting>
-
+ <programlisting><![CDATA[
gtkdocize || exit 1
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>La première exécution de make génère plusieurs fichiers supplémentaires dans les répertoires de documentation (doc-directories). Les plus importants sont : <filename><paquet>.types</filename>, <filename><paquet>-docs.xml</filename> (anciennement .sgml), <filename><paquet>-sections.txt</filename>.</para>
<para>
<example><title>Lancement de la construction de la documentation</title>
- <programlisting>
-
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>Maintenant, vous pouvez saisir l'adresse <filename>docs/reference/<paquet>/index.html</filename> dans votre navigateur. Le résultat est encore un peu décevant mais le prochain chapitre va expliquer comment donner de la vie à ces pages.</para>
<para>
<example><title>Étapes de construction de la documentation</title>
- <programlisting>
-
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml
// xml files have changed
mkdir html
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
+cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-
- </programlisting>
+]]></programlisting>
</example>
</para>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>Commentaires de documentation</title>
<para>Un commentaire multi-ligne qui commence avec un symbole « * » supplémentaire indique un bloc de documentation qui sera traité par les outils GTK-Doc. <example><title>Bloc de commentaire GTK-Doc</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-
- </programlisting>
+]]></programlisting>
</example></para>
<para>L'« identifier » (identifiant) est une ligne contenant le nom de l'élément avec lequel le commentaire est lié. La syntaxe diffère légèrement en fonction de l'élément. (À FAIRE : ajouter un tableau montrant les identifiants)</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Bloc de commentaires de section</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : informations de stabilité)</para>
<example><title>Étiquettes générales</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Bloc de commentaires pour les fonctions</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Étiquettes de fonction</title>
<sect2><title>Bloc de commentaires pour les propriétés</title>
<example><title>Bloc de commentaires pour les propriétés</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</itemizedlist></para>
<example><title>Bloc de commentaires pour les signaux</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Bloc de commentaire pour les structures</title>
<example><title>Bloc de commentaire pour les structures</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
* This is the best widget, ever.
*/
typedef struct _FooWidget {
- /*< private >*/
+ /*< private >*/
GtkWidget parent;
- /*< public >*/
+ /*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+]]></programlisting>
</example>
<para>Utilisez <code>/*< private >*/</code> avant les champs de structures privées que vous voulez cacher. Utilisez <code>/*< public >*/</code> dans le cas contraire.</para>
<sect2><title>Bloc de commentaire pour les énumérations</title>
<example><title>Bloc de commentaire pour les énumérations</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>Utilisez <code>/*< private >*/</code> avant les valeurs d'énumérations privées que vous voulez cacher. Utilisez <code>/*< public >*/</code> dans le cas contraire.</para>
<para>Voici quelques balises DocBook très utiles pendant la conception de la documentation d'un code.</para>
<para>Pour créer un lien vers une autre section dans la documentation GTK : <informalexample>
- <programlisting>
-
-<link linkend="glib-Hash-Tables">Hash Tables</link>
-
- </programlisting>
+ <programlisting><![CDATA[
+<link linkend="glib-Hash-Tables">Hash Tables</link>
+]]></programlisting>
</informalexample> l'élément « linkend » est l'identifiant SGML/XML de l'élément le plus haut sur la page vers laquelle vous voulez pointer. Pour la plupart des pages, c'est en général la partie (« gtk », « gdk », « glib ») suivi du titre de la page (« Hash Tables »). Pour les éléments graphiques, c'est simplement le nom de la classe. Les espaces et les caractères de soulignement sont convertis en « - » pour être conforme au SGML/XML.</para>
<para>Pour faire référence à une fonction externe comme, par exemple, à une fonction C standard : <informalexample>
- <programlisting>
-
-<function>...</function>
-
- </programlisting>
+ <programlisting><![CDATA[
+<function>...</function>
+]]></programlisting>
</informalexample></para>
<para>Pour inclure des extraits de code : <informalexample>
- <programlisting>
-
-<example>
- <title>Using a GHashTable.</title>
- <programlisting>
+ <programlisting><![CDATA[
+<example>
+ <title>Using a GHashTable.</title>
+ <programlisting>
...
- </programlisting>
-</example>
-
- </programlisting>
+ </programlisting>
+</example>
+]]></programlisting>
</informalexample> ou ceci, pour des petits fragments de code qui ne nécessitent pas de titre : <informalexample>
- <programlisting>
-
-<informalexample>
- <programlisting>
+ <programlisting><![CDATA[
+<informalexample>
+ <programlisting>
...
- </programlisting>
-</informalexample>
-
- </programlisting>
+ </programlisting>
+</informalexample>
+]]></programlisting>
</informalexample> Pour ces derniers, GTK-Doc prend également en charge une abréviation : |[ ... ]|</para>
<para>Pour ajouter une liste à puces : <informalexample>
- <programlisting>
-
-<itemizedlist>
- <listitem>
- <para>
+ <programlisting><![CDATA[
+<itemizedlist>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
-</itemizedlist>
-
- </programlisting>
+ </para>
+ </listitem>
+</itemizedlist>
+]]></programlisting>
</informalexample></para>
<para>Pour ajouter une note de bas de page : <informalexample>
- <programlisting>
-
-<note>
- <para>
+ <programlisting><![CDATA[
+<note>
+ <para>
Make sure you free the data after use.
- </para>
-</note>
-
- </programlisting>
+ </para>
+</note>
+]]></programlisting>
</informalexample></para>
<para>Pour se référer à un type : <informalexample>
- <programlisting>
-
-<type>unsigned char</type>
-
- </programlisting>
+ <programlisting><![CDATA[
+<type>unsigned char</type>
+]]></programlisting>
</informalexample></para>
<para>Pour se référer à une structure externe (non décrite dans la documentation GTK) : <informalexample>
- <programlisting>
-
-<structname>XFontStruct</structname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structname>XFontStruct</structname>
+]]></programlisting>
</informalexample></para>
<para>Pour se référer à un champ d'une structure : <informalexample>
- <programlisting>
-
-<structfield>len</structfield>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structfield>len</structfield>
+]]></programlisting>
</informalexample></para>
<para>Pour se référer au nom d'une classe, il est possible d'utiliser : <informalexample>
- <programlisting>
-
-<classname>GtkWidget</classname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<classname>GtkWidget</classname>
+]]></programlisting>
</informalexample> mais vous utiliserez probablement #GtkWidget à la place (pour créer automatiquement un lien vers la page GtkWidget - consultez <link linkend="documenting_syntax">les raccourcis</link>).</para>
<para>Pour mettre en évidence un texte : <informalexample>
- <programlisting>
-
-<emphasis>This is important</emphasis>
-
- </programlisting>
+ <programlisting><![CDATA[
+<emphasis>This is important</emphasis>
+]]></programlisting>
</informalexample></para>
<para>Pour les noms de fichiers : <informalexample>
- <programlisting>
-
-<filename>/home/user/documents</filename>
-
- </programlisting>
+ <programlisting><![CDATA[
+<filename>/home/user/documents</filename>
+]]></programlisting>
</informalexample></para>
<para>Pour se référer à des touches : <informalexample>
- <programlisting>
-
-<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+ <programlisting><![CDATA[
+<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
+]]></programlisting>
</informalexample></para>
</sect1>
<para>
<example><title>Extrait d'un exemple de fichier « types »</title>
- <programlisting>
-
-#include <gtk/gtk.h>
+ <programlisting><![CDATA[
+#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>En-tête du document maître</title>
- <programlisting>
-
-<bookinfo>
- <title>MODULENAME Reference Manual</title>
- <releaseinfo>
+ <programlisting><![CDATA[
+<bookinfo>
+ <title>MODULENAME Reference Manual</title>
+ <releaseinfo>
for MODULENAME [VERSION]
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
- </releaseinfo>
-</bookinfo>
+ <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
+ </releaseinfo>
+</bookinfo>
-<chapter>
- <title>[Insert title here]</title>
-
- </programlisting>
+<chapter>
+ <title>[Insert title here]</title>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Contrôles « configure » supplémentaires</title>
- <programlisting>
-
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Contrôles « configure » supplémentaires</title>
- <programlisting>
-
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
if ENABLE_MAN
%.1 : %.xml
- @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+ @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
endif
endif
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="gu">
<bookinfo>
<title>GTK-Doc પુસ્તિકા</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>GTK-Doc વપરાશની સૂચનાઓ સાથે ડેવલપરો માટે વપરાશકર્તા પુસ્તિકા.</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>જરૂરિયાતો</title>
<para><guilabel>Perl v5</guilabel> - મુખ્ય સ્ક્રિપ્ટો એ Perl માં છે.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - આ DocBook SGML DTD છે. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - આ વિવિધ માળખાઓમાં SGML ને રૂપાંતર કરવા માટે DSSSL પ્રોસેસર છે. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modular DocBook Stylesheets</guilabel> આ DocBook ને HTML માં રૂપાંતરિત કરવા માટે DSSSL કોડ છે (અને થોડા બીજા બંધારણો). તે jade સાથે ભેગા વાપરેલ છે. મેં DSSSL કોડને કાર્યક્રમ કોડની યાદીઓ/ જાહેરાતોને રંગ આપવા માટે, અને ઉત્પન્ન થયેલ HTML માં વૈશ્ર્વિક પ્રતિનિર્દેશ સૂચિને આધાર આપવા માટે gtk-doc.dsl માં જરાક DSSSL કોડને વૈવિધ્યપૂર્ણ બનાવેલ છે. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - જો તમે DocBook માંથી મુખ્ય પાનાંઓને બનાવવાનું ઇચ્છતા હોય તો, મેં થોડુ 'translation spec' ને વૈવિધ્યપૂર્ણ બનાવેલ છે, વિભાગનાં શીર્ષકનાં મોટા અક્ષર કરવા માટે અને પાનાંઓના ઊંચે 'GTK Library' શીર્ષકને ઉમેરો અને નીચે પૂનરાવર્તિત તારીખને ઉમેરો. ત્યાં <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> પર આની કડી છે નોંધો: આ હજુ કામ કરતુ નથી.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>સ્થાપન</title>
- <para>ત્યાં મૂળભૂત સ્થાન નથી કે જ્યાં DocBook Modular Stylesheets એ સ્થાપિત થયેલ હોય.</para>
- <para>GTK-Doc ની રૂપરેખાંકિત સ્ક્રિપ્ટ એ આ 3 ડિરેક્ટરીઓને આપમેળે શોધે છે:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (RedHat દ્દારા વપરાયેલ છે)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (Debian દ્દારા વપરાયેલ છે)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (SuSE દ્દારા વપરાયેલ છે)</para>
- <para>જો તમે ગમે ત્યાં સ્ટાઇલશીટો સ્થાપિત કરેલ હોય તો, તમે વિકલ્પની મદદથી GTK-Doc ને રૂપરેખાંકિત કરવા માટે જરૂ છે, <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command></para>
+ <para>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
+ </para>
+ <para>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
+ </para>
</sect2>
-
- </sect1>
-
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
</sect1>
- -->
<sect1 id="aboutgtkdoc">
<title>GTK-Doc વિશે</title>
<para>(FIXME)</para>
- <para>(ઇતિહાસ, લેખકો, વેબ પાનાંઓ, લાઇસન્સ, ભવિષ્યનાં પ્લાનો, સરખી સિસ્ટમો સાથે સરખામણી.)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>autoconf સાથે એકત્રિકરણ</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>gtkdocize માટે તૈયારી</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>autogen.sh માંથી gtkdocize ને ચલાવી રહ્યા છે</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>દસ્તાવેજ બિલ્ડને ચલાવી રહ્યા છે</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>હવે તમે <filename>docs/reference/<package>/index.html</filename> માટે તમારા બ્રાઉઝર પર આંગળી ચીંધી શકો છો. હાં, તે થોડુ હજુ નિરાશ કરે તેવુ છે. પરંતુ આગળનામ વિષય માટે આપણે તને કહીએ છે કે જીદંગી સાથે પાનાંઓને કેવી રીતે ભરવા તે દરમ્યાન થોડા સમય માટે અટકી જાય છે</para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>દસ્તાવેજીકરણ નિયુક્તિ</title>
<para>
In the past most documentation had to be filled into files residing
- inside the <filename>tmpl</filename> directory. This has the
- disadvantages that the information is often not updated and also that
- the file tend to cause conflicts with version control systems.
+ inside the <filename>tmpl</filename> directory. This has the
+ disadvantages that the information is often not updated and also that
+ the file tend to cause conflicts with version control systems.
</para>
<para>
The avoid the aforementioned problems we suggest putting the
- documentation inside the sources. This manual will only describe this
- way of documenting code.
+ documentation inside the sources. This manual will only describe this
+ way of documenting code.
</para>
</note>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>વિભાગ ટિપ્પણી બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : સ્થિરતા જાણકારી)</para>
<example><title>સામાન્ય ટેગ</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>વિધેય ટિપ્પણી બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>વિધેય ટૅગો</title>
<sect2><title>ગુણધર્મ ટિપ્પણી બ્લોક</title>
<example><title>ગુણધર્મ ટિપ્પણી બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>સંકેત ટિપ્પણા બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct ટિપ્પણી બ્લોક</title>
<example><title>Struct ટિપ્પણી બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum ટિપ્પણી બ્લોક</title>
<example><title>Enum ટિપ્પણી બ્લોક</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>મુખ્ય દસ્તાવેજ મથાળુ</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="pt-BR">
<bookinfo>
<title>Manual do GTK-Doc</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>Manual de usuário para desenvolvedores com instruções do uso do GTK-Doc.</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author><firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
</authorgroup>
<publisher role="maintainer"><publishername>Projeto GTK-Doc</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth e Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright><year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder></copyright>
<!-- translators: uncomment this:
<copyright>
</legalnotice>
<revhistory>
- <revision><revnumber>1.19.1</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</authorinitials> <revremark>versão de desenvolvimento</revremark></revision>
+ <revision><revnumber>1.20.1</revnumber> <date>16 Fev 2014</date> <authorinitials>ss</authorinitials> <revremark>versão de desenvolvimento</revremark></revision>
+ <revision><revnumber>1.20</revnumber> <date>14 Fev 2014</date> <authorinitials>ss</authorinitials> <revremark>correção de erros, suporte a markdown, melhorias no estilo</revremark></revision>
<revision><revnumber>1.19</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</authorinitials> <revremark>correção de erros</revremark></revision>
<revision><revnumber>1.18</revnumber> <date>14 Set 2011</date> <authorinitials>ss</authorinitials> <revremark>correção de erros, aceleração, suporte a markdown</revremark></revision>
<revision><revnumber>1.17</revnumber> <date>26 Fev 2011</date> <authorinitials>sk</authorinitials> <revremark>atualização de correção de erro urgente</revremark></revision>
<year>2013</year>
+ <year>2014</year>
+
<holder>Rafael Ferreira</holder>
</copyright>
</bookinfo>
<sect2 id="requirements">
<title>Requisitos</title>
<para><guilabel>Perl v5</guilabel> - os scripts principais são Perl.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - Este é o DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - Este é um processador de DSSSL para conversão de SGML para vários formatos. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Folhas de estilo modulares do DocBook</guilabel> Este é o código DSSSL para converter DocBook para HTML (e alguns outros formatos). É usado junto com jade. Eu personalizei um pouco o código DSSSL, em gtk-doc.dsl, para colorir as listagens/declarações do código do programa e para dar suporte a índices de referências cruzadas globais nos HTML gerados. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - se você deseja criar páginas man a partir do DocBook. Eu personalizei um pouco a "especificação de tradução", para deixar o título em caixa alta e adicionar o título "GTK Library" no topo das páginas e a data de revisão no canto inferior. Há também um link para isso em <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>. NOTA: isso não funciona ainda.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>Instalação</title>
- <para>Não há um lugar padrão onde as folhas de estilos modulares de DocBook são instaladas.</para>
- <para>O script de configuração do GTK-DOC pesquisa por esses três diretórios automaticamente:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado pelo RedHat)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado pelo Debian)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (usado pelo SuSE)</para>
- <para>Se você tiver as folhas de estilos instaladas em algum lugar, você precisa configurar o Gtk-Doc usando a opção: <command> --with-dsssl-dir=<CAMINHO_PARA_DIRETÓRIO_RAIZ_DAS_FOLHAS_DE_ESTILO> </command></para>
+ <para><guilabel>xsltproc</guilabel> - o processador de xslt do libxslt <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink></para>
+ <para><guilabel>docbook-xsl</guilabel> - as folhas de estilo xsl de docbook <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink></para>
+ <para><guilabel>Python</guilabel> - opcional - para gtkdoc-depscan</para>
+ <para>Um dentre <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> ou <guilabel>vim</guilabel> - opcional - usado para destaque de sintaxe de exemplos</para>
</sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>Sobre GTK-Doc</title>
<para>(CORRIJA-ME)</para>
- <para>(História, autores, páginas web, licença, planos futuros, comparação com outros sistemas similares.)</para>
+ <para>(História, autores, páginas web, lista de discussão, licença, planos futuros, comparação com outros sistemas similares.)</para>
</sect1>
<para>Isto pode, então, parecer como exibido abaixo: <example><title>Exemplo de estrutura de diretórios</title>
<programlisting>
-
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+</programlisting>
</example></para>
</sect1>
<para>
<example><title>Integração com autoconf</title>
<programlisting>
-
-# check for gtk-doc
+# verifica por gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Isso vai exigir que todos os desenvolvedores tenham o gtk-doc instalado. Se não houver problema para seu projeto ter uma configuração opcional de compilação de documentação de API, você pode resolver isso como mostrado abaixo. Mantenha assim, pois o gtkdocize está procurando por <function>GTK_DOC_CHECK</function> no começo de uma linha. <example><title>Mantenha o gtk-doc como opcional</title>
<programlisting>
-
-# check for gtk-doc
+# verifica por gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-
- </programlisting>
+</programlisting>
</example></para>
<para>O primeiro argumento é usado para verificar a gtkdocversion em tempo de compilação. O segundo argumento é opcional, sendo usado por <application>gtkdocize</application>. A macro <symbol>GTK_DOC_CHECK</symbol> também adiciona várias opções de configuração:</para>
<para>
<example><title>Preparação para gtkdocize</title>
<programlisting>
-
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+</programlisting>
</example>
</para>
+ <para>Após todas as alterações do <filename>configure.ac</filename> serem feitas, atualize o arquivo <filename>configure</filename>. Isso pode ser feito executando novamente <code>autoreconf -i</code> ou <code>autogen.sh</code>.</para>
</sect1>
<sect1 id="settingup_automake">
<title>Integração com automake</title>
- <para>
- First copy the <filename>Makefile.am</filename> from the
- <filename class="directory">examples</filename> sub directory of the
- <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink>
- to your project's API documentation directory (
- <filename class="directory">./docs/reference/<package></filename>).
- A local copy should be available under e.g.
- <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>.
- If you have multiple doc-packages repeat this for each one.
- </para>
+ <para>Primeiro copie o <filename>Makefile.am</filename> dos subdiretório do <filename class="directory">exemplo</filename> do <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink> para o diretório de documentação da API do seu projeto ( <filename class="directory">./docs/reference/<pacote></filename>). Uma cópia local deveria estar disponível sob, por exemplo, <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>. Se você tiver múltiplos pacotes de documentação, repita isso para cada um.</para>
<para>A próxima etapa é editar as configurações dentro do <filename>Makefile.am</filename>. Todas as configurações tem um comentário em cima que descreve seu propósito. A maioria das configurações são opções extras passadas para as respectivas ferramentas. Cada ferramenta tem uma variável na forma <option><NOME-FERRAMENTA>_OPTIONS</option>. Todas as ferramentas têm suporte a <option>--help</option> pra listar os parâmetros disponíveis.</para>
<para>
<example><title>Executando gtkdocize no autogen.sh</title>
<programlisting>
-
gtkdocize || exit 1
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>
<example><title>Executando a compilação da documentação</title>
<programlisting>
-
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Agora você pode apontar seu navegador para <filename>docs/reference/<pacote>/index.html</filename>. Sim, é um pouco desapontador. Mas aguente aí, durante o próximo capítulo nós vamos dizer como você pode preencher as páginas com vida.</para>
<para>
<example><title>Etapas de compilação da documentação</title>
<programlisting>
-
DOC_MODULE=meep
// fontes foram alterados
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>A varredura sabe lidar com a maioria dos cabeçalhos de C sem problemas. Caso se receba avisos (warnings) na varredura que pareça ser um caso especial, pode-se informar ao GTK-Doc para ignorá-los. <example><title>Bloco de comentário do GTK-Doc</title>
<programlisting>
-
#ifndef __GTK_DOC_IGNORE__
/* código não analisável arqui */
#endif
-
- </programlisting>
+</programlisting>
</example></para>
<!-- -->
<para>Um comentário multilinha que começa com um "*" adicional marca um bloco de documentação que será processado pelas ferramentas do GTK-Doc. <example><title>Bloco de comentário do GTK-Doc</title>
<programlisting>
-
/**
* identificador:
* documentação ...
*/
-
- </programlisting>
+</programlisting>
</example></para>
<para>O "identificador" é uma linha com o nome do item ao qual o comentário está relacionado. A sintaxe difere um pouco dependendo do item.</para>
<para>Se você precisar usar os caracteres especiais "<", ">", "()", "@", "%" ou "#" em sua documentação sem GTK-Doc alterando-os, você pode usar as entidades XML "&lt;", "&gt;", "&lpar;", "&rpar;", "&commat;", "&percnt;" e "&num;", respectivamente, ou escapá-los com uma contrabarra "\".</para>
</tip>
- <para>
- DocBook can do more than just links. One can also have lists,
- examples, headings, and images. As of version 1.20, the
- preferred way is to use a subset of the basic text formatting
- syntax called
- <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>.
- On older GTK-Doc versions any documentation that includes
- Markdown will be rendered as is. For example, list items will
- appear as lines starting with a dash.
- </para>
+ <para>DocBook pode fazer mais do que apenas links. Ele também pode ter listas, exemplos, títulos e imagens. A partir da versão 1.20, a forma preferível é usar um subconjunto de sintaxe de formatação de texto básica chamada <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>. Em versões mais antigas do GTK-Doc, qualquer documentação que inclui Markdown será renderizada como está. Por exemplo, itens de lista aparecerão como linhas começando com um traço.</para>
- <para>
- In older GTK-Doc releases, if you need support for additional
- formatting, you would need to enable the usage of docbook
- SGML/XML tags inside doc-comments by
- putting <option>--xml-mode</option> or
- <option>--sgml-mode</option> in the variable
- <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</filename>.
- </para>
+ <para>Em versões mais antigas do GTK-Doc, se você precisasse de suporte para formatação adicional, você precisaria de habilitar o uso de tags de SGML/XML de docbook dentro de comentários de documentação colocando <option>--xml-mode</option> ou <option>--sgml-mode</option> na variável <symbol>MKDB_OPTIONS</symbol> dentro de <filename>Makefile.am</filename>.</para>
<para>
- <example><title>GTK-Doc comment block using Markdown</title>
+ <example><title>Bloco de comentário do GTK-Doc usando Markdown</title>
<programlisting>
-<
+ * Outro parágrafo. [Um link para o site do GNOME](http://www.gnome.org/)
*
- * ![an inline image][plot-result.png]
+ * ![uma imagem embutida][plot-result.png]
*
- * [A link to the heading anchor above][heading-two]
+ * [Um link para um título acima][titulo-dois]
*
- * A C-language example:
- * |[<!-- language="C" -->
- * GtkWidget *label = gtk_label_new ("Gorgeous!");
+ * Um exemplo em linguagem C:
+ * |[<!-- language="C" -->
+ * GtkWidget *label = gtk_label_new ("Esplêndido!");
* ]|
*/
-]]>
- </programlisting>
+</programlisting>
</example>
</para>
- <para>
- More examples of what markdown tags are supported can be found in the
- <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.
- </para>
+ <para>Mais exemplos do quais tags de markdown tags tem suporte pode ser encontrado na <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">Referência de sintaxe de markdown de documentação</ulink>.</para>
<tip>
<para>Como já mencionado anteriormente, GTK-Doc serve para documentar API pública. Portanto, não é possível escrever documentação para símbolos estáticos. Não obstante, é bom comentar estes símbolos também. Isso ajuda outros a entender seu código. Portanto, é recomendado comentá-los usando comentários normais (sem o segundo "*" na primeira linha). Se, posteriormente, a função precisar ser publicada, tudo que precisa ser feito é adicionar outro "*" no bloco de comentário e inserir o nome do símbolo no lugar correto do arquivo e seções.</para>
<para>
<example><title>Bloco de comentário de sessão</title>
<programlisting>
-
/**
* SECTION:meepapp
* @short_description: A classe do aplicativo
*
* A classe do aplicativo cuida de ...
*/
-
- </programlisting>
+</programlisting>
</example>
</para>
<example><title>Tags gerais</title>
<programlisting>
-
/**
* foo_get_bar:
* @foo: Um foo
foo_get_bar(Foo *foo)
{
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<example><title>Bloco de comentário de função</title>
<programlisting>
-
/**
* nome_da_função:
* @par1: descrição do parâmetro 1. Esta pode se estender por mais de
* @par2: descrição do parâmetro 2
* @...: uma lista de bars terminada em %NULL
*
- * A descrição vai aqui. Você pode usar @par1 para se referir a parâmetros
+ * A descrição da função vai aqui. Você pode usar @par1 para se referir a parâmetros
* de forma que eles ficam em destaque na saída. Você também pode usar %constant
* para constantes, nome_da_função2() para funções e #GtkWidget para links para
* outras declarações (que pode ser documentada em outro lugar).
* Since: 2.2
* Deprecated: 2.18: Use outra_função() em seu lugar.
*/
-
- </programlisting>
+</programlisting>
</example>
<variablelist><title>Tags de função</title>
<example><title>Bloco de comentário de propriedade</title>
<programlisting>
-
/**
* AlgumWidget:alguma-propriedade:
*
* Aqui você pode documentar uma propriedade.
*/
g_object_propriedade_install_classe (object_classe, PROP_ALGUMA_PROPRIEDADE, ...);
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<example><title>Bloco de comentário de sinal</title>
<programlisting>
-
/**
* FooWidget::foobarizado:
* @widget: o widget que recebeu o sinal
foo_sinais[FOOBARIZAR] =
g_signal_novo ("foobarizar",
...
-
- </programlisting>
+</programlisting>
</example>
</sect2>
<sect2><title>Bloco de comentário de struct</title>
<example><title>Bloco de comentário de struct</title>
<programlisting>
-
/**
* FooWidget:
* @bar: algum #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+</programlisting>
</example>
<para>Use <code>/*< private >*/</code> antes dos campos da struct privada que você deseja esconder. Use <code>/*< public >*/</code> para o comportamento inverso.</para>
<sect2><title>Bloco de comentário de enum</title>
<example><title>Bloco de comentário de enum</title>
<programlisting>
-
/**
* Alguma coisa:
* @ALGUMACOISA_FOO: alguma coisa foo
/*< private >*/
ALGUMACOISA_CONTAGEM
} Alguma coisa;
-
- </programlisting>
+</programlisting>
</example>
<para>Use <code>/*< private >*/</code> antes de valores privados de enum que você deseja ocultar. Use <code>/*< public >*/</code> para o comportamento inverso.</para>
<para>Aqui estão algumas tags de DocBook que são muito úteis quando se está documentado o código.</para>
- <para>PAra vincular a outra seção nas documentações do GTK: <informalexample>
+ <para>Para vincular a outra seção nas documentações do GTK: <informalexample>
<programlisting>
-
<link linkend="glib-Hash-Tables">Tabela de hashes</link>
-
- </programlisting>
+</programlisting>
</informalexample> O fim do link é o ID do SGML/XML no item superior da páginao a qual você deseja vincular. Para a maioria das páginas isto é atualmente a parte ("gtk", "gdk", "glib") e, então, o título da página ("Hash Tables"). Para os widgets isso é apenas o nome da classe. Espaços e sublinhados são convertidos em '-' para estar em conformidade com SGML/XML.</para>
<para>Para se referir a uma função externa, como, por exemplo, uma função padrão do C: <informalexample>
<programlisting>
-
<function>...</function>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para incluir um código de exemplo: <informalexample>
<programlisting>
-
<example>
<title>Usando uma GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-
- </programlisting>
+</programlisting>
</informalexample> ou possivelmente este, para fragmentos de código bem curtos que não precisam de um título: <informalexample>
<programlisting>
-
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-
- </programlisting>
+</programlisting>
</informalexample> Para este último, GTK-Doc também possui suporte a uma abreviação: |[ ... ]|</para>
<para>Para incluir listas com marcadores: <informalexample>
<programlisting>
-
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para incluir uma nota que fique fora do texto: <informalexample>
<programlisting>
-
<note>
<para>
Certifique-se de que você liberou os dados após usá-los.
</para>
</note>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para se referir a um tipo: <informalexample>
<programlisting>
-
<type>unsigned char</type>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para se referir a uma estrutura externa (não uma descrita nos documentos do GTK): <informalexample>
<programlisting>
-
<structname>XFontStruct</structname>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para se referir a um campo de uma estrutura: <informalexample>
<programlisting>
-
<structfield>len</structfield>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para se referir a um nome de classe, nós possivelmente poderíamos usar: <informalexample>
<programlisting>
-
<classname>GtkWidget</classname>
-
- </programlisting>
+</programlisting>
</informalexample> mas você provavelmente vai estar usando #GtkWidget em vez disso (para criar automaticamente um link para a página do GtkWidget - veja <link linkend="documenting_syntax">as abreviações</link>).</para>
<para>Para enfatizar um texto: <informalexample>
<programlisting>
-
<emphasis>Isso é importante</emphasis>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para nome de arquivos use: <informalexample>
<programlisting>
-
<filename>/home/usuario/documentos</filename>
-
- </programlisting>
+</programlisting>
</informalexample></para>
<para>Para se referir a chaves use: <informalexample>
<programlisting>
-
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+</programlisting>
</informalexample></para>
</sect1>
<para>
<example><title>Trecho de exemplo de arquivo de tipos</title>
<programlisting>
-
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>
<example><title>Cabeçalho do documento mestre</title>
<programlisting>
-
<bookinfo>
<title>Manual de referência do NOMEDOMÓDULO</title>
<releaseinfo>
<chapter>
<title>[Insira o título aqui]</title>
-
- </programlisting>
+</programlisting>
</example>
</para>
<para>Também pode-se buscar nos arquivos produzidos pela varredura do código aberto: <filename><pacote>-decl-list.txt</filename> e <filename><pacote>-decl.txt</filename>. O primeiro pode ser comparado com o arquivo de seção, se ele for mantido manualmente. O segundo lista todas as declarações de cabeçalhos. Se um símbolo está faltando, pode-se verificar se este arquivo o contém.</para>
- <para>
- If the project is GObject based, one can also look into the files produced
- by the object scanner:
- <filename><package>.args.txt</filename>,
- <filename><package>.hierarchy.txt</filename>,
- <filename><package>.interfaces.txt</filename>,
- <filename><package>.prerequisites.txt</filename> and
- <filename><package>.signals.txt</filename>. If there are missing
- symbols in any of those, one can ask GTK-Doc to keep the intermediate
- scanner file for further analysis, by running it as
- <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.
- </para>
+ <para>Se o projeto é baseado em GObject, pode-se também procurar nos arquivos produzidos pela varredura de objetos: <filename><pacote>.args.txt</filename>, <filename><pacote>.hierarchy.txt</filename>, <filename><pacote>.interfaces.txt</filename>, <filename><pacote>.prerequisites.txt</filename> e <filename><pacote>.signals.txt</filename>. Se há símbolos faltando em qualquer um deles, pode-se exigir que o GTK-Doc mantenha o arquivo intermediário de varredura para análise posterior, executando <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.</para>
</chapter>
<chapter id="modernizing">
- <title>Modernizing the documentation</title>
+ <title>Modernizando a documentação</title>
- <para>
- GTK-Doc has been around for quite some time. In this section we list new
- features together with the version since when it is available.
- </para>
+ <para>GTK-Doc está por aí já faz um tempo. Nesta seção, nós listamos novas funcionalidades juntamente da versão desde a qual está disponível.</para>
<sect1 id="modernizing-gtk-doc-1-9">
<title>GTK-Doc 1.9</title>
- <para>
- When using xml instead of sgml, one can actually name the master
- document <filename><package>-docs.xml</filename>.
- </para>
+ <para>Ao usar xml em vez de sgml, na verdade, é possível nomear o documento mestre <filename><pacote>-docs.xml</filename>.</para>
- <para>
- This version supports <option>SCAN_OPTIONS=--rebuild-sections</option>
- in <filename>Makefile.am</filename>. When this is enabled, the
- <filename><package>-sections.txt</filename> is autogenerated and
- can be removed from the vcs. This only works nicely for projects that
- have a very regular structure (e.g. each .{c,h} pair will create new
- section). If one organize a project close to that updating a manually
- maintained section file can be as simple as running
- <code>meld <package>-decl-list.txt <package>-sections.txt</code>.
- </para>
+ <para>Essa versão provê suporte <option>SCAN_OPTIONS=--rebuild-sections</option> em <filename>Makefile.am</filename>. Quando esta opção está habilitada, o <filename><package>-sections.txt</filename> é auto-gerado e pode ser removido a partir do VCS. Isso só funciona corretamente para projetos que têm uma estrutura muito regular (ex.: cada par .{c,h} vai criar uma nova seção). Se uma pessoa organiza um projeto próximo a isso atualizando um arquivo de seção mantido manualmente pode ser tão simples quanto executando <code>meld <package>-decl-list.txt <package>-sections.txt</code>.</para>
- <para>
- Version 1.8 already introduced the syntax for documenting sections in
- the sources instead of the separate files under <filename class="directory">tmpl</filename>.
- This version adds options to switch the whole doc module to not use the
- extra tmpl build step at all, by using <option>--flavour no-tmpl</option>
- in <filename>configure.ac</filename>.
- </para>
+ <para>A versão 1.8 já introduziu a sintaxe para documentação seções nos fontes em vez dos arquivos separados sob <filename class="directory">tmpl</filename>. Essa versão adiciona opções para alternar todo o módulo de documentação para não usar a etapa de compilação extra do tmpl, usando <option>--flavour no-tmpl</option> no <filename>configure.ac</filename>.</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-10">
<title>GTK-Doc 1.10</title>
- <para>
- This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in
- <filename>Makefile.am</filename>. When this is enabled, the
- <filename><package>.types</filename> is autogenerated and can be
- removed from the vcs. When using this feature it is important to also
- setup the <varname>IGNORE_HFILES</varname> in
- <filename>Makefile.am</filename> for code that is build conditionally.
- </para>
+ <para>Essa versão provê suporte <option>SCAN_OPTIONS=--rebuild-types</option> no <filename>Makefile.am</filename>. Quando isso está habilitado, o <filename><package>.types</filename> é auto-gerado e pode ser removido do VCS. Quando usando essa funcionalidade é importante também configurar o <varname>IGNORE_HFILES</varname> no <filename>Makefile.am</filename> para código que é compilado condicionalmente.</para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-16">
<title>GTK-Doc 1.16</title>
- <para>
- This version includes a new tool called gtkdoc-check. This tool can run
- a set of sanity checks on your documentation. It is enabled by adding
- these lines to the end of <filename>Makefile.am</filename>.
- <example><title>Enable gtkdoc-check</title>
+ <para>Essa versão inclui uma nova ferramenta chamada gtkdoc-check. Essa ferramenta pode executar um conjunto de verificações de sanidade na sua documentação. Ela é habilitada adicionando essas linhas ao final do <filename>Makefile.am</filename>. <example><title>Habilitar gtkdoc-check</title>
<programlisting>
-<![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
- </example>
- </para>
+</programlisting>
+ </example></para>
</sect1>
<sect1 id="modernizing-gtk-doc-1-20">
<title>GTK-Doc 1.20</title>
- <para>
- Version 1.18 brought some initial markdown support. Using markdown in
- doc comments is less intrusive than writing docbook xml. This version
- improves a lot on this and add a lot more styles. The section that
- explains the <link linkend="documenting_syntax">comment syntax</link>
- has all the details.
- </para>
+ <para>A versão 1.18 trouxe algum suporte inicial a markdown. O uso de markdown em comentários de documentação é menos intrusiva do que escrever xml de docbook. Essa versão melhora em muito nisso e adiciona muito mais estilos. A seção que explica a <link linkend="documenting_syntax">sintaxe de comentário</link> tem todos os detalhes.</para>
</sect1>
</chapter>
<para>
<example><title>Verificações extra no configure</title>
<programlisting>
-
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Verificações extra no configure</title>
<programlisting>
-
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-
- </programlisting>
+</programlisting>
</example>
</para>
</sect2>
# Brazilian Portuguese translation for gtk-doc help.
-# Copyright (C) 2013 gtk-doc's COPYRIGHT HOLDER
+# Copyright (C) 2014 gtk-doc's COPYRIGHT HOLDER
# This file is distributed under the same license as the gtk-doc package.
# Marcelo Rodrigues <marcelopires@mmsantos.com.br>, 2010.
-# Rafael Ferreira <rafael.f.f1@gmail.com>, 2013.
+# Rafael Ferreira <rafael.f.f1@gmail.com>, 2013, 2014.
#
msgid ""
msgstr ""
"Project-Id-Version: gtk-doc help\n"
-"POT-Creation-Date: 2013-12-08 20:11+0000\n"
-"PO-Revision-Date: 2013-12-10 03:27-0300\n"
+"Report-Msgid-Bugs-To: http://bugzilla.gnome.org/enter_bug.cgi?"
+"product=gtk-doc&keywords=I18N+L10N&component=general\n"
+"POT-Creation-Date: 2014-04-10 09:36+0000\n"
+"PO-Revision-Date: 2014-04-11 02:48-0300\n"
"Last-Translator: Rafael Ferreira <rafael.f.f1@gmail.com>\n"
"Language-Team: Brazilian Portuguese <gnome-pt_br-list@gnome.org>\n"
"Language: pt_BR\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
-"X-Generator: Poedit 1.5.7\n"
+"X-Generator: Poedit 1.6.4\n"
#. Put one translator per line, in the form NAME <EMAIL>, YEAR1, YEAR2
msgctxt "_"
msgid "translator-credits"
msgstr ""
"Marcelo Rodrigues <marcelopires@mmsantos.com.br>, 2010\n"
-"Rafael Ferreira <rafael.f.f1@gmail.com>, 2013"
+"Rafael Ferreira <rafael.f.f1@gmail.com>, 2013, 2014"
#. (itstool) path: bookinfo/title
#: C/index.docbook:12
#. (itstool) path: bookinfo/edition
#: C/index.docbook:13
-msgid "1.18.1"
-msgstr "1.18.1"
+msgid "1.20"
+msgstr "1.20"
#. (itstool) path: abstract/para
#: C/index.docbook:14
#. (itstool) path: authorgroup/author
#: C/index.docbook:34
msgid ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
msgstr ""
-"<firstname>Stefan</firstname> <surname>
Kost</surname> <affiliation> "
+"<firstname>Stefan</firstname> <surname>
Sauer (Kost)</surname> <affiliation> "
"<address> <email>ensonic@users.sf.net</email> </address> </affiliation>"
#. (itstool) path: publisher/publishername
#. (itstool) path: bookinfo/copyright
#: C/index.docbook:52
-msgid "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
-msgstr "<year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder>"
+msgid "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
+msgstr "<year>2007-2014</year> <holder>Stefan Sauer (Kost)</holder>"
#. (itstool) path: legalnotice/para
#: C/index.docbook:65
#. (itstool) path: revhistory/revision
#: C/index.docbook:83
msgid ""
-"<revnumber>1.
19.1</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
+"<revnumber>1.
20.1</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
"authorinitials> <revremark>development version</revremark>"
msgstr ""
-"<revnumber>1.
19.1</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
+"<revnumber>1.
20.1</revnumber> <date>16 Fev 2014</date> <authorinitials>ss</"
"authorinitials> <revremark>versão de desenvolvimento</revremark>"
#. (itstool) path: revhistory/revision
#: C/index.docbook:89
msgid ""
+"<revnumber>1.20</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</"
+"authorinitials> <revremark>bug fixes, markdown support, style improvements</"
+"revremark>"
+msgstr ""
+"<revnumber>1.20</revnumber> <date>14 Fev 2014</date> <authorinitials>ss</"
+"authorinitials> <revremark>correção de erros, suporte a markdown, melhorias "
+"no estilo</revremark>"
+
+#. (itstool) path: revhistory/revision
+#: C/index.docbook:95
+msgid ""
"<revnumber>1.19</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes</revremark>"
msgstr ""
"authorinitials> <revremark>correção de erros</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:95
+#: C/index.docbook:101
msgid ""
"<revnumber>1.18</revnumber> <date>14 Sep 2011</date> <authorinitials>ss</"
"authorinitials> <revremark>bug fixes, speedups, markdown support</revremark>"
"markdown</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:101
+#: C/index.docbook:107
msgid ""
"<revnumber>1.17</revnumber> <date>26 Feb 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>urgent bug fix update</revremark>"
"revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:107
+#: C/index.docbook:113
msgid ""
"<revnumber>1.16</revnumber> <date>14 Jan 2011</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes, layout improvements</revremark>"
"authorinitials> <revremark>correção de erros, melhorias no layout</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:113
+#: C/index.docbook:119
msgid ""
"<revnumber>1.15</revnumber> <date>21 May 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bug and regression fixes</revremark>"
"authorinitials> <revremark>correção de erros e regressões</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:119
+#: C/index.docbook:125
msgid ""
"<revnumber>1.14</revnumber> <date>28 March 2010</date> <authorinitials>sk</"
"authorinitials> <revremark>bugfixes and performance improvements</revremark>"
"revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:125
+#: C/index.docbook:131
msgid ""
"<revnumber>1.13</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>broken tarball update</"
"authorinitials> <revremark>atualização de tarball defeituoso</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:131
+#: C/index.docbook:137
msgid ""
"<revnumber>1.12</revnumber> <date>18 December 2009</date> "
"<authorinitials>sk</authorinitials> <revremark>new tool features and "
"erros</revremark>"
#. (itstool) path: revhistory/revision
-#: C/index.docbook:137
+#: C/index.docbook:143
msgid ""
"<revnumber>1.11</revnumber> <date>16 November 2008</date> "
"<authorinitials>mal</authorinitials> <revremark>GNOME doc-utils migration</"
"authorinitials> <revremark>Migração do GNOME doc-utils</revremark>"
#. (itstool) path: chapter/title
-#: C/index.docbook:150
+#: C/index.docbook:156
msgid "Introduction"
msgstr "Introdução"
#. (itstool) path: chapter/para
-#: C/index.docbook:152
+#: C/index.docbook:158
msgid ""
"This chapter introduces GTK-Doc and gives an overview of what it is and how "
"it is used."
"usado."
#. (itstool) path: sect1/title
-#: C/index.docbook:158
+#: C/index.docbook:164
msgid "What is GTK-Doc?"
msgstr "O que é GTK-Doc?"
#. (itstool) path: sect1/para
-#: C/index.docbook:160
+#: C/index.docbook:166
msgid ""
"GTK-Doc is used to document C code. It is typically used to document the "
"public API of libraries, such as the GTK+ and GNOME libraries. But it can "
"GNOME. Mas ele também pode ser usado para documentar código de aplicativos."
#. (itstool) path: sect1/title
-#: C/index.docbook:168
+#: C/index.docbook:174
msgid "How Does GTK-Doc Work?"
msgstr "Como o GTK-Doc funciona?"
#. (itstool) path: sect1/para
-#: C/index.docbook:170
+#: C/index.docbook:176
msgid ""
"GTK-Doc works by using documentation of functions placed inside the source "
"files in specially-formatted comment blocks, or documentation added to the "
"arquivos de cabeçalho; ele não irá produzir saída para funções estáticas)."
#. (itstool) path: sect1/para
-#: C/index.docbook:177
+#: C/index.docbook:183
msgid ""
"GTK-Doc consists of a number of perl scripts, each performing a different "
"step in the process."
"diferente no processo."
#. (itstool) path: sect1/para
-#: C/index.docbook:182
+#: C/index.docbook:188
msgid "There are 5 main steps in the process:"
msgstr "Há 5 etapas principais no processo:"
#. (itstool) path: listitem/para
-#: C/index.docbook:189
+#: C/index.docbook:195
msgid ""
"<guilabel>Writing the documentation.</guilabel> The author fills in the "
"source files with the documentation for each function, macro, union etc. (In "
"que não é mais recomendado)."
#. (itstool) path: listitem/para
-#: C/index.docbook:199
+#: C/index.docbook:205
msgid ""
"<guilabel>Gathering information about the code.</guilabel> "
"<application>gtkdoc-scan</application> scans the header files of the code "
"txt</filename> no <filename><módulo>-overrides.txt</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:216
+#: C/index.docbook:222
msgid ""
"<application>gtkdoc-scangobj</application> can also be used to dynamically "
"query a library about any GObject subclasses it exports. It saves "
"fornece."
#. (itstool) path: listitem/para
-#: C/index.docbook:222
+#: C/index.docbook:228
msgid ""
"<application>gtkdoc-scanobj</application> should not be used anymore. It was "
"needed in the past when GObject was still GtkObject inside gtk+."
"era necessário no passado, quando GObject ainda era GtkObject dentro do gtk+."
#. (itstool) path: listitem/para
-#: C/index.docbook:229
+#: C/index.docbook:235
msgid ""
"<guilabel>Generating the \"template\" files.</guilabel> <application>gtkdoc-"
"mktmpl</application> creates a number of files in the <filename class="
"tentar garantir que nenhuma documentação será perdida, jamais.)"
#. (itstool) path: note/para
-#: C/index.docbook:238
+#: C/index.docbook:244
msgid ""
"Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep "
"documentation in the code. <application>gtkdocize</application> supports now "
"remova o diretório (ex.: do sistema de controle de versão)."
#. (itstool) path: listitem/para
-#: C/index.docbook:250
+#: C/index.docbook:256
msgid ""
"<guilabel>Generating the SGML/XML and HTML/PDF.</guilabel> "
"<application>gtkdoc-mkdb</application> turns the template files into SGML or "
"introspecção e dos fontes. Nós recomendamos usar o Docbook XML."
#. (itstool) path: listitem/para
-#: C/index.docbook:261
+#: C/index.docbook:267
msgid ""
"<application>gtkdoc-mkhtml</application> turns the SGML/XML files into HTML "
"files in the <filename class=\"directory\">html/</filename> subdirectory. "
"pacote>.pdf</filename>."
#. (itstool) path: listitem/para
-#: C/index.docbook:267
+#: C/index.docbook:273
msgid ""
"Files in <filename class=\"directory\">sgml/</filename> or <filename class="
"\"directory\">xml/</filename> and <filename class=\"directory\">html/</"
"manualmente."
#. (itstool) path: listitem/para
-#: C/index.docbook:275
+#: C/index.docbook:281
msgid ""
"<guilabel>Fixing up cross-references between documents.</guilabel> After "
"installing the HTML files, <application>gtkdoc-fixxref</application> can be "
"volta para links locais (onde aquelas documentações estão instaladas)."
#. (itstool) path: sect1/title
-#: C/index.docbook:293
+#: C/index.docbook:299
msgid "Getting GTK-Doc"
msgstr "Obtendo GTK-Doc"
#. (itstool) path: sect2/title
-#: C/index.docbook:296
+#: C/index.docbook:302
msgid "Requirements"
msgstr "Requisitos"
#. (itstool) path: sect2/para
-#: C/index.docbook:297
+#: C/index.docbook:303
msgid "<guilabel>Perl v5</guilabel> - the main scripts are in Perl."
msgstr "<guilabel>Perl v5</guilabel> - os scripts principais são Perl."
#. (itstool) path: sect2/para
-#: C/index.docbook:300
+#: C/index.docbook:306
msgid ""
-"<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. <ulink "
-"url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel> - the xslt processor from libxslt <ulink url="
+"\"http://xmlsoft.org/XSLT/\" type=\"http\">xmlsoft.org/XSLT/</ulink>"
msgstr ""
-"<guilabel>DocBook DTD v3.0</guilabel> - Este é o DocBook SGML DTD. <ulink "
-"url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
-"davenport</ulink>"
+"<guilabel>xsltproc</guilabel> - o processador de xslt do libxslt <ulink url="
+"\"http://xmlsoft.org/XSLT/\" type=\"http\">xmlsoft.org/XSLT/</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:304
+#: C/index.docbook:310
msgid ""
-"<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
-"SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
-"\"http\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets <ulink url="
+"\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type=\"http"
+"\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
msgstr ""
-"<guilabel>Jade v1.1</guilabel> - Este é um processador de DSSSL para "
-"conversão de SGML para vários formatos. <ulink url=\"http://www.jclark.com/"
-"jade\" type=\"http\">http://www.jclark.com/jade</ulink>"
+"<guilabel>docbook-xsl</guilabel> - as folhas de estilo xsl de docbook <ulink "
+"url=\"http://sourceforge.net/projects/docbook/files/docbook-xsl/\" type="
+"\"http\">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>"
#. (itstool) path: sect2/para
-#: C/index.docbook:308
-msgid ""
-"<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code to "
-"convert DocBook to HTML (and a few other formats). It's used together with "
-"jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour the "
-"program code listings/declarations, and to support global cross-reference "
-"indices in the generated HTML. <ulink url=\"http://nwalsh.com/docbook/dsssl"
-"\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
-msgstr ""
-"<guilabel>Folhas de estilo modulares do DocBook</guilabel> Este é o código "
-"DSSSL para converter DocBook para HTML (e alguns outros formatos). É usado "
-"junto com jade. Eu personalizei um pouco o código DSSSL, em gtk-doc.dsl, "
-"para colorir as listagens/declarações do código do programa e para dar "
-"suporte a índices de referências cruzadas globais nos HTML gerados. <ulink "
-"url=\"http://nwalsh.com/docbook/dsssl\" type=\"http\">http://nwalsh.com/"
-"docbook/dsssl</ulink>"
+#: C/index.docbook:314
+msgid "<guilabel>Python</guilabel> - optional - for gtkdoc-depscan"
+msgstr "<guilabel>Python</guilabel> - opcional - para gtkdoc-depscan"
#. (itstool) path: sect2/para
#: C/index.docbook:317
msgid ""
-"<guilabel>docbook-to-man</guilabel> - if you want to create man pages from "
-"the DocBook. I've customized the 'translation spec' slightly, to capitalise "
-"section headings and add the 'GTK Library' title at the top of the pages and "
-"the revision date at the bottom. There is a link to this on <ulink url="
-"\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/davenport</"
-"ulink> NOTE: This does not work yet."
-msgstr ""
-"<guilabel>docbook-to-man</guilabel> - se você deseja criar páginas man a "
-"partir do DocBook. Eu personalizei um pouco a \"especificação de tradução\", "
-"para deixar o título em caixa alta e adicionar o título \"GTK Library\" no "
-"topo das páginas e a data de revisão no canto inferior. Há também um link "
-"para isso em <ulink url=\"http://www.ora.com/davenport\" type=\"http"
-"\">http://www.ora.com/davenport</ulink>. NOTA: isso não funciona ainda."
-
-#. (itstool) path: sect2/title
-#: C/index.docbook:328
-msgid "Installation"
-msgstr "Instalação"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:329
-msgid ""
-"There is no standard place where the DocBook Modular Stylesheets are "
-"installed."
-msgstr ""
-"Não há um lugar padrão onde as folhas de estilos modulares de DocBook são "
-"instaladas."
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:332
-msgid "GTK-Doc's configure script searches these 3 directories automatically:"
-msgstr ""
-"O script de configuração do GTK-DOC pesquisa por esses três diretórios "
-"automaticamente:"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:335
-msgid ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
-"RedHat)"
-msgstr ""
-"<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado pelo "
-"RedHat)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:338
-msgid ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
-msgstr ""
-"<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado pelo Debian)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:341
-msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
-msgstr "<filename> /usr/share/sgml/docbkdsl </filename> (usado pelo SuSE)"
-
-#. (itstool) path: sect2/para
-#: C/index.docbook:344
-msgid ""
-"If you have the stylesheets installed somewhere else, you need to configure "
-"GTK-Doc using the option: <command> --with-dsssl-dir=<"
-"PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+"One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> "
+"or <guilabel>vim</guilabel> - optional - used for syntax highlighting of "
+"examples"
msgstr ""
-"Se você tiver as folhas de estilos instaladas em algum lugar, você precisa "
-"configurar o Gtk-Doc usando a opção: <command> --with-dsssl-dir=<"
-"CAMINHO_PARA_DIRETÓRIO_RAIZ_DAS_FOLHAS_DE_ESTILO> </command>"
+"Um dentre <guilabel>source-highlight</guilabel>, <guilabel>highlight</"
+"guilabel> ou <guilabel>vim</guilabel> - opcional - usado para destaque de "
+"sintaxe de exemplos"
#. (itstool) path: sect1/title
-#: C/index.docbook:368
+#: C/index.docbook:325
msgid "About GTK-Doc"
msgstr "Sobre GTK-Doc"
#. (itstool) path: sect1/para
-#: C/index.docbook:370 C/index.docbook:384
+#: C/index.docbook:327 C/index.docbook:341
msgid "(FIXME)"
msgstr "(CORRIJA-ME)"
#. (itstool) path: sect1/para
-#: C/index.docbook:374
+#: C/index.docbook:331
msgid ""
-"(History, authors, web pages, license, future plans, comparison with other "
-"similar systems.)"
+"(History, authors, web pages, mailing list, license, future plans, "
+"comparison with other similar systems.)"
msgstr ""
-"(História, autores, páginas web, licença, planos futuros, comparação com "
-"outros sistemas similares.)"
+"(História, autores, páginas web, lista de discussão, licença, planos "
+"futuros, comparação com outros sistemas similares.)"
#. (itstool) path: sect1/title
-#: C/index.docbook:382
+#: C/index.docbook:339
msgid "About this Manual"
msgstr "Sobre este manual"
#. (itstool) path: sect1/para
-#: C/index.docbook:388
+#: C/index.docbook:345
msgid "(who it is meant for, where you can get it, license)"
msgstr "(pra quem ele serve, onde você pode obtê-lo, licença)"
#. (itstool) path: chapter/title
-#: C/index.docbook:397
+#: C/index.docbook:354
msgid "Setting up your project"
msgstr "Preparando seu projeto"
#. (itstool) path: chapter/para
-#: C/index.docbook:399
+#: C/index.docbook:356
msgid ""
"The next sections describe what steps to perform to integrate GTK-Doc into "
"your project. Theses sections assume we work on a project called 'meep'. "
"trabalhar em uma configuração de compilação diferente."
#. (itstool) path: sect1/title
-#: C/index.docbook:410
+#: C/index.docbook:367
msgid "Setting up a skeleton documentation"
msgstr "Preparando o esqueleto de uma documentação"
#. (itstool) path: sect1/para
-#: C/index.docbook:412
+#: C/index.docbook:369
msgid ""
"Under your top-level project directory create folders called docs/reference "
"(this way you can also have docs/help for end-user documentation). It is "
"obrigatória."
#. (itstool) path: example/title
-#: C/index.docbook:421
+#: C/index.docbook:378
msgid "Example directory structure"
msgstr "Exemplo de estrutura de diretórios"
#. (itstool) path: example/programlisting
-#: C/index.docbook:422
+#: C/index.docbook:379
#, no-wrap
msgid ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"meep/\n"
" docs/\n"
" reference/\n"
" src/\n"
" libmeep/\n"
" meeper/\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:419
+#: C/index.docbook:376
msgid "This can then look as shown below: <_:example-1/>"
msgstr "Isto pode, então, parecer como exibido abaixo: <_:example-1/>"
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:439 C/index.docbook:446
+#: C/index.docbook:394 C/index.docbook:401
msgid "Integration with autoconf"
msgstr "Integração com autoconf"
#. (itstool) path: sect1/para
-#: C/index.docbook:441
+#: C/index.docbook:396
msgid ""
"Very easy! Just add one line to your <filename>configure.ac</filename> "
"script."
"filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:447
+#: C/index.docbook:402
#, no-wrap
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
-"# check for gtk-doc\n"
+"# verifica por gtk-doc\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
-"\n"
-" "
#. (itstool) path: example/title
-#: C/index.docbook:461
+#: C/index.docbook:414
msgid "Keep gtk-doc optional"
msgstr "Mantenha o gtk-doc como opcional"
#. (itstool) path: example/programlisting
-#: C/index.docbook:462
+#: C/index.docbook:415
#, no-wrap
msgid ""
"\n"
-"\n"
"# check for gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
-"# check for gtk-doc\n"
+"# verifica por gtk-doc\n"
"m4_ifdef([GTK_DOC_CHECK], [\n"
"GTK_DOC_CHECK([1.14],[--flavour no-tmpl])\n"
"],[\n"
"AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n"
"])\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:456
+#: C/index.docbook:409
msgid ""
"This will require all developers to have gtk-doc installed. If it is okay "
"for your project to have optional api-doc build setup, you can solve this as "
"<function>GTK_DOC_CHECK</function> no começo de uma linha. <_:example-1/>"
#. (itstool) path: sect1/para
-#: C/index.docbook:475
+#: C/index.docbook:426
msgid ""
"The first argument is used to check for the gtkdocversion at configure time. "
"The 2nd, optional argument is used by <application>gtkdocize</application>. "
"também adiciona várias opções de configuração:"
#. (itstool) path: listitem/para
-#: C/index.docbook:481
+#: C/index.docbook:432
msgid "--with-html-dir=PATH : path to installed docs"
msgstr "--with-html-dir=CAMINHO : caminho para as documentações instaladas"
#. (itstool) path: listitem/para
-#: C/index.docbook:482
+#: C/index.docbook:433
msgid "--enable-gtk-doc : use gtk-doc to build documentation [default=no]"
msgstr "--enable-gtk-doc : usa gtk-doc para compilar documentação [padrão=no]"
#. (itstool) path: listitem/para
-#: C/index.docbook:483
+#: C/index.docbook:434
msgid ""
"--enable-gtk-doc-html : build documentation in html format [default=yes]"
msgstr ""
"--enable-gtk-doc-html : compila documentação em formato html [padrão=sim]"
#. (itstool) path: listitem/para
-#: C/index.docbook:484
+#: C/index.docbook:435
msgid "--enable-gtk-doc-pdf : build documentation in pdf format [default=no]"
msgstr ""
"--enable-gtk-doc-pdf : compila documentação em formato pdf [padrão=não]"
#. (itstool) path: important/para
-#: C/index.docbook:488
+#: C/index.docbook:439
msgid ""
"GTK-Doc is disabled by default! Remember to pass the option <option>'--"
"enable-gtk-doc'</option> to the next <filename>configure</filename> run. "
"que faz sentido para usuários, mas não para desenvolvedores)."
#. (itstool) path: sect1/para
-#: C/index.docbook:496
+#: C/index.docbook:447
msgid ""
"Furthermore it is recommended that you have the following line inside you "
"<filename>configure.ac</filename> script. This allows "
"macro para <function>GTK_DOC_CHECK</function> para o seu projeto."
#. (itstool) path: example/title
-#: C/index.docbook:504
+#: C/index.docbook:455
msgid "Preparation for gtkdocize"
msgstr "Preparação para gtkdocize"
#. (itstool) path: example/programlisting
-#: C/index.docbook:505
+#: C/index.docbook:456
#, no-wrap
msgid ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_CONFIG_MACRO_DIR(m4)\n"
-"\n"
-" "
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:461
+msgid ""
+"After all changes to <filename>configure.ac</filename> are made, update the "
+"<filename>configure</filename> file. This can be done by re-running "
+"<code>autoreconf -i</code> or <code>autogen.sh</code>."
+msgstr ""
+"Após todas as alterações do <filename>configure.ac</filename> serem feitas, "
+"atualize o arquivo <filename>configure</filename>. Isso pode ser feito "
+"executando novamente <code>autoreconf -i</code> ou <code>autogen.sh</code>."
#. (itstool) path: sect1/title
-#: C/index.docbook:515
+#: C/index.docbook:469
msgid "Integration with automake"
msgstr "Integração com automake"
#. (itstool) path: sect1/para
-#: C/index.docbook:517
-msgid ""
-"First copy the <filename>Makefile.am</filename> from the examples "
-"subdirectory of the gtkdoc-sources to your project's API documentation "
-"directory ( <filename class=\"directory\">./docs/reference/<package></"
-"filename>). If you have multiple doc-packages repeat this for each one."
-msgstr ""
-"Primeiro copie o <filename>Makefile.am</filename> dos subdiretórios do "
-"exemplo do gtkdoc-sources para o diretório de documentação da API do seu "
-"projeto ( <filename class=\"directory\">./docs/reference/<pacote></"
-"filename>). Se você tiver múltiplos pacotes de documentação, repita isso "
-"para cada um."
+#: C/index.docbook:471
+msgid ""
+"First copy the <filename>Makefile.am</filename> from the <filename class="
+"\"directory\">examples</filename> sub directory of the <ulink url=\"https://"
+"git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am\">gtkdoc-sources</"
+"ulink> to your project's API documentation directory ( <filename class="
+"\"directory\">./docs/reference/<package></filename>). A local copy "
+"should be available under e.g. <filename>/usr/share/doc/gtk-doc-tools/"
+"examples/Makefile.am</filename>. If you have multiple doc-packages repeat "
+"this for each one."
+msgstr ""
+"Primeiro copie o <filename>Makefile.am</filename> dos subdiretório do "
+"<filename class=\"directory\">exemplo</filename> do <ulink url=\"https://git."
+"gnome.org/browse/gtk-doc/tree/examples/Makefile.am\">gtkdoc-sources</ulink> "
+"para o diretório de documentação da API do seu projeto ( <filename class="
+"\"directory\">./docs/reference/<pacote></filename>). Uma cópia local "
+"deveria estar disponível sob, por exemplo, <filename>/usr/share/doc/gtk-doc-"
+"tools/examples/Makefile.am</filename>. Se você tiver múltiplos pacotes de "
+"documentação, repita isso para cada um."
#. (itstool) path: sect1/para
-#: C/index.docbook:524
+#: C/index.docbook:482
msgid ""
"The next step is to edit the settings inside the <filename>Makefile.am</"
"filename>. All the settings have a comment above that describes their "
"<option><NOME-FERRAMENTA>_OPTIONS</option>. Todas as ferramentas têm "
"suporte a <option>--help</option> pra listar os parâmetros disponíveis."
-#. (itstool) path: sect1/para
-#: C/index.docbook:535
-msgid ""
-"You may also want to enable GTK-Doc for the distcheck make target. Just add "
-"the one line shown in the next example to your top-level <filename>Makefile."
-"am</filename>:"
-msgstr ""
-"Você pode querer habilitar o GTK-Doc para o distcheck make target. Basta "
-"adicionar a linha mostrada no exemplo abaixo ao <filename>Makefile.am</"
-"filename> do seu diretório raiz:"
-
-#. (itstool) path: example/title
-#: C/index.docbook:542
-msgid "Enable GTK-Doc during make distcheck"
-msgstr "Habilita GTK-Doc durante make distcheck"
-
-#. (itstool) path: example/programlisting
-#: C/index.docbook:543
-#, no-wrap
-msgid ""
-"\n"
-"\n"
-"DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
-"\n"
-" "
-msgstr ""
-"\n"
-"\n"
-"DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
-"\n"
-" "
-
#. (itstool) path: sect1/title
-#: C/index.docbook:554
+#: C/index.docbook:496
msgid "Integration with autogen"
msgstr "Integração com autogen"
#. (itstool) path: sect1/para
-#: C/index.docbook:556
+#: C/index.docbook:498
msgid ""
"Most projects will have an <filename>autogen.sh</filename> script to setup "
"the build infrastructure after a checkout from version control system (such "
"O gtkdocize deveria ser executado antes de autoheader, automake ou autoconf."
#. (itstool) path: example/title
-#: C/index.docbook:565
+#: C/index.docbook:507
msgid "Running gtkdocize from autogen.sh"
msgstr "Executando gtkdocize no autogen.sh"
#. (itstool) path: example/programlisting
-#: C/index.docbook:566
+#: C/index.docbook:508
#, no-wrap
msgid ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"gtkdocize || exit 1\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:574
+#: C/index.docbook:514
msgid ""
"When running <application>gtkdocize</application> it copies <filename>gtk-"
"doc.make</filename> to your project root (or any directory specified by the "
"<application>gtkdocize</application>."
#. (itstool) path: sect1/para
-#: C/index.docbook:583
+#: C/index.docbook:523
msgid ""
"Historically GTK-Doc was generating template files where developers entered "
"the docs. This turned out to be not so good (e.g. the need for having "
#. (itstool) path: sect1/title
#. (itstool) path: example/title
-#: C/index.docbook:600 C/index.docbook:617
+#: C/index.docbook:540 C/index.docbook:557
msgid "Running the doc build"
msgstr "Executando a compilação da documentação"
#. (itstool) path: sect1/para
-#: C/index.docbook:602
+#: C/index.docbook:542
msgid ""
"After the previous steps it's time to run the build. First we need to rerun "
"<filename>autogen.sh</filename>. If this script runs configure for you, then "
"<filename>configure</filename> com esta opção em seguida."
#. (itstool) path: sect1/para
-#: C/index.docbook:609
+#: C/index.docbook:549
msgid ""
"The first make run generates several additional files in the doc-"
"directories. The important ones are: <filename><package>.types</"
"<filename><pacote>-sections.txt</filename>."
#. (itstool) path: example/programlisting
-#: C/index.docbook:618
+#: C/index.docbook:558
#, no-wrap
msgid ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"./autogen.sh --enable-gtk-doc\n"
"make\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:626
+#: C/index.docbook:564
msgid ""
"Now you can point your browser to <filename>docs/reference/<package>/"
"index.html</filename>. Yes, it's a bit disappointing still. But hang-on, "
"páginas com vida."
#. (itstool) path: sect1/title
-#: C/index.docbook:634
+#: C/index.docbook:572
msgid "Integration with version control systems"
msgstr "Integração com sistemas de controle de versão"
#. (itstool) path: sect1/para
-#: C/index.docbook:636
+#: C/index.docbook:574
msgid ""
"As a rule of the thumb, it's those files you edit, that should go under "
"version control. For typical projects it's these files: <filename><"
"filename>, <filename>Makefile.am</filename>"
#. (itstool) path: sect1/title
-#: C/index.docbook:647
+#: C/index.docbook:585
msgid "Integration with plain makefiles or other build systems"
msgstr "Integração com makefiles simples ou outros sistemas de compilação"
#. (itstool) path: sect1/para
-#: C/index.docbook:649
+#: C/index.docbook:587
msgid ""
"In the case one does not want to use automake and therefore <filename>gtk-"
"doc.mak</filename> one will need to call the gtkdoc tools in the right order "
"correta nos makefiles devidos (ou outras ferramentas de compilação)."
#. (itstool) path: example/title
-#: C/index.docbook:656
+#: C/index.docbook:594
msgid "Documentation build steps"
msgstr "Etapas de compilação da documentação"
#. (itstool) path: example/programlisting
-#: C/index.docbook:657
+#: C/index.docbook:595
#, no-wrap
msgid ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// sources have changed\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"DOC_MODULE=meep\n"
"// fontes foram alterados\n"
"gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...\n"
"mkdir html\n"
"cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n"
"gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:673
+#: C/index.docbook:609
msgid ""
"One will need to look at the <filename>Makefile.am</filename> and "
"<filename>gtk-doc.mak</filename> to pick the extra options needed."
"doc.mak</filename> para obter as opções extras necessárias."
#. (itstool) path: chapter/title
-#: C/index.docbook:682
+#: C/index.docbook:618
msgid "Documenting the code"
msgstr "Documentando o código"
#. (itstool) path: chapter/para
-#: C/index.docbook:684
+#: C/index.docbook:620
msgid ""
"GTK-Doc uses source code comment with a special syntax for code "
"documentation. Further it retrieves information about your project structure "
"descobrir todas as informações sobre a sintaxe dos comentários."
#. (itstool) path: note/title
-#: C/index.docbook:692
+#: C/index.docbook:628
msgid "Documentation placement"
msgstr "Localização da documentação"
#. (itstool) path: note/para
-#: C/index.docbook:693
+#: C/index.docbook:629
msgid ""
"In the past most documentation had to be filled into files residing inside "
"the <filename>tmpl</filename> directory. This has the disadvantages that the "
"versão."
#. (itstool) path: note/para
-#: C/index.docbook:699
+#: C/index.docbook:635
msgid ""
"The avoid the aforementioned problems we suggest putting the documentation "
"inside the sources. This manual will only describe this way of documenting "
"descrever esta forma de documentar código."
#. (itstool) path: example/title
-#: C/index.docbook:710 C/index.docbook:729
+#: C/index.docbook:646 C/index.docbook:663
msgid "GTK-Doc comment block"
msgstr "Bloco de comentário do GTK-Doc"
#. (itstool) path: example/programlisting
-#: C/index.docbook:711
+#: C/index.docbook:647
#, no-wrap
msgid ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* unparseable code here */\n"
"#endif\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#ifndef __GTK_DOC_IGNORE__\n"
"/* código não analisável arqui */\n"
"#endif\n"
-"\n"
-" "
#. (itstool) path: chapter/para
-#: C/index.docbook:706
+#: C/index.docbook:642
msgid ""
"The scanner can handle the majority of C headers fine. In the case of "
"receiving warnings from the scanner that look like a special case, one can "
"pode-se informar ao GTK-Doc para ignorá-los. <_:example-1/>"
#. (itstool) path: sect1/title
-#: C/index.docbook:724
+#: C/index.docbook:658
msgid "Documentation comments"
msgstr "Comentários de documentação"
#. (itstool) path: example/programlisting
-#: C/index.docbook:730
+#: C/index.docbook:664
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" * documentation ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * identificador:\n"
" * documentação ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:726
+#: C/index.docbook:660
msgid ""
"A multiline comment that starts with an additional '*' marks a documentation "
"block that will be processed by the GTK-Doc tools. <_:example-1/>"
# Ocultei o TODO da tradução. Para que server? :/
#. (itstool) path: sect1/para
-#: C/index.docbook:741
+#: C/index.docbook:673
msgid ""
"The 'identifier' is one line with the name of the item the comment is "
"related to. The syntax differs a little depending on the item. (TODO add "
"relacionado. A sintaxe difere um pouco dependendo do item."
#. (itstool) path: sect1/para
-#: C/index.docbook:747
+#: C/index.docbook:679
msgid ""
"The 'documentation' block is also different for each symbol type. Symbol "
"types that get parameters such as functions or macros have the parameter "
"espaço e espaço). Isso é útil em textos pré-formatados (listagens de código)."
#. (itstool) path: listitem/para
-#: C/index.docbook:764
+#: C/index.docbook:696
msgid ""
"What it is: The name for a class or function can sometimes be misleading for "
"people coming from a different background."
"entendimento equivocado pessoas com experiências diferentes."
#. (itstool) path: listitem/para
-#: C/index.docbook:770
+#: C/index.docbook:702
msgid ""
"What it does: Tell about common uses. Put it in relation with the other API."
msgstr ""
"O que isso faz: Fale sobre usos comuns. Coloque em relação com a outra API."
#. (itstool) path: tip/para
-#: C/index.docbook:760
+#: C/index.docbook:692
msgid "When documenting code, describe two aspects: <_:itemizedlist-1/>"
msgstr "Ao documentar um código, descreva dois aspectos: <_:itemizedlist-1/>"
#. (itstool) path: listitem/para
-#: C/index.docbook:785
+#: C/index.docbook:717
msgid "Use function() to refer to functions or macros which take arguments."
msgstr "Use function() para referir às funções ou macros que levam argumentos."
#. (itstool) path: listitem/para
-#: C/index.docbook:790
+#: C/index.docbook:722
msgid ""
"Use @param to refer to parameters. Also use this when referring to "
"parameters of other functions, related to the one being described."
"parâmetros de outras funções, relacionadas àquele sendo descrito."
#. (itstool) path: listitem/para
-#: C/index.docbook:796
+#: C/index.docbook:728
msgid "Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS."
msgstr "Use %constant para se referir a uma constante, ex.: %G_TRAVERSE_LEAFS."
#. (itstool) path: listitem/para
-#: C/index.docbook:801
+#: C/index.docbook:733
msgid ""
"Use #symbol to refer to other types of symbol, e.g. structs and enums and "
"macros which don't take arguments."
"e macros que não levam argumentos."
#. (itstool) path: listitem/para
-#: C/index.docbook:807
+#: C/index.docbook:739
msgid "Use #Object::signal to refer to a GObject signal."
msgstr "Use #Object::signal para se referir a um sinal de GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:812
+#: C/index.docbook:744
msgid "Use #Object:property to refer to a GObject property."
msgstr "Use #Object:property para se referir a uma propriedade de GObject."
#. (itstool) path: listitem/para
-#: C/index.docbook:817
+#: C/index.docbook:749
msgid ""
"Use #Struct.field to refer to a field inside a structure and #GObjectClass."
"foo_bar() to refer to a vmethod."
"#GObjectClass.foo_bar() para se referir a um vmethod."
#. (itstool) path: sect1/para
-#: C/index.docbook:779
+#: C/index.docbook:711
msgid ""
"One advantage of hyper-text over plain-text is the ability to have links in "
"the document. Writing the correct markup for a link can be tedious though. "
"itemizedlist-1/>"
#. (itstool) path: tip/para
-#: C/index.docbook:826
+#: C/index.docbook:758
msgid ""
"If you need to use the special characters '<', '>', '()', '@', '%', or "
"'#' in your documentation without GTK-Doc changing them you can use the XML "
"respectivamente, ou escapá-los com uma contrabarra \"\\\"."
#. (itstool) path: sect1/para
-#: C/index.docbook:835
+#: C/index.docbook:767
+msgid ""
+"DocBook can do more than just links. One can also have lists, examples, "
+"headings, and images. As of version 1.20, the preferred way is to use a "
+"subset of the basic text formatting syntax called <ulink url=\"http://"
+"daringfireball.net/projects/markdown/\">Markdown</ulink>. On older GTK-Doc "
+"versions any documentation that includes Markdown will be rendered as is. "
+"For example, list items will appear as lines starting with a dash."
+msgstr ""
+"DocBook pode fazer mais do que apenas links. Ele também pode ter listas, "
+"exemplos, títulos e imagens. A partir da versão 1.20, a forma preferível é "
+"usar um subconjunto de sintaxe de formatação de texto básica chamada <ulink "
+"url=\"http://daringfireball.net/projects/markdown/\">Markdown</ulink>. Em "
+"versões mais antigas do GTK-Doc, qualquer documentação que inclui Markdown "
+"será renderizada como está. Por exemplo, itens de lista aparecerão como "
+"linhas começando com um traço."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:778
msgid ""
-"DocBook can do more than just links. One can also have lists, tables and "
-"examples. To enable the usage of docbook SGML/XML tags inside doc-comments "
-"you need to have <option>--xml-mode</option> or <option>--sgml-mode</option> "
-"in the variable <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</"
-"filename>."
+"In older GTK-Doc releases, if you need support for additional formatting, "
+"you would need to enable the usage of docbook SGML/XML tags inside doc-"
+"comments by putting <option>--xml-mode</option> or <option>--sgml-mode</"
+"option> in the variable <symbol>MKDB_OPTIONS</symbol> inside "
+"<filename>Makefile.am</filename>."
msgstr ""
-"DocBook pode fazer mais do que apenas links. Pode-se também ter listas, "
-"tabelas e exemplos. Para habilitar o uso do tags de SGML/XML de docbook "
-"dentro de comentários de documentação para ter <option>--xml-mode</option> "
-"ou <option>--sgml-mode</option> na variável <symbol>MKDB_OPTIONS</symbol> "
-"dentro de <filename>Makefile.am</filename>."
+"Em versões mais antigas do GTK-Doc, se você precisasse de suporte para "
+"formatação adicional, você precisaria de habilitar o uso de tags de SGML/XML "
+"de docbook dentro de comentários de documentação colocando <option>--xml-"
+"mode</option> ou <option>--sgml-mode</option> na variável "
+"<symbol>MKDB_OPTIONS</symbol> dentro de <filename>Makefile.am</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:849
-msgid "GTK-Doc comment block using markdown"
-msgstr "Bloco de comentário do GTK-Doc usando markdown"
+#: C/index.docbook:788
+msgid "GTK-Doc comment block using Markdown"
+msgstr "Bloco de comentário do GTK-Doc usando Markdown"
#. (itstool) path: example/programlisting
-#: C/index.docbook:850
+#: C/index.docbook:789
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * identifier:\n"
" *\n"
-" * documentation ...\n"
+" * documentation paragraph ...\n"
" *\n"
-" * # Sub heading #\n"
+" * # Sub Heading #\n"
+" *\n"
+" * ## Second Sub Heading\n"
+" *\n"
+" * # Sub Heading With a Link Anchor # {#heading-two}\n"
" *\n"
" * more documentation:\n"
+" *\n"
" * - list item 1\n"
+" *\n"
+" * Paragraph inside a list item.\n"
+" *\n"
" * - list item 2\n"
" *\n"
-" * Even more docs.\n"
+" * 1. numbered list item\n"
+" *\n"
+" * 2. another numbered list item\n"
+" *\n"
+" * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n"
+" *\n"
+" * ![an inline image][plot-result.png]\n"
+" *\n"
+" * [A link to the heading anchor above][heading-two]\n"
+" *\n"
+" * A C-language example:\n"
+" * |[<!-- language=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * identificador:\n"
" *\n"
-" * documentação ...\n"
+" * parágrafo de documentação ...\n"
" *\n"
" * # Subtítulo #\n"
" *\n"
+" * ## Segundo subtítulo\n"
+" *\n"
+" * # Subtítulo com um link âncora # {#titulo-dois}\n"
+" *\n"
" * mais documentação:\n"
-" * - item de lista 1\n"
-" * - item de lista 2\n"
" *\n"
-" * Mais documentação.\n"
+" * - item 1 da lista\n"
+" *\n"
+" * Parágrafo dentro de um item de lista.\n"
+" *\n"
+" * - item 2 da lista\n"
+" *\n"
+" * 1. item numerado da lista\n"
+" *\n"
+" * 2. outro item numerado da lista\n"
+" *\n"
+" * Outro parágrafo. [Um link para o site do GNOME](http://www.gnome.org/)\n"
+" *\n"
+" * ![uma imagem embutida][plot-result.png]\n"
+" *\n"
+" * [Um link para um título acima][titulo-dois]\n"
+" *\n"
+" * Um exemplo em linguagem C:\n"
+" * |[<!-- language=\"C\" -->\n"
+" * GtkWidget *label = gtk_label_new (\"Esplêndido!\");\n"
+" * ]|\n"
" */\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:843
+#: C/index.docbook:828
msgid ""
-"Since GTK-Doc-1.18 the tool supports a subset or the <ulink url=\"http://"
-"daringfireball.net/projects/markdown/\">markdown language</ulink>. One can "
-"use it for sub-headings and simple itemized lists. On older GTK-Doc versions "
-"the content will be rendered as it (the list items will appear in one line "
-"separated by dashes). <_:example-1/>"
+"More examples of what markdown tags are supported can be found in the <ulink "
+"url=\"https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown"
+"\">GTK+ Documentation Markdown Syntax Reference</ulink>."
msgstr ""
-"Desde o GTK-Doc-1.18, a ferramenta tem suporte a um subconjunto ou a <ulink "
-"url=\"http://daringfireball.net/projects/markdown/\">linguagem markdown</"
-"ulink>. É possível usá-la em subtítulos e listas simples itemizadas. Em "
-"versões mais antigas GTK-Doc, o conteúdo será processado com está (os itens "
-"da lista vai aparecer em uma linha separada por traços). <_:example-1/>"
+"Mais exemplos do quais tags de markdown tags tem suporte pode ser encontrado "
+"na <ulink url=\"https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/"
+"Markdown\">Referência de sintaxe de markdown de documentação</ulink>."
#. (itstool) path: tip/para
-#: C/index.docbook:871
+#: C/index.docbook:834
msgid ""
"As already mentioned earlier GTK-Doc is for documenting public API. Thus one "
"cannot write documentation for static symbols. Nevertheless it is good to "
"arquivo e seções."
#. (itstool) path: sect1/title
-#: C/index.docbook:885
+#: C/index.docbook:848
msgid "Documenting sections"
msgstr "Documentando seções"
#. (itstool) path: sect1/para
-#: C/index.docbook:887
+#: C/index.docbook:850
msgid ""
"Each section of the documentation contains information about one class or "
"module. To introduce the component one can write a section block. The short "
"os @fields são opcionais."
#. (itstool) path: example/title
-#: C/index.docbook:895
+#: C/index.docbook:858
msgid "Section comment block"
msgstr "Bloco de comentário de sessão"
#. (itstool) path: example/programlisting
-#: C/index.docbook:896
+#: C/index.docbook:859
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: the application class\n"
" *\n"
" * The application class handles ...\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * SECTION:meepapp\n"
" * @short_description: A classe do aplicativo\n"
" *\n"
" * A classe do aplicativo cuida de ...\n"
" */\n"
-"\n"
-" "
#. (itstool) path: varlistentry/term
-#: C/index.docbook:917
+#: C/index.docbook:878
msgid "SECTION:<name>"
msgstr "SECTION:<nome>"
#. (itstool) path: listitem/para
-#: C/index.docbook:919
+#: C/index.docbook:880
msgid ""
"The name links the section documentation to the respective part in the "
"<filename><package>-sections.txt</filename> file. The name give here "
"txt</filename>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:928
+#: C/index.docbook:889
msgid "@short_description"
msgstr "@short_description"
#. (itstool) path: listitem/para
-#: C/index.docbook:930
+#: C/index.docbook:891
msgid ""
"A one line description of the section, that later will appear after the "
"links in the TOC and at the top of the section page."
"no TOC (sumário) no topo da página da sessão."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:937
+#: C/index.docbook:898
msgid "@title"
msgstr "@title"
#. (itstool) path: listitem/para
-#: C/index.docbook:939
+#: C/index.docbook:900
msgid ""
"The section title defaults to <name> from the SECTION declaration. It "
"can be overridden with the @title field."
"pode ser sobrescrito com o campo @title."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:946
+#: C/index.docbook:907
msgid "@section_id"
msgstr "@section_id"
#. (itstool) path: listitem/para
-#: C/index.docbook:948
+#: C/index.docbook:909
msgid ""
"Overrides the use of title as a section identifier. For GObjects the <"
"title> is used as a section_id and for other sections it is <"
"MÓDULO>-<title>."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:956
+#: C/index.docbook:917
msgid "@see_also"
msgstr "@see_also"
#. (itstool) path: listitem/para
-#: C/index.docbook:958
+#: C/index.docbook:919
msgid "A list of symbols that are related to this section."
msgstr "Uma lista de símbolos que estão relacionados a esta sessão."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:964
+#: C/index.docbook:925
msgid "@stability"
msgstr "@stability"
#. (itstool) path: listitem/para
-#: C/index.docbook:971
+#: C/index.docbook:932
msgid ""
"Stable - The intention of a Stable interface is to enable arbitrary third "
"parties to develop applications to these interfaces, release them, and have "
"alterações incompatíveis sejam raras e que tenham fortes justificativas."
#. (itstool) path: listitem/para
-#: C/index.docbook:983
+#: C/index.docbook:944
msgid ""
"Unstable - Unstable interfaces are experimental or transitional. They are "
"typically used to give outside developers early access to new or rapidly "
"fontes de uma versão menor para a próxima."
#. (itstool) path: listitem/para
-#: C/index.docbook:995
+#: C/index.docbook:956
msgid ""
"Private - An interface that can be used within the GNOME stack itself, but "
"that is not documented for end-users. Such functions should only be used in "
"usadas nas formas especificadas e documentadas."
#. (itstool) path: listitem/para
-#: C/index.docbook:1004
+#: C/index.docbook:965
msgid ""
"Internal - An interface that is internal to a module and does not require "
"end-user documentation. Functions that are undocumented are assumed to be "
"sendo \"Interna\"."
#. (itstool) path: listitem/para
-#: C/index.docbook:966
+#: C/index.docbook:927
msgid ""
"An informal description of the stability level this API has. We recommend "
"the use of one of these terms: <_:itemizedlist-1/>"
"recomendamos o uso de um desses termos: <_:itemizedlist-1/>"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1016
+#: C/index.docbook:977
msgid "@include"
msgstr "@include"
#. (itstool) path: listitem/para
-#: C/index.docbook:1018
+#: C/index.docbook:979
msgid ""
"The <literal>#include</literal> files to show in the section synopsis (a "
"comma separated list), overriding the global value from the <link linkend="
"Este item é opcional."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1027
+#: C/index.docbook:988
msgid "@image"
msgstr "@image"
#. (itstool) path: listitem/para
-#: C/index.docbook:1029
+#: C/index.docbook:990
msgid ""
"The image to display at the top of the reference page for this section. This "
"will often be some sort of a diagram to illustrate the visual appearance of "
"opcional."
#. (itstool) path: tip/para
-#: C/index.docbook:1040
+#: C/index.docbook:1001
msgid ""
"To avoid unnecessary recompilation after doc-changes put the section docs "
"into the c-source where possible."
"inseridas nas documentações de seção no fonte em C onde possível."
#. (itstool) path: sect1/title
-#: C/index.docbook:1049
+#: C/index.docbook:1010
msgid "Documenting symbols"
msgstr "Documentando símbolos"
#. (itstool) path: sect1/para
-#: C/index.docbook:1051
+#: C/index.docbook:1012
msgid ""
"Each symbol (function, macro, struct, enum, signal and property) is "
"documented in a separate block. The block is best placed close to the "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1059 C/index.docbook:1088
+#: C/index.docbook:1020 C/index.docbook:1049
msgid "General tags"
msgstr "Tags gerais"
#. (itstool) path: sect2/para
-#: C/index.docbook:1061
+#: C/index.docbook:1022
msgid ""
"You can add versioning information to all documentation elements to tell "
"when an API was introduced, or when it was deprecated."
"tornou obsoleta."
#. (itstool) path: variablelist/title
-#: C/index.docbook:1066
+#: C/index.docbook:1027
msgid "Versioning Tags"
msgstr "Tags de versionamento"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1067
+#: C/index.docbook:1028
msgid "Since:"
msgstr "Since:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1069
+#: C/index.docbook:1030
msgid "Description since which version of the code the API is available."
msgstr "Descrição de desde qual versão do código a API está disponível."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1074
+#: C/index.docbook:1035
msgid "Deprecated:"
msgstr "Deprecated:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1076
+#: C/index.docbook:1037
msgid ""
"Paragraph denoting that this function should no be used anymore. The "
"description should point the reader to the new API."
"deveria apontar o leitor para a nova API."
#. (itstool) path: sect2/para
-#: C/index.docbook:1084
+#: C/index.docbook:1045
msgid "(FIXME : Stability information)"
msgstr "(CORRIJA-ME : Informação sobre estabilidade)"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1089
+#: C/index.docbook:1050
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: some foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * foo_get_bar:\n"
" * @foo: Um foo\n"
"foo_get_bar(Foo *foo)\n"
"{\n"
"...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1111 C/index.docbook:1147
+#: C/index.docbook:1070 C/index.docbook:1106
msgid "Function comment block"
msgstr "Bloco de comentário de função"
#. (itstool) path: listitem/para
-#: C/index.docbook:1117
+#: C/index.docbook:1076
msgid ""
"Document whether returned objects, lists, strings, etc, should be freed/"
"unrefed/released."
"não referenciados/liberada."
#. (itstool) path: listitem/para
-#: C/index.docbook:1123
+#: C/index.docbook:1082
msgid "Document whether parameters can be NULL, and what happens if they are."
msgstr ""
"Documente se parâmetros pode ser NULL e o que acontece se eles o forem."
#. (itstool) path: listitem/para
-#: C/index.docbook:1128
+#: C/index.docbook:1087
msgid ""
"Mention interesting pre-conditions and post-conditions where appropriate."
msgstr ""
"Mencione pré-condições e pós-condições interessantes onde for apropriado."
#. (itstool) path: sect2/para
-#: C/index.docbook:1113 C/index.docbook:1210
+#: C/index.docbook:1072 C/index.docbook:1165
msgid "Please remember to: <_:itemizedlist-1/>"
msgstr "Por favor, lembre-se de: <_:itemizedlist-1/>"
#. (itstool) path: sect2/para
-#: C/index.docbook:1135
+#: C/index.docbook:1094
msgid ""
"Gtk-doc assumes all symbols (macros, functions) starting with '_' are "
"private. They are treated like static functions."
"são privadas. Elas são tratadas como funções estáticas."
#. (itstool) path: sect2/para
-#: C/index.docbook:1140
+#: C/index.docbook:1099
msgid ""
"Also, take a look at GObject Introspection annotation tags: http://live."
"gnome.org/GObjectIntrospection/Annotations"
"live.gnome.org/GObjectIntrospection/Annotations"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1148
+#: C/index.docbook:1107
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * function_name:\n"
" * @par1: description of parameter 1. These can extend over more than\n"
" * Since: 2.2\n"
" * Deprecated: 2.18: Use other_function() instead.\n"
" */\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * nome_da_função:\n"
" * @par1: descrição do parâmetro 1. Esta pode se estender por mais de\n"
" * @par2: descrição do parâmetro 2\n"
" * @...: uma lista de bars terminada em %NULL\n"
" *\n"
-" * A descrição vai aqui. Você pode usar @par1 para se referir a parâmetros\n"
+" * A descrição da função vai aqui. Você pode usar @par1 para se referir a parâmetros\n"
" * de forma que eles ficam em destaque na saída. Você também pode usar %constant\n"
" * para constantes, nome_da_função2() para funções e #GtkWidget para links para\n"
" * outras declarações (que pode ser documentada em outro lugar).\n"
" * Since: 2.2\n"
" * Deprecated: 2.18: Use outra_função() em seu lugar.\n"
" */\n"
-"\n"
-" "
#. (itstool) path: variablelist/title
-#: C/index.docbook:1171
+#: C/index.docbook:1128
msgid "Function tags"
msgstr "Tags de função"
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1172
+#: C/index.docbook:1129
msgid "Returns:"
msgstr "Returns:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1174
+#: C/index.docbook:1131
msgid "Paragraph describing the returned result."
msgstr "Parágrafo descrevendo o resultado retornado."
#. (itstool) path: varlistentry/term
-#: C/index.docbook:1179
+#: C/index.docbook:1136
msgid "@...:"
msgstr "@...:"
#. (itstool) path: listitem/para
-#: C/index.docbook:1181
+#: C/index.docbook:1138
msgid ""
"In case the function has variadic arguments, you should use this tag "
"(@Varargs: does also work for historic reasons)."
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1191 C/index.docbook:1193
+#: C/index.docbook:1148 C/index.docbook:1150
msgid "Property comment block"
msgstr "Bloco de comentário de propriedade"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1194
+#: C/index.docbook:1151
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * SomeWidget:some-property:\n"
" *\n"
" * Here you can document a property.\n"
" */\n"
"g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * AlgumWidget:alguma-propriedade:\n"
" *\n"
" * Aqui você pode documentar uma propriedade.\n"
" */\n"
"g_object_propriedade_install_classe (object_classe, PROP_ALGUMA_PROPRIEDADE, ...);\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1208 C/index.docbook:1227
+#: C/index.docbook:1163 C/index.docbook:1182
msgid "Signal comment block"
msgstr "Bloco de comentário de sinal"
#. (itstool) path: listitem/para
-#: C/index.docbook:1214
+#: C/index.docbook:1169
msgid ""
"Document when the signal is emitted and whether it is emitted before or "
"after other signals."
"sinais."
#. (itstool) path: listitem/para
-#: C/index.docbook:1220
+#: C/index.docbook:1175
msgid "Document what an application might do in the signal handler."
msgstr "Documente o que um aplicativo pode fazer no manipulador do sinal."
#. (itstool) path: example/programlisting
-#: C/index.docbook:1228
+#: C/index.docbook:1183
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarized:\n"
" * @widget: the widget that received the signal\n"
"foo_signals[FOOBARIZE] =\n"
" g_signal_new (\"foobarize\",\n"
" ...\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget::foobarizado:\n"
" * @widget: o widget que recebeu o sinal\n"
"foo_sinais[FOOBARIZAR] =\n"
" g_signal_novo (\"foobarizar\",\n"
" ...\n"
-"\n"
-" "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1247 C/index.docbook:1248
+#: C/index.docbook:1200 C/index.docbook:1201
msgid "Struct comment block"
msgstr "Bloco de comentário de struct"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1249
+#: C/index.docbook:1202
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: some #gboolean\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * FooWidget:\n"
" * @bar: algum #gboolean\n"
" /*< public >*/\n"
" gboolean bar;\n"
"} FooWidget;\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1268
+#: C/index.docbook:1219
msgid ""
"Use <code>/*< private >*/</code> before the private struct fields you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
"comportamento inverso."
#. (itstool) path: sect2/para
-#: C/index.docbook:1274
+#: C/index.docbook:1225
msgid ""
"Struct comment blocks can also be used for GObjects and GObjectClasses. It "
"is usually a good idea to add a comment block for a class, if it has "
#. (itstool) path: sect2/title
#. (itstool) path: example/title
-#: C/index.docbook:1286 C/index.docbook:1287
+#: C/index.docbook:1237 C/index.docbook:1238
msgid "Enum comment block"
msgstr "Bloco de comentário de enum"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1288
+#: C/index.docbook:1239
#, no-wrap
msgid ""
"\n"
-"\n"
"/**\n"
" * Something:\n"
" * @SOMETHING_FOO: something foo\n"
" /*< private >*/\n"
" SOMETHING_COUNT\n"
"} Something;\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"/**\n"
" * Alguma coisa:\n"
" * @ALGUMACOISA_FOO: alguma coisa foo\n"
" /*< private >*/\n"
" ALGUMACOISA_CONTAGEM\n"
"} Alguma coisa;\n"
-"\n"
-" "
#. (itstool) path: sect2/para
-#: C/index.docbook:1307
+#: C/index.docbook:1256
msgid ""
"Use <code>/*< private >*/</code> before the private enum values you "
"want to hide. Use <code>/*< public >*/</code> for the reverse "
"comportamento inverso."
#. (itstool) path: sect1/title
-#: C/index.docbook:1317
+#: C/index.docbook:1266
msgid "Useful DocBook tags"
msgstr "Tags úteis do DocBook"
#. (itstool) path: sect1/para
-#: C/index.docbook:1319
+#: C/index.docbook:1268
msgid ""
"Here are some DocBook tags which are most useful when documenting the code."
msgstr ""
"documentado o código."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1328
+#: C/index.docbook:1277
#, no-wrap
msgid ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<link linkend=\"glib-Hash-Tables\">Tabela de hashes</link>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1324
+#: C/index.docbook:1273
msgid ""
"To link to another section in the GTK docs: <_:informalexample-1/> The "
"linkend is the SGML/XML id on the top item of the page you want to link to. "
"then the page title (\"Hash Tables\"). For widgets it is just the class "
"name. Spaces and underscores are converted to '-' to conform to SGML/XML."
msgstr ""
-"PAra vincular a outra seção nas documentações do GTK: <_:informalexample-1/> "
+"Para vincular a outra seção nas documentações do GTK: <_:informalexample-1/> "
"O fim do link é o ID do SGML/XML no item superior da páginao a qual você "
"deseja vincular. Para a maioria das páginas isto é atualmente a parte (\"gtk"
"\", \"gdk\", \"glib\") e, então, o título da página (\"Hash Tables\"). Para "
"convertidos em '-' para estar em conformidade com SGML/XML."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1343
+#: C/index.docbook:1290
#, no-wrap
msgid ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<function>...</function>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1340
+#: C/index.docbook:1287
msgid ""
"To refer to an external function, e.g. a standard C function: <_:"
"informalexample-1/>"
"do C: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1354
+#: C/index.docbook:1299
#, no-wrap
msgid ""
"\n"
-"\n"
"<example>\n"
" <title>Using a GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<example>\n"
" <title>Usando uma GHashTable.</title>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</example>\n"
-"\n"
-" "
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1367
+#: C/index.docbook:1310
#, no-wrap
msgid ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<informalexample>\n"
" <programlisting>\n"
" ...\n"
" </programlisting>\n"
"</informalexample>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1351
+#: C/index.docbook:1296
msgid ""
"To include example code: <_:informalexample-1/> or possibly this, for very "
"short code fragments which don't need a title: <_:informalexample-2/> For "
"abreviação: |[ ... ]|"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1388
+#: C/index.docbook:1329
#, no-wrap
msgid ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<itemizedlist>\n"
" <listitem>\n"
" <para>\n"
" </para>\n"
" </listitem>\n"
"</itemizedlist>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1385
+#: C/index.docbook:1326
msgid "To include bulleted lists: <_:informalexample-1/>"
msgstr "Para incluir listas com marcadores: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1410
+#: C/index.docbook:1349
#, no-wrap
msgid ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
" Make sure you free the data after use.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<note>\n"
" <para>\n"
" Certifique-se de que você liberou os dados após usá-los.\n"
" </para>\n"
"</note>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1407
+#: C/index.docbook:1346
msgid ""
"To include a note which stands out from the text: <_:informalexample-1/>"
msgstr "Para incluir uma nota que fique fora do texto: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1425
+#: C/index.docbook:1362
#, no-wrap
msgid ""
"\n"
-"\n"
"<type>unsigned char</type>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<type>unsigned char</type>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1422
+#: C/index.docbook:1359
msgid "To refer to a type: <_:informalexample-1/>"
msgstr "Para se referir a um tipo: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1436
+#: C/index.docbook:1371
#, no-wrap
msgid ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structname>XFontStruct</structname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1433
+#: C/index.docbook:1368
msgid ""
"To refer to an external structure (not one described in the GTK docs): <_:"
"informalexample-1/>"
"GTK): <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1447
+#: C/index.docbook:1380
#, no-wrap
msgid ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<structfield>len</structfield>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1444
+#: C/index.docbook:1377
msgid "To refer to a field of a structure: <_:informalexample-1/>"
msgstr "Para se referir a um campo de uma estrutura: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1458
+#: C/index.docbook:1389
#, no-wrap
msgid ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<classname>GtkWidget</classname>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1455
+#: C/index.docbook:1386
msgid ""
"To refer to a class name, we could possibly use: <_:informalexample-1/> but "
"you'll probably be using #GtkWidget instead (to automatically create a link "
"veja <link linkend=\"documenting_syntax\">as abreviações</link>)."
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1471
+#: C/index.docbook:1400
#, no-wrap
msgid ""
"\n"
-"\n"
"<emphasis>This is important</emphasis>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<emphasis>Isso é importante</emphasis>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1468
+#: C/index.docbook:1397
msgid "To emphasize text: <_:informalexample-1/>"
msgstr "Para enfatizar um texto: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1482
+#: C/index.docbook:1409
#, no-wrap
msgid ""
"\n"
-"\n"
"<filename>/home/user/documents</filename>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<filename>/home/usuario/documentos</filename>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1479
+#: C/index.docbook:1406
msgid "For filenames use: <_:informalexample-1/>"
msgstr "Para nome de arquivos use: <_:informalexample-1/>"
#. (itstool) path: informalexample/programlisting
-#: C/index.docbook:1493
+#: C/index.docbook:1418
#, no-wrap
msgid ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1490
+#: C/index.docbook:1415
msgid "To refer to keys use: <_:informalexample-1/>"
msgstr "Para se referir a chaves use: <_:informalexample-1/>"
#. (itstool) path: chapter/title
-#: C/index.docbook:1505
+#: C/index.docbook:1428
msgid "Filling the extra files"
msgstr "Preenchendo os arquivos extras"
#. (itstool) path: chapter/para
-#: C/index.docbook:1507
+#: C/index.docbook:1430
msgid ""
"There are a couple of extra files, that need to be maintained along with the "
"inline source code comments: <filename><package>.types</filename>, "
"<filename><pacote>-sections.txt</filename>."
#. (itstool) path: sect1/title
-#: C/index.docbook:1516
+#: C/index.docbook:1439
msgid "Editing the types file"
msgstr "Editando o arquivo de tipos"
#. (itstool) path: sect1/para
-#: C/index.docbook:1518
+#: C/index.docbook:1441
msgid ""
"If your library or application includes GObjects, you want their signals, "
"arguments/parameters and position in the hierarchy to be shown in the "
"<filename><pacote>.types</filename>."
#. (itstool) path: example/title
-#: C/index.docbook:1527
+#: C/index.docbook:1450
msgid "Example types file snippet"
msgstr "Trecho de exemplo de arquivo de tipos"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1528
+#: C/index.docbook:1451
#, no-wrap
msgid ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"#include <gtk/gtk.h>\n"
"\n"
"gtk_accel_label_get_type\n"
"gtk_adjustment_get_type\n"
"gtk_alignment_get_type\n"
"gtk_arrow_get_type\n"
-"\n"
-" "
#. (itstool) path: sect1/para
-#: C/index.docbook:1541
+#: C/index.docbook:1462
msgid ""
"Since GTK-Doc 1.8 <application>gtkdoc-scan</application> can generate this "
"list for you. Just add \"--rebuild-types\" to SCAN_OPTIONS in "
"deveria distribuir o arquivo de tipos nem tê-lo sob um controle de versão."
#. (itstool) path: sect1/title
-#: C/index.docbook:1550
+#: C/index.docbook:1471
msgid "Editing the master document"
msgstr "Editando o documento mestre"
#. (itstool) path: sect1/para
-#: C/index.docbook:1552
+#: C/index.docbook:1473
msgid ""
"GTK-Doc produces documentation in DocBook SGML/XML. When processing the "
"inline source comments, the GTK-Doc tools generate one documentation page "
"mestre os inclui e os coloca em uma ordem."
#. (itstool) path: sect1/para
-#: C/index.docbook:1559
+#: C/index.docbook:1480
msgid ""
"While GTK-Doc creates a template master document for you, later run will not "
"touch it again. This means that one can freely structure the documentation. "
"em tempo para ver se há itens a serem introduzidos lá."
#. (itstool) path: tip/para
-#: C/index.docbook:1569
+#: C/index.docbook:1490
msgid ""
"Do not create tutorials as extra documents. Just write extra chapters. The "
"benefit of directly embedding the tutorial for your library into the API "
"atualizações junto com a biblioteca."
#. (itstool) path: sect1/para
-#: C/index.docbook:1578
+#: C/index.docbook:1499
msgid ""
"So what are the things to change inside the master document? For a start is "
"only a little. There are some placeholders (text in square brackets) there "
"colchetes) que você deve cuidar."
#. (itstool) path: example/title
-#: C/index.docbook:1585
+#: C/index.docbook:1506
msgid "Master document header"
msgstr "Cabeçalho do documento mestre"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1586
+#: C/index.docbook:1507
#, no-wrap
msgid ""
"\n"
-"\n"
"<bookinfo>\n"
" <title>MODULENAME Reference Manual</title>\n"
" <releaseinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insert title here]</title>\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"<bookinfo>\n"
" <title>Manual de referência do NOMEDOMÓDULO</title>\n"
" <releaseinfo>\n"
"\n"
"<chapter>\n"
" <title>[Insira o título aqui]</title>\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1607
+#: C/index.docbook:1526
msgid "Editing the section file"
msgstr "Editando o arquivo de seção"
#. (itstool) path: sect1/para
-#: C/index.docbook:1609
+#: C/index.docbook:1528
msgid ""
"The section file is used to organise the documentation output by GTK-Doc. "
"Here one specifies which symbol belongs to which module or class and control "
"e controla a visibilidade (pública ou privada)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1615
+#: C/index.docbook:1534
msgid ""
"The section file is a plain text file with XML-like syntax (using tags). "
"Blank lines are ignored and lines starting with a '#' are treated as comment "
"\" são tratadas como linhas de comentários."
#. (itstool) path: sect1/para
-#: C/index.docbook:1621
+#: C/index.docbook:1540
msgid ""
"The <FILE> ... </FILE> tag is used to specify the file name, "
"without any suffix. For example, using '<FILE>gnome-config</"
"os caracteres para minúsculos)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1633
+#: C/index.docbook:1552
msgid ""
"The <TITLE> ... </TITLE> tag is used to specify the title of the "
"section. It is only useful before the templates (if used) are initially "
"obsoleto."
#. (itstool) path: sect1/para
-#: C/index.docbook:1640
+#: C/index.docbook:1559
msgid ""
"You can group items in the section by using the <SUBSECTION> tag. "
"Currently it outputs a blank line between subsections in the synopsis "
"padrão ou pública depende se há entradas públicas (variáveis, vmethods)."
#. (itstool) path: sect1/para
-#: C/index.docbook:1659
+#: C/index.docbook:1578
msgid ""
"You can also use <INCLUDE> ... </INCLUDE> to specify the "
"#include files which are shown in the synopsis sections. It contains a comma-"
"aplicar àquela seção."
#. (itstool) path: chapter/title
-#: C/index.docbook:1673
+#: C/index.docbook:1592
msgid "Controlling the result"
msgstr "Controlando o resultado"
#. (itstool) path: chapter/para
-#: C/index.docbook:1675
+#: C/index.docbook:1594
msgid ""
"A GTK-Doc run generates report files inside the documentation directory. The "
"generated files are named: <filename><package>-undocumented.txt</"
"processados."
#. (itstool) path: chapter/para
-#: C/index.docbook:1684
+#: C/index.docbook:1603
msgid ""
"The <filename><package>-undocumented.txt</filename> file starts with "
"the documentation coverage summary. Below are two sections divided by blank "
"exemplo, um novo parâmetro foi adicionado."
#. (itstool) path: chapter/para
-#: C/index.docbook:1693
+#: C/index.docbook:1612
msgid ""
"The <filename><package>-undeclared.txt</filename> file lists symbols "
"given in the <filename><package>-sections.txt</filename> but not found "
"escritos incorretamente."
#. (itstool) path: chapter/para
-#: C/index.docbook:1700
+#: C/index.docbook:1619
msgid ""
"The <filename><package>-unused.txt</filename> file lists symbol names, "
"where the GTK-Doc scanner has found documentation, but does not know where "
"ainda ao arquivo <filename><pacote>-sections.txt</filename>."
#. (itstool) path: tip/para
-#: C/index.docbook:1708
+#: C/index.docbook:1627
msgid ""
"Enable or add the <option>TESTS=$(GTKDOC_CHECK)</option> line in Makefile."
"am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during "
"verificações de sanidade durante a execução de <command>make check</command>."
#. (itstool) path: chapter/para
-#: C/index.docbook:1715
+#: C/index.docbook:1634
msgid ""
"One can also look at the files produced by the source code scanner: "
"<filename><package>-decl-list.txt</filename> and <filename><"
"este arquivo o contém."
#. (itstool) path: chapter/para
-#: C/index.docbook:1724
+#: C/index.docbook:1643
msgid ""
"If the project is GObject based, one can also look into the files produced "
"by the object scanner: <filename><package>.args.txt</filename>, "
"<filename><package>.hierarchy.txt</filename>, <filename><"
"package>.interfaces.txt</filename>, <filename><package>."
"prerequisites.txt</filename> and <filename><package>.signals.txt</"
-"filename>. If there are missing symbols in any of those, one can ask gtkdoc "
+"filename>. If there are missing symbols in any of those, one can ask GTK-Doc "
"to keep the intermediate scanner file for further analysis, by running it as "
"<command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
msgstr ""
"filename>, <filename><pacote>.hierarchy.txt</filename>, <filename><"
"pacote>.interfaces.txt</filename>, <filename><pacote>.prerequisites."
"txt</filename> e <filename><pacote>.signals.txt</filename>. Se há "
-"símbolos faltando em qualquer um deles, pode-se exigir que o gtkdoc mantenha "
-"o arquivo intermediário de varredura para análise posterior, executando "
-"<command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
+"símbolos faltando em qualquer um deles, pode-se exigir que o GTK-Doc "
+"mantenha o arquivo intermediário de varredura para análise posterior, "
+"executando <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>."
#. (itstool) path: chapter/title
-#: C/index.docbook:1739
+#: C/index.docbook:1658
+msgid "Modernizing the documentation"
+msgstr "Modernizando a documentação"
+
+#. (itstool) path: chapter/para
+#: C/index.docbook:1660
+msgid ""
+"GTK-Doc has been around for quite some time. In this section we list new "
+"features together with the version since when it is available."
+msgstr ""
+"GTK-Doc está por aí já faz um tempo. Nesta seção, nós listamos novas "
+"funcionalidades juntamente da versão desde a qual está disponível."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1666
+msgid "GTK-Doc 1.9"
+msgstr "GTK-Doc 1.9"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1668
+msgid ""
+"When using xml instead of sgml, one can actually name the master document "
+"<filename><package>-docs.xml</filename>."
+msgstr ""
+"Ao usar xml em vez de sgml, na verdade, é possível nomear o documento mestre "
+"<filename><pacote>-docs.xml</filename>."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1673
+msgid ""
+"This version supports <option>SCAN_OPTIONS=--rebuild-sections</option> in "
+"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
+"package>-sections.txt</filename> is autogenerated and can be removed from "
+"the vcs. This only works nicely for projects that have a very regular "
+"structure (e.g. each .{c,h} pair will create new section). If one organize a "
+"project close to that updating a manually maintained section file can be as "
+"simple as running <code>meld <package>-decl-list.txt <package>-"
+"sections.txt</code>."
+msgstr ""
+"Essa versão provê suporte <option>SCAN_OPTIONS=--rebuild-sections</option> "
+"em <filename>Makefile.am</filename>. Quando esta opção está habilitada, o "
+"<filename><package>-sections.txt</filename> é auto-gerado e pode ser "
+"removido a partir do VCS. Isso só funciona corretamente para projetos que "
+"têm uma estrutura muito regular (ex.: cada par .{c,h} vai criar uma nova "
+"seção). Se uma pessoa organiza um projeto próximo a isso atualizando um "
+"arquivo de seção mantido manualmente pode ser tão simples quanto executando "
+"<code>meld <package>-decl-list.txt <package>-sections.txt</code>."
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1684
+msgid ""
+"Version 1.8 already introduced the syntax for documenting sections in the "
+"sources instead of the separate files under <filename class=\"directory"
+"\">tmpl</filename>. This version adds options to switch the whole doc module "
+"to not use the extra tmpl build step at all, by using <option>--flavour no-"
+"tmpl</option> in <filename>configure.ac</filename>."
+msgstr ""
+"A versão 1.8 já introduziu a sintaxe para documentação seções nos fontes em "
+"vez dos arquivos separados sob <filename class=\"directory\">tmpl</"
+"filename>. Essa versão adiciona opções para alternar todo o módulo de "
+"documentação para não usar a etapa de compilação extra do tmpl, usando "
+"<option>--flavour no-tmpl</option> no <filename>configure.ac</filename>."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1694
+msgid "GTK-Doc 1.10"
+msgstr "GTK-Doc 1.10"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1696
+msgid ""
+"This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in "
+"<filename>Makefile.am</filename>. When this is enabled, the <filename><"
+"package>.types</filename> is autogenerated and can be removed from the "
+"vcs. When using this feature it is important to also setup the "
+"<varname>IGNORE_HFILES</varname> in <filename>Makefile.am</filename> for "
+"code that is build conditionally."
+msgstr ""
+"Essa versão provê suporte <option>SCAN_OPTIONS=--rebuild-types</option> no "
+"<filename>Makefile.am</filename>. Quando isso está habilitado, o "
+"<filename><package>.types</filename> é auto-gerado e pode ser removido "
+"do VCS. Quando usando essa funcionalidade é importante também configurar o "
+"<varname>IGNORE_HFILES</varname> no <filename>Makefile.am</filename> para "
+"código que é compilado condicionalmente."
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1707
+msgid "GTK-Doc 1.16"
+msgstr "GTK-Doc 1.16"
+
+#. (itstool) path: example/title
+#: C/index.docbook:1713
+msgid "Enable gtkdoc-check"
+msgstr "Habilitar gtkdoc-check"
+
+#. (itstool) path: example/programlisting
+#: C/index.docbook:1714
+#, no-wrap
+msgid ""
+"\n"
+"if ENABLE_GTK_DOC\n"
+"TESTS_ENVIRONMENT = \\\n"
+" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
+" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
+"TESTS = $(GTKDOC_CHECK)\n"
+"endif\n"
+msgstr ""
+"\n"
+"if ENABLE_GTK_DOC\n"
+"TESTS_ENVIRONMENT = \\\n"
+" DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n"
+" SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n"
+"TESTS = $(GTKDOC_CHECK)\n"
+"endif\n"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1709
+msgid ""
+"This version includes a new tool called gtkdoc-check. This tool can run a "
+"set of sanity checks on your documentation. It is enabled by adding these "
+"lines to the end of <filename>Makefile.am</filename>. <_:example-1/>"
+msgstr ""
+"Essa versão inclui uma nova ferramenta chamada gtkdoc-check. Essa ferramenta "
+"pode executar um conjunto de verificações de sanidade na sua documentação. "
+"Ela é habilitada adicionando essas linhas ao final do <filename>Makefile.am</"
+"filename>. <_:example-1/>"
+
+#. (itstool) path: sect1/title
+#: C/index.docbook:1727
+msgid "GTK-Doc 1.20"
+msgstr "GTK-Doc 1.20"
+
+#. (itstool) path: sect1/para
+#: C/index.docbook:1729
+msgid ""
+"Version 1.18 brought some initial markdown support. Using markdown in doc "
+"comments is less intrusive than writing docbook xml. This version improves a "
+"lot on this and add a lot more styles. The section that explains the <link "
+"linkend=\"documenting_syntax\">comment syntax</link> has all the details."
+msgstr ""
+"A versão 1.18 trouxe algum suporte inicial a markdown. O uso de markdown em "
+"comentários de documentação é menos intrusiva do que escrever xml de "
+"docbook. Essa versão melhora em muito nisso e adiciona muito mais estilos. A "
+"seção que explica a <link linkend=\"documenting_syntax\">sintaxe de "
+"comentário</link> tem todos os detalhes."
+
+#. (itstool) path: chapter/title
+#: C/index.docbook:1740
msgid "Documenting other interfaces"
msgstr "Documentando outras interfaces"
#. (itstool) path: chapter/para
-#: C/index.docbook:1741
+#: C/index.docbook:1742
msgid ""
"So far we have been using GTK-Doc to document the API of code. The next "
"sections contain suggestions how the tools can be used to document other "
"para documentar outras interfaces, também."
#. (itstool) path: sect1/title
-#: C/index.docbook:1748
+#: C/index.docbook:1749
msgid "Command line options and man pages"
msgstr "Opções de linha de comando e de páginas man"
# RefEntry é uma página de referência do DocBook (http://www.docbook.org/tdg/en/html/refentry.html)
#. (itstool) path: sect1/para
-#: C/index.docbook:1750
+#: C/index.docbook:1751
msgid ""
"As one can generate man pages for a docbook refentry as well, it sounds like "
"a good idea to use it for that purpose. This way the interface is part of "
"parte da referência e é possível obter a página man de graça."
#. (itstool) path: sect2/title
-#: C/index.docbook:1757
+#: C/index.docbook:1758
msgid "Document the tool"
msgstr "Documentar a ferramenta"
#. (itstool) path: sect2/para
-#: C/index.docbook:1759
+#: C/index.docbook:1760
msgid ""
"Create one refentry file per tool. Following <link linkend="
"\"settingup_docfiles\">our example</link> we would call it <filename>meep/"
"assim como exemplos, por exemplo, em glib."
#. (itstool) path: sect2/title
-#: C/index.docbook:1769
+#: C/index.docbook:1770
msgid "Adding the extra configure check"
msgstr "Adicionando a verificação extra ao configure"
#. (itstool) path: example/title
-#: C/index.docbook:1772 C/index.docbook:1792
+#: C/index.docbook:1773 C/index.docbook:1791
msgid "Extra configure checks"
msgstr "Verificações extra no configure"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1773
+#: C/index.docbook:1774
#, no-wrap
msgid ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"AC_ARG_ENABLE(man,\n"
" [AC_HELP_STRING([--enable-man],\n"
" [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n"
"\n"
"AC_PATH_PROG([XSLTPROC], [xsltproc])\n"
"AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n"
-"\n"
-" "
#. (itstool) path: sect2/title
-#: C/index.docbook:1789
+#: C/index.docbook:1788
msgid "Adding the extra makefile rules"
msgstr "Adicionando as regras extras ao makefile"
#. (itstool) path: example/programlisting
-#: C/index.docbook:1793
+#: C/index.docbook:1792
#, no-wrap
msgid ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
msgstr ""
"\n"
-"\n"
"man_MANS = \\\n"
" meeper.1\n"
"\n"
"\n"
"BUILT_EXTRA_DIST = $(man_MANS)\n"
"EXTRA_DIST += meep.xml\n"
-"\n"
-" "
#. (itstool) path: sect1/title
-#: C/index.docbook:1817
+#: C/index.docbook:1814
msgid "DBus interfaces"
msgstr "Interfaces DBus"
#. (itstool) path: sect1/para
-#: C/index.docbook:1819
+#: C/index.docbook:1816
msgid ""
"(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://"
"cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
"http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)"
#. (itstool) path: chapter/title
-#: C/index.docbook:1828
+#: C/index.docbook:1825
msgid "Frequently asked questions"
msgstr "Perguntas frequentes"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1832
+#: C/index.docbook:1829
msgid "Question"
msgstr "Questão"
#. (itstool) path: segmentedlist/segtitle
-#: C/index.docbook:1833
+#: C/index.docbook:1830
msgid "Answer"
msgstr "Resposta"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1835
+#: C/index.docbook:1832
msgid "No class hierarchy."
msgstr "Sem hierarquia de classe."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1836
+#: C/index.docbook:1833
msgid ""
"The objects <function>xxx_get_type()</function> function has not been "
"entered into the <filename><package>.types</filename> file."
"arquivo <filename><pacote>.types</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1842
+#: C/index.docbook:1839
msgid "Still no class hierarchy."
msgstr "Ainda sem hierarquia."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1843
+#: C/index.docbook:1840
msgid ""
"Missing or wrong naming in <filename><package>-sections.txt</filename> "
"file (see <ulink url=\"http://mail.gnome.org/archives/gtk-doc-list/2003-"
"gtk-doc-list/2003-October/msg00006.html\">explicação</ulink>)."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1849
+#: C/index.docbook:1846
msgid "Damn, I have still no class hierarchy."
msgstr "Droga. Eu ainda não tenho hierarquia de classes."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1850
+#: C/index.docbook:1847
msgid ""
"Is the object name (name of the instance struct, e.g. <type>GtkWidget</"
"type>) part of the normal section (don't put this into Standard or Private "
"subsções Standard ou Private)?"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1857
+#: C/index.docbook:1854
msgid "No symbol index."
msgstr "Nenhum símbolo de índice."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1858
+#: C/index.docbook:1855
msgid ""
"Does the <filename><package>-docs.{xml,sgml}</filename> contain a "
"index that xi:includes the generated index?"
"\"xi:inclui\" o índice gerado?"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1864
+#: C/index.docbook:1861
msgid "Symbols are not linked to their doc-section."
msgstr "Símbolos não estão vinculados ao seus doc-section."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1865
+#: C/index.docbook:1862
msgid ""
"Is the doc-comment using the correct markup (added #,% or ())? Check if the "
"gtkdoc-fixxref warns about unresolvable xrefs."
"Verifique se o gtkdoc-fixxref avisa sobre xrefs não resolvidos."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1871
+#: C/index.docbook:1868
msgid "A new class does not appear in the docs."
msgstr "Uma nova classe não aparece nos documentos."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1872
+#: C/index.docbook:1869
msgid ""
"Is the new page xi:included from <filename><package>-docs.{xml,sgml}</"
"filename>."
"</filename>?"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1878
+#: C/index.docbook:1875
msgid "A new symbol does not appear in the docs."
msgstr "Um novo símbolo não aparece nos documentos."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1879
+#: C/index.docbook:1876
msgid ""
"Is the doc-comment properly formatted. Check for spelling mistakes in the "
"begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable "
"<filename><pacote>-sections.txt</filename> em uma subseção pública."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1887
+#: C/index.docbook:1884
msgid "A type is missing from the class hierarchy."
msgstr "Um tipo está faltando da hierarquia de classe."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1888
+#: C/index.docbook:1885
msgid ""
"If the type is listed in <filename><package>.hierarchy</filename> but "
"not in <filename>xml/tree_index.sgml</filename> then double check that the "
"listada ou incidentalmente marcada como privada, ela não será mostrada."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1897
+#: C/index.docbook:1894
msgid "I get foldoc links for all gobject annotations."
msgstr ""
"Obtenho links de seguimento de documentos para todas as anotações gobject."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1898
+#: C/index.docbook:1895
msgid ""
"Check that <filename>xml/annotation-glossary.xml</filename> is xi:included "
"from <filename><package>-docs.{xml,sgml}</filename>."
"incluído\" de <filename><pacote>-docs.{xml,sgml}</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1906
+#: C/index.docbook:1903
msgid "Parameter described in source code comment block but does not exist"
msgstr "Parâmetro descrito no bloco de comentário do código fonte não existe"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1907
+#: C/index.docbook:1904
msgid ""
"Check if the prototype in the header has different parameter names as in the "
"source."
"fonte."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1912
+#: C/index.docbook:1909
msgid "multiple \"IDs\" for constraint linkend: XYZ"
msgstr "Múltiplos \"IDs\" para restrições do fim do link XYZ"
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1913
+#: C/index.docbook:1910
msgid ""
"Symbol XYZ appears twice in <filename><package>-sections.txt</"
"filename> file."
"sections.txt</filename>."
#. (itstool) path: seglistitem/seg
-#: C/index.docbook:1916
+#: C/index.docbook:1913
msgid ""
"Element typename in namespace '' encountered in para, but no template "
"matches."
"correspondeu."
#. (itstool) path: chapter/title
-#: C/index.docbook:1923
+#: C/index.docbook:1920
msgid "Tools related to gtk-doc"
msgstr "Ferramentas relacionadas ao gtk-doc"
#. (itstool) path: chapter/para
-#: C/index.docbook:1925
+#: C/index.docbook:1922
msgid ""
"GtkDocPlugin - a <ulink url=\"http://trac-hacks.org/wiki/GtkDocPlugin\">Trac "
"GTK-Doc</ulink> integration plugin, that adds API docs to a trac site and "
"a um site trac e integra com a pesquisa do trac."
#. (itstool) path: chapter/para
-#: C/index.docbook:1930
+#: C/index.docbook:1927
msgid ""
"Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since "
"tags in the API to determine the minimum required version."
"software livre que você escolher, como por exemplo a <_:ulink-1/> (GNU "
"General Public License), para permitir seu uso em software livre."
+#~ msgid "1.18.1"
+#~ msgstr "1.18.1"
+
+#~ msgid ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink>"
+#~ msgstr ""
+#~ "<guilabel>DocBook DTD v3.0</guilabel> - Este é o DocBook SGML DTD. <ulink "
+#~ "url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora.com/"
+#~ "davenport</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting "
+#~ "SGML to various formats. <ulink url=\"http://www.jclark.com/jade\" type="
+#~ "\"http\">http://www.jclark.com/jade</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Jade v1.1</guilabel> - Este é um processador de DSSSL para "
+#~ "conversão de SGML para vários formatos. <ulink url=\"http://www.jclark."
+#~ "com/jade\" type=\"http\">http://www.jclark.com/jade</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code "
+#~ "to convert DocBook to HTML (and a few other formats). It's used together "
+#~ "with jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to "
+#~ "colour the program code listings/declarations, and to support global "
+#~ "cross-reference indices in the generated HTML. <ulink url=\"http://nwalsh."
+#~ "com/docbook/dsssl\" type=\"http\">http://nwalsh.com/docbook/dsssl</ulink>"
+#~ msgstr ""
+#~ "<guilabel>Folhas de estilo modulares do DocBook</guilabel> Este é o "
+#~ "código DSSSL para converter DocBook para HTML (e alguns outros formatos). "
+#~ "É usado junto com jade. Eu personalizei um pouco o código DSSSL, em gtk-"
+#~ "doc.dsl, para colorir as listagens/declarações do código do programa e "
+#~ "para dar suporte a índices de referências cruzadas globais nos HTML "
+#~ "gerados. <ulink url=\"http://nwalsh.com/docbook/dsssl\" type=\"http"
+#~ "\">http://nwalsh.com/docbook/dsssl</ulink>"
+
+#~ msgid ""
+#~ "<guilabel>docbook-to-man</guilabel> - if you want to create man pages "
+#~ "from the DocBook. I've customized the 'translation spec' slightly, to "
+#~ "capitalise section headings and add the 'GTK Library' title at the top of "
+#~ "the pages and the revision date at the bottom. There is a link to this on "
+#~ "<ulink url=\"http://www.ora.com/davenport\" type=\"http\">http://www.ora."
+#~ "com/davenport</ulink> NOTE: This does not work yet."
+#~ msgstr ""
+#~ "<guilabel>docbook-to-man</guilabel> - se você deseja criar páginas man a "
+#~ "partir do DocBook. Eu personalizei um pouco a \"especificação de tradução"
+#~ "\", para deixar o título em caixa alta e adicionar o título \"GTK Library"
+#~ "\" no topo das páginas e a data de revisão no canto inferior. Há também "
+#~ "um link para isso em <ulink url=\"http://www.ora.com/davenport\" type="
+#~ "\"http\">http://www.ora.com/davenport</ulink>. NOTA: isso não funciona "
+#~ "ainda."
+
+#~ msgid "Installation"
+#~ msgstr "Instalação"
+
+#~ msgid ""
+#~ "There is no standard place where the DocBook Modular Stylesheets are "
+#~ "installed."
+#~ msgstr ""
+#~ "Não há um lugar padrão onde as folhas de estilos modulares de DocBook são "
+#~ "instaladas."
+
+#~ msgid ""
+#~ "GTK-Doc's configure script searches these 3 directories automatically:"
+#~ msgstr ""
+#~ "O script de configuração do GTK-DOC pesquisa por esses três diretórios "
+#~ "automaticamente:"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by "
+#~ "RedHat)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (usado "
+#~ "pelo RedHat)"
+
+#~ msgid ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)"
+#~ msgstr ""
+#~ "<filename> /usr/lib/dsssl/stylesheets/docbook </filename> (usado pelo "
+#~ "Debian)"
+
+#~ msgid "<filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)"
+#~ msgstr "<filename> /usr/share/sgml/docbkdsl </filename> (usado pelo SuSE)"
+
+#~ msgid ""
+#~ "If you have the stylesheets installed somewhere else, you need to "
+#~ "configure GTK-Doc using the option: <command> --with-dsssl-dir=<"
+#~ "PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>"
+#~ msgstr ""
+#~ "Se você tiver as folhas de estilos instaladas em algum lugar, você "
+#~ "precisa configurar o Gtk-Doc usando a opção: <command> --with-dsssl-"
+#~ "dir=<CAMINHO_PARA_DIRETÓRIO_RAIZ_DAS_FOLHAS_DE_ESTILO> </command>"
+
+#~ msgid ""
+#~ "You may also want to enable GTK-Doc for the distcheck make target. Just "
+#~ "add the one line shown in the next example to your top-level "
+#~ "<filename>Makefile.am</filename>:"
+#~ msgstr ""
+#~ "Você pode querer habilitar o GTK-Doc para o distcheck make target. Basta "
+#~ "adicionar a linha mostrada no exemplo abaixo ao <filename>Makefile.am</"
+#~ "filename> do seu diretório raiz:"
+
+#~ msgid "Enable GTK-Doc during make distcheck"
+#~ msgstr "Habilita GTK-Doc durante make distcheck"
+
+#~ msgid ""
+#~ "\n"
+#~ "\n"
+#~ "DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
+#~ "\n"
+#~ " "
+#~ msgstr ""
+#~ "\n"
+#~ "\n"
+#~ "DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc\n"
+#~ "\n"
+#~ " "
+
+#~ msgid ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identifier:\n"
+#~ " *\n"
+#~ " * documentation ...\n"
+#~ " *\n"
+#~ " * # Sub heading #\n"
+#~ " *\n"
+#~ " * more documentation:\n"
+#~ " * - list item 1\n"
+#~ " * - list item 2\n"
+#~ " *\n"
+#~ " * Even more docs.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+#~ msgstr ""
+#~ "\n"
+#~ "\n"
+#~ "/**\n"
+#~ " * identificador:\n"
+#~ " *\n"
+#~ " * documentação ...\n"
+#~ " *\n"
+#~ " * # Subtítulo #\n"
+#~ " *\n"
+#~ " * mais documentação:\n"
+#~ " * - item de lista 1\n"
+#~ " * - item de lista 2\n"
+#~ " *\n"
+#~ " * Mais documentação.\n"
+#~ " */\n"
+#~ "\n"
+#~ " "
+
+#~ msgid ""
+#~ "Since GTK-Doc-1.18 the tool supports a subset or the <ulink url=\"http://"
+#~ "daringfireball.net/projects/markdown/\">markdown language</ulink>. One "
+#~ "can use it for sub-headings and simple itemized lists. On older GTK-Doc "
+#~ "versions the content will be rendered as it (the list items will appear "
+#~ "in one line separated by dashes). <_:example-1/>"
+#~ msgstr ""
+#~ "Desde o GTK-Doc-1.18, a ferramenta tem suporte a um subconjunto ou a "
+#~ "<ulink url=\"http://daringfireball.net/projects/markdown/\">linguagem "
+#~ "markdown</ulink>. É possível usá-la em subtítulos e listas simples "
+#~ "itemizadas. Em versões mais antigas GTK-Doc, o conteúdo será processado "
+#~ "com está (os itens da lista vai aparecer em uma linha separada por "
+#~ "traços). <_:example-1/>"
+
#~ msgid "1.15"
#~ msgstr "1.15"
<book id="index" lang="sl">
<bookinfo>
<title>GTK-Doc Manual</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>User manual for developers with instructions of GTK-Doc usage.</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<guilabel>Perl v5</guilabel> - the main scripts are in Perl.
</para>
<para>
- <guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD.
- <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting SGML to various formats.
- <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
</para>
<para>
- <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook.
- I've customized the 'translation spec' slightly, to capitalise section
- headings and add the 'GTK Library' title at the top of the pages and the
- revision date at the bottom.
- There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
- NOTE: This does not work yet.
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>
- There is no standard place where the DocBook Modular Stylesheets are installed.
- </para>
- <para>
- GTK-Doc's configure script searches these 3 directories automatically:
- </para>
- <para>
- <filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by RedHat)
- </para>
- <para>
- <filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)
- </para>
- <para>
- <filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)
- </para>
- <para>
- If you have the stylesheets installed somewhere else, you need to configure
- GTK-Doc using the option:
- <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>
- </para>
- </sect2>
-
- </sect1>
-
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
</sect1>
- -->
<sect1 id="aboutgtkdoc">
<title>About GTK-Doc</title>
</para>
<para>
- (History, authors, web pages, license, future plans,
+ (History, authors, web pages, mailing list, license, future plans,
comparison with other similar systems.)
</para>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Integration with autoconf</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Preparation for gtkdocize</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Running gtkdocize from autogen.sh</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>Running the doc build</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>Documentation placement</title>
<para>
In the past most documentation had to be filled into files residing
- inside the <filename>tmpl</filename> directory. This has the
- disadvantages that the information is often not updated and also that
- the file tend to cause conflicts with version control systems.
+ inside the <filename>tmpl</filename> directory. This has the
+ disadvantages that the information is often not updated and also that
+ the file tend to cause conflicts with version control systems.
</para>
<para>
The avoid the aforementioned problems we suggest putting the
- documentation inside the sources. This manual will only describe this
- way of documenting code.
+ documentation inside the sources. This manual will only describe this
+ way of documenting code.
</para>
</note>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Section comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<example><title>General tags</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Function comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Function tags</title>
<sect2><title>Property comment block</title>
<example><title>Property comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Signal comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct comment block</title>
<example><title>Struct comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum comment block</title>
<example><title>Enum comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Master document header</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="sv">
<bookinfo>
<title>Handbok för GTK-Doc</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>Användarhandbok för utvecklare med användningsinstruktioner för GTK-Doc.</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<guilabel>Perl v5</guilabel> - the main scripts are in Perl.
</para>
<para>
- <guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD.
- <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting SGML to various formats.
- <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
</para>
<para>
- <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook.
- I've customized the 'translation spec' slightly, to capitalise section
- headings and add the 'GTK Library' title at the top of the pages and the
- revision date at the bottom.
- There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
- NOTE: This does not work yet.
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
- <sect2 id="installation">
- <title>Installation</title>
- <para>
- There is no standard place where the DocBook Modular Stylesheets are installed.
- </para>
- <para>
- GTK-Doc's configure script searches these 3 directories automatically:
- </para>
- <para>
- <filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by RedHat)
- </para>
- <para>
- <filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)
- </para>
- <para>
- <filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)
- </para>
- <para>
- If you have the stylesheets installed somewhere else, you need to configure
- GTK-Doc using the option:
- <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>
- </para>
- </sect2>
-
- </sect1>
-
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
</sect1>
- -->
<sect1 id="aboutgtkdoc">
<title>Om GTK-Doc</title>
</para>
<para>
- (History, authors, web pages, license, future plans,
+ (History, authors, web pages, mailing list, license, future plans,
comparison with other similar systems.)
</para>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Integration with autoconf</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Förberedelse för gtkdocize</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>Running gtkdocize from autogen.sh</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>Running the doc build</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<title>Documentation placement</title>
<para>
In the past most documentation had to be filled into files residing
- inside the <filename>tmpl</filename> directory. This has the
- disadvantages that the information is often not updated and also that
- the file tend to cause conflicts with version control systems.
+ inside the <filename>tmpl</filename> directory. This has the
+ disadvantages that the information is often not updated and also that
+ the file tend to cause conflicts with version control systems.
</para>
<para>
The avoid the aforementioned problems we suggest putting the
- documentation inside the sources. This manual will only describe this
- way of documenting code.
+ documentation inside the sources. This manual will only describe this
+ way of documenting code.
</para>
</note>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Section comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<example><title>General tags</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Function comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>Function tags</title>
<sect2><title>Property comment block</title>
<example><title>Property comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>Signal comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct comment block</title>
<example><title>Struct comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum comment block</title>
<example><title>Enum comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Master document header</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="ta">
<bookinfo>
<title>ஜிடிகே டாக் கையேடு</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>உருவாக்குவோருக்கான ஜிடிகே டாக்(GTK-Doc) பயன்பாட்டு பயனர் கையேடு </para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<guilabel>Perl v5</guilabel> - the main scripts are in Perl.
</para>
<para>
- <guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD.
- <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting SGML to various formats.
- <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
</para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
- <para> நீங்கள் டாக்புக் இலிருந்து மேன் பக்கங்களை தயாரிக்க விரும்பினால் ..மொழிபெயர்ப்பு குறிப்புக்களை சற்றே நான் மாற்றியுள்ளேன். தொகுப்பு தலைப்புகள் மேலெழுத்தில் காட்டப்படும். ஜிடிகே நூலகம் என்னும் தலைப்பு ('GTK Library') பக்கங்களின் மேலே காட்டப்படும். திருத்திய தேதி கீழே காட்டப்படும். இதற்கு இங்கு ஒரு தொடுப்பு உள்ளது: <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> குறிப்பு: இது இன்னும் செயலில் இல்லை..</para>
- </sect2>
-
- <sect2 id="installation">
- <title>நிறுவல்</title>
- <para>மாடுலர் டாக் புக் ஸ்டைய்ல்ஷீட்ஸ் நிறுவப்பட செந்தரமான இடமில்லை.</para>
- <para>ஜிடிகே டாக் இன் வடிவமைக்கும் குறுநிரல் மூன்று அடைவுகளை தானியங்கியாக பார்க்கும்.</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (ரெட் ஹாட் ஆல் பயன்படுத்தப்படுவது)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (டெபியன் ஆல் பயன்படுத்தப்படுவது)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (சூசே ஆல் பயன்படுத்தப்படுவது)</para>
- <para>ஸ்டைய்ல் ஷீட் கள் வேறெங்கும் நிறுவி இருப்பின் கை முறையாக ஜிடிகே டாக் ஐ வடிவமைக்க வேண்டும். கட்டளை தேர்ர்வு: <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command> </para>
</sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>ஜிடிகே டாக் பற்றி</title>
<para>(FIXME)</para>
- <para>(வரலாறு, ஆசிரியர்கள், வலைப்பக்கங்கள், உரிமை, எதிர்கால திட்டங்கள், மற்ற இதே போன்ற அமைப்புகளுடன் ஒப்பீடு)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>ஆட்டோ கான்ஃப் உடன் ஒருங்கிணைப்பு</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>gtkdocize க்கு முன்னேற்பாடு</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>autogen.sh இலிருந்து gtkdocize ஐ இயக்குதல்</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>டாக் உருவாக்கியை (doc build) இயக்குதல்</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>இப்போது உங்கள் உலாவியை <filename>docs/reference/<package>/index.html</filename> க்கு சுட்டிக்காட்டலாம். ஆமாம், இது கொஞ்சம் ஏமாற்றமாகத்தான் இருக்கிறது. கவலை வேண்டாம். அடுத்த அத்தியாயத்தில் எப்படி இவற்றை உயிருக்கு கொண்டு வருவது என பார்க்கலாம்.</para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>பிரிவு விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>FIXME : Stability information)</para>
<example><title>பொது டேக் ஒட்டுகள்</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>பங்ஷன் விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>பங்ஷன் டேக் ஒட்டுகள்</title>
<sect2><title>பண்புகள் விமரிசன தொகுதி</title>
<example><title>பண்புகள் விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>சமிக்ஞை விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>அமைப்பு விமரிசன தொகுதி</title>
<example><title>அமைப்பு விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>ஈநம் விமரிசன தொகுதி</title>
<example><title>ஈநம் விமரிசன தொகுதி</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>முதன்மை ஆவணத்தின் தலைப்பு</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="te">
<bookinfo>
<title>GTK-Doc మాన్యుయల్</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>GTK-Doc వినియోగపు సూచనలతో అభివృద్దికారుల కొరకు వినియోగదారి మాన్యుయల్.</para></abstract>
<authorgroup>
<author>
</author>
<author>
<firstname>Stefan</firstname>
- <surname>Kost</surname>
+ <surname>Sauer (Kost)</surname>
<affiliation>
<address>
<email>ensonic@users.sf.net</email>
<holder>Dan Mueth and Chris Lyttle</holder>
</copyright>
<copyright>
- <year>2007-2011</year>
+ <year>2007-2014</year>
<holder>Stefan Sauer (Kost)</holder>
</copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>అవసరములు</title>
<para><guilabel>Perl v5</guilabel> - ముఖ్య స్క్రిప్టులు Perl1 నందు వున్నవి.</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - ఇది DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> - SGMLను వివిధ ఫార్మాట్ల లోనికి మార్చుటకు యిది DSSSL ప్రోసెసర్. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
- <para><guilabel>Modular DocBook Stylesheets</guilabel> DocBookను HTMLకు (యింకా కొన్ని యితర ఫార్మాట్లకు) మార్చుటకు యిది DSSSL కోడ్. ఇది jadeతో కలిపి వుపయోగించబడును. నేను DSSSL కోడ్ను కొద్దిగా మలచుకొనినాను, gtk-doc.dsl నందు, ప్రోగ్రామ్ కోడ్ జాబితాలు/డిక్లరేషన్లను రంగులో వుంచుటకు, మరియు జనియింపచేసిన HTML నందు గ్లోబల్ క్రాస్-రిఫరెన్సెస్ యిండిసెస్ను మద్దతించుటకు. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink></para>
- <para><guilabel>docbook-to-man</guilabel> - DocBook నుండి man పేజీలను సృష్టించాలని అనుకొంటే. నేను 'translation spec' ను కొద్దిగా మలచుకొనినాను, విభగాపు హెడ్డింగులను పెద్దఅక్షరములలో వుంచుకొనుటకు మరియు పేజీల యొక్క పైభాగమున 'GTK Library' శీర్షికను జతచేయుటకు మరియు క్రిందన పునఃపరిశీలన తేదీను వుంచుటకు. దీనికి <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> పైన వొక లింకు వుంది. గమనిక: ఇంది యింకా పనిచేయుటలేదు.</para>
- </sect2>
-
- <sect2 id="installation">
- <title>సంస్థాపన</title>
- <para>DocBook మాడ్యులర్ స్టైల్షీట్లు యిక్కడ సంస్థాపించాలని వొక ప్రామాణిక స్థలము యేమీలేదు.</para>
- <para>GTK-Doc యొక్క ఆకృతీకరణ స్క్రిప్టు ఈ 3 డైరెక్టరీలను స్వయంచాలకంగా శోధిస్తుంది:</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (RedHat ద్వారా వుపయోగించబడింది)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (Debian ద్వారా వుపయోగించబడింది)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (SuSE ద్వారా వుపయోగించబడింది)</para>
- <para>మీరు యెక్కడోవొకచోట స్టైల్షీట్లను సంస్థాపించివుంటే, మీరు GTK-Docను ఈ ఐచ్చికము వుపయోగించి ఆకృతీకరించవలసి వుంటుంది: <command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command></para>
+ <para>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
+ </para>
+ <para>
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
+ </para>
</sect2>
-
- </sect1>
-
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
</sect1>
- -->
<sect1 id="aboutgtkdoc">
<title>GTK-Doc గురించి</title>
<para>(FIXME)</para>
- <para>(చరిత్ర, మూలకర్తలు, వెబ్ పుటలు, లైసెన్స్, భవిష్య ప్రణాళికలు, సమానమైన యితర సిస్టమ్సుతో పోలిక.)</para>
+ <para>
+ (History, authors, web pages, mailing list, license, future plans,
+ comparison with other similar systems.)
+ </para>
</sect1>
<para>
This can then look as shown below:
<example><title>Example directory structure</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>autoconf తో విలీనం</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>gtkdocize కొరకు సన్నాహం</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>autogen.sh నుండి gtkdocize నడుపుతోంది</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
gtkdocize || exit 1
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>doc బుల్డును నడుపుట</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>ఇప్పుడు మీ బ్రౌజర్కు మీరు <filename>docs/reference/<package>/index.html</filename>ను సూచించవచ్చును. అవును, యిప్పటికి యిది కొంత నిరుత్సాహపరుస్తోంది. అయితే ఆగండి, తరువాతి అధ్యాయమునందు పేజీలను యెలా నింపాలో చెబుతాము.</para>
<para>
<example><title>Documentation build steps</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>విభాగపు వ్యాఖ్య బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : స్థిరత్వ సమాచారము)</para>
<example><title>సాధారణ టాగ్లు</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>ఫంక్షన్ వ్యాఖ్యానపు బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>ఫంక్షన్ టాగ్లు</title>
<sect2><title>లక్షణము వ్యాఖ్యాము బ్లాక్</title>
<example><title>లక్షణము వ్యాఖ్యాము బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
* Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>సంకేతపు వ్యాఖ్యానము బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
* @widget: the widget that received the signal
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>Struct వ్యాఖ్యానము బ్లాక్</title>
<example><title>Struct వ్యాఖ్యానము బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
/*< public >*/
gboolean bar;
} FooWidget;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
<sect2><title>Enum వ్యాఖ్యానము బ్లాక్</title>
<example><title>Enum వ్యాఖ్యానము బ్లాక్</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
<para>
To refer to an external function, e.g. a standard C function:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<function>...</function>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include example code:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<example>
<title>Using a GHashTable.</title>
<programlisting>
...
</programlisting>
</example>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
or possibly this, for very short code fragments which don't need a title:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<informalexample>
<programlisting>
...
</programlisting>
</informalexample>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
For the latter GTK-Doc also supports an abbreviation:
<![CDATA[
<para>
To include bulleted lists:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To include a note which stands out from the text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<note>
<para>
Make sure you free the data after use.
</para>
</note>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a type:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<type>unsigned char</type>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to an external structure (not one described in the GTK docs):
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structname>XFontStruct</structname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a field of a structure:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<structfield>len</structfield>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to a class name, we could possibly use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<classname>GtkWidget</classname>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
but you'll probably be using #GtkWidget instead (to automatically create
a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
<para>
To emphasize text:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<emphasis>This is important</emphasis>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
For filenames use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<filename>/home/user/documents</filename>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
To refer to keys use:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
</para>
<para>
<example><title>Example types file snippet</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>Master document header</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<bookinfo>
<title>MODULENAME Reference Manual</title>
<releaseinfo>
<chapter>
<title>[Insert title here]</title>
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>Extra configure checks</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<book id="index" lang="zh-CN">
<bookinfo>
<title>GTK-Doc 手册</title>
- <edition>1.18.1</edition>
+ <edition>1.20</edition>
<abstract role="description"><para>为开发人员提供 GTK-Doc 用法说明的用户手册。</para></abstract>
<authorgroup>
<author><firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation></author>
<author><firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation></author>
- <author><firstname>Stefan</firstname> <surname>Kost</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation></author>
+ <author>
+ <firstname>Stefan</firstname>
+ <surname>Sauer (Kost)</surname>
+ <affiliation>
+ <address>
+ <email>ensonic@users.sf.net</email>
+ </address>
+ </affiliation>
+ </author>
</authorgroup>
<publisher role="maintainer"><publishername>GTK-Doc 项目</publishername> <address><email>gtk-doc-list@gnome.org</email></address></publisher>
<copyright><year>2000, 2005</year> <holder>Dan Mueth and Chris Lyttle</holder></copyright>
- <copyright><year>2007-2011</year> <holder>Stefan Sauer (Kost)</holder></copyright>
+ <copyright>
+ <year>2007-2014</year>
+ <holder>Stefan Sauer (Kost)</holder>
+ </copyright>
<!-- translators: uncomment this:
<copyright>
<revhistory>
<revision>
- <revnumber>1.19.1</revnumber>
- <date>05 Jun 2013</date>
+ <revnumber>1.20.1</revnumber>
+ <date>16 Feb 2014</date>
<authorinitials>ss</authorinitials>
<revremark>development version</revremark>
- </revision>
+ </revision>
+ <revision>
+ <revnumber>1.20</revnumber>
+ <date>16 Feb 2014</date>
+ <authorinitials>ss</authorinitials>
+ <revremark>bug fixes, markdown support, style improvements</revremark>
+ </revision>
<revision>
<revnumber>1.19</revnumber>
<date>05 Jun 2013</date>
<sect2 id="requirements">
<title>要求</title>
<para><guilabel>Perl v5</guilabel>- 主脚本是Perl格式。</para>
- <para><guilabel>DocBook DTD v3.0</guilabel> - 这是DocBook SGML DTD的链接. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink></para>
- <para><guilabel>Jade v1.1</guilabel> -这是一个DSSSL处理器，用来把SGML转换为各种格式。<ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink></para>
<para>
- <guilabel>Modular DocBook Stylesheets</guilabel>
- This is the DSSSL code to convert DocBook to HTML (and a few other
- formats). It's used together with jade.
- I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour
- the program code listings/declarations, and to support global
- cross-reference indices in the generated HTML.
- <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
+ <guilabel>xsltproc</guilabel> - the xslt processor from libxslt
+ <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
</para>
<para>
- <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook.
- I've customized the 'translation spec' slightly, to capitalise section
- headings and add the 'GTK Library' title at the top of the pages and the
- revision date at the bottom.
- There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
- NOTE: This does not work yet.
+ <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets
+ <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
+ </para>
+ <para>
+ <guilabel>Python</guilabel> - optional - for gtkdoc-depscan
+ </para>
+ <para>
+ One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or
+ <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
</para>
</sect2>
-
- <sect2 id="installation">
- <title>安装</title>
- <para>DocBook Modular Stylesheets没有标准的安装位置。</para>
- <para>GTK-Doc 的配置脚本会自动地查找这三个目录：</para>
- <para><filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (在 RedHat 中使用)</para>
- <para><filename> /usr/lib/dsssl/stylesheets/docbook </filename> (在 Debian 中使用)</para>
- <para><filename> /usr/share/sgml/docbkdsl </filename> (在 SuSE 中使用)</para>
- <para>如果把样式表安装在其它地方，您必须用这个选项来配置GTK-Doc：<command> --with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR> </command>。</para>
- </sect2>
-
</sect1>
- <!-- not realy worth a section
- <sect1 id="whentousegtkdoc">
- <title>When to Use GTK-Doc</title>
-
- <para>
- (What things GTK-Doc should, and shouldn't, be used for.)
- (- ???)
- (- non C-based projects)
- (+ Tutorials)
- </para>
-
- </sect1>
- -->
-
<sect1 id="aboutgtkdoc">
<title>关于 GTK-Doc</title>
</para>
<para>
- (History, authors, web pages, license, future plans,
+ (History, authors, web pages, mailing list, license, future plans,
comparison with other similar systems.)
</para>
</para>
<para>目录结构将会如下所示：<example><title>范例目录结构</title>
- <programlisting>
-
+ <programlisting><![CDATA[
meep/
docs/
reference/
src/
libmeep/
meeper/
-
- </programlisting>
+]]></programlisting>
</example></para>
</sect1>
<para>
<example><title>与autoconf集成</title>
- <programlisting>
-
-# 检查 gtk-doc
+ <programlisting><![CDATA[
+# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-
- </programlisting>
+]]></programlisting>
</example>
</para>
solve this as below. Keep it as is, as gtkdocize is looking for
<function>GTK_DOC_CHECK</function> at the start of a line.
<example><title>Keep gtk-doc optional</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>准备gtkdocize</title>
- <programlisting>
-
+ <programlisting><![CDATA[
AC_CONFIG_MACRO_DIR(m4)
-
- </programlisting>
+]]></programlisting>
</example>
</para>
+ <para>
+ After all changes to <filename>configure.ac</filename> are made, update
+ the <filename>configure</filename> file. This can be done by re-running
+ <code>autoreconf -i</code> or <code>autogen.sh</code>.
+ </para>
</sect1>
<sect1 id="settingup_automake">
<para>
<example><title>从autogen.sh中运行gtkdocize</title>
- <programlisting>
-
+ <programlisting><![CDATA[
gtkdocize || exit 1
-
- </programlisting>
+]]></programlisting>
</example>
</para>
</para>
<para>
<example><title>运行文档构建</title>
- <programlisting>
-
+ <programlisting><![CDATA[
./autogen.sh --enable-gtk-doc
make
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<para>
<example><title>文档构建步骤</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
DOC_MODULE=meep
// sources have changed
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
mkdir html
cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
receiving warnings from the scanner that look like a special case, one can
hint GTK-Doc to skip over them.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
A multiline comment that starts with an additional '*' marks a
documentation block that will be processed by the GTK-Doc tools.
<example><title>GTK-Doc comment block</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
* documentation ...
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>GTK-Doc comment block using Markdown</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* identifier:
*
* GtkWidget *label = gtk_label_new ("Gorgeous!");
* ]|
*/
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>节注释块</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SECTION:meepapp
* @short_description: the application class
*
* The application class handles ...
*/
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>(FIXME : 稳定性信息)</para>
<example><title>一般标记</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* foo_get_bar:
* @foo: some foo
foo_get_bar(Foo *foo)
{
...
-]]>
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</para>
<example><title>函数注释块</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* function_name:
- * @par1: 对参数 1 的描述。
- * 可超过一行。
- * @par2: 对参数 2 的描述
- * @...: 一个以 %NULL 终止的 bars 列表
+ * @par1: description of parameter 1. These can extend over more than
+ * one line.
+ * @par2: description of parameter 2
+ * @...: a %NULL-terminated list of bars
*
- * 这里是函数描述。您可以用 @par1 引用参数，这样在输出中它们会突出显示。
- * 您也可以使用 %constant 代表常量，function_name2() 代表函数，#GtkWidget
- * 代表指向指向其他声明的链接(可能在其他位置描述)。
+ * The function description goes here. You can use @par1 to refer to parameters
+ * so that they are highlighted in the output. You can also use %constant
+ * for constants, function_name2() for functions and #GtkWidget for links to
+ * other declarations (which may be documented elsewhere).
*
- * 返回值: 一个整型值。
+ * Returns: an integer.
*
- * 始于: 2.2
- * 废弃: 2.18: 请转用 other_function()。
+ * Since: 2.2
+ * Deprecated: 2.18: Use other_function() instead.
*/
-
- </programlisting>
+]]></programlisting>
</example>
<variablelist><title>函数标记</title>
<sect2><title>属性注释块</title>
<example><title>属性注释块</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* SomeWidget:some-property:
*
- * 这里您可以描述一个属性。
+ * Here you can document a property.
*/
g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
</itemizedlist></para>
<example><title>信号注释块</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget::foobarized:
- * @widget: 接受信号的窗口部件
+ * @widget: the widget that received the signal
* @foo: some foo
* @bar: some bar
*
- * ::foobarized 信号在每次有人尝试 foobarize @widget 时发射。
+ * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
*/
foo_signals[FOOBARIZE] =
g_signal_new ("foobarize",
...
-
- </programlisting>
+]]></programlisting>
</example>
</sect2>
<sect2><title>结构注释块</title>
<example><title>结构注释块</title>
- <programlisting>
-
+ <programlisting><![CDATA[
/**
* FooWidget:
* @bar: some #gboolean
*
- * 这是史上最好的窗口部件。
+ * This is the best widget, ever.
*/
typedef struct _FooWidget {
- /*< private >*/
+ /*< private >*/
GtkWidget parent;
- /*< public >*/
+ /*< public >*/
gboolean bar;
} FooWidget;
-
- </programlisting>
+]]></programlisting>
</example>
<para>在你需要隐藏的私有结构字段之前使用<code>/*< private >*/</code> 。反之使用<code>/*< public >*/</code>.</para>
<sect2><title>枚举注释块</title>
<example><title>枚举注释块</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
/**
* Something:
* @SOMETHING_FOO: something foo
/*< private >*/
SOMETHING_COUNT
} Something;
-]]>
- </programlisting>
+]]></programlisting>
</example>
<para>在你要隐藏的枚举数值前使用<code>/*< private >*/</code>。反之使用<code>/*< public >*/</code> 。</para>
To link to another section in the GTK docs:
<informalexample>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
<link linkend="glib-Hash-Tables">Hash Tables</link>
-]]>
- </programlisting>
+]]></programlisting>
</informalexample>
The linkend is the SGML/XML id on the top item of the page you want to link to.
For most pages this is currently the part ("gtk", "gdk", "glib") and then
</para>
<para>引用一个外部函数，比如一个标准 C 函数：<informalexample>
- <programlisting>
-
-<function>...</function>
-
- </programlisting>
+ <programlisting><![CDATA[
+<function>...</function>
+]]></programlisting>
</informalexample></para>
<para>要包含示例代码：<informalexample>
- <programlisting>
-
-<example>
- <title>Using a GHashTable.</title>
- <programlisting>
+ <programlisting><![CDATA[
+<example>
+ <title>Using a GHashTable.</title>
+ <programlisting>
...
- </programlisting>
-</example>
-
- </programlisting>
+ </programlisting>
+</example>
+]]></programlisting>
</informalexample> 或类似的，很短的不需要标题的代码段：<informalexample>
- <programlisting>
-
-<informalexample>
- <programlisting>
+ <programlisting><![CDATA[
+<informalexample>
+ <programlisting>
...
- </programlisting>
-</informalexample>
-
- </programlisting>
+ </programlisting>
+</informalexample>
+]]></programlisting>
</informalexample> 对后者，GTK-Doc 还支持一种缩写方式：|[ ... ]|</para>
<para>要包含符号列表：<informalexample>
- <programlisting>
-
-<itemizedlist>
- <listitem>
- <para>
+ <programlisting><![CDATA[
+<itemizedlist>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
...
- </para>
- </listitem>
-</itemizedlist>
-
- </programlisting>
+ </para>
+ </listitem>
+</itemizedlist>
+]]></programlisting>
</informalexample></para>
<para>要包含一条文字中突出显示的注解：<informalexample>
- <programlisting>
-
-<note>
- <para>
+ <programlisting><![CDATA[
+<note>
+ <para>
Make sure you free the data after use.
- </para>
-</note>
-
- </programlisting>
+ </para>
+</note>
+]]></programlisting>
</informalexample></para>
<para>要引用一个类型：<informalexample>
- <programlisting>
-
-<type>unsigned char</type>
-
- </programlisting>
+ <programlisting><![CDATA[
+<type>unsigned char</type>
+]]></programlisting>
</informalexample></para>
<para>引用一个外部结构（不是在GTK 文档中描述的）：<informalexample>
- <programlisting>
-
-<structname>XFontStruct</structname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structname>XFontStruct</structname>
+]]></programlisting>
</informalexample></para>
<para>要引用一个结构字段：<informalexample>
- <programlisting>
-
-<structfield>len</structfield>
-
- </programlisting>
+ <programlisting><![CDATA[
+<structfield>len</structfield>
+]]></programlisting>
</informalexample></para>
<para>要引用一个类的名字，你可能会使用：<informalexample>
- <programlisting>
-
-<classname>GtkWidget</classname>
-
- </programlisting>
+ <programlisting><![CDATA[
+<classname>GtkWidget</classname>
+]]></programlisting>
</informalexample> 但是你可能正在使用#GtkWidget（要自动创建一个到GtkWidget 页面的链接－请参阅<link linkend="documenting_syntax">缩写</link>）。</para>
<para>要强调文本：<informalexample>
- <programlisting>
-
-<emphasis>This is important</emphasis>
-
- </programlisting>
+ <programlisting><![CDATA[
+<emphasis>This is important</emphasis>
+]]></programlisting>
</informalexample></para>
<para>对于文件名，使用：<informalexample>
- <programlisting>
-
-<filename>/home/user/documents</filename>
-
- </programlisting>
+ <programlisting><![CDATA[
+<filename>/home/user/documents</filename>
+]]></programlisting>
</informalexample></para>
<para>要引用键值，使用：<informalexample>
- <programlisting>
-
-<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
-
- </programlisting>
+ <programlisting><![CDATA[
+<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
+]]></programlisting>
</informalexample></para>
</sect1>
<para>
<example><title>示例类型文件代码段</title>
- <programlisting>
-
-#include <gtk/gtk.h>
+ <programlisting><![CDATA[
+#include <gtk/gtk.h>
gtk_accel_label_get_type
gtk_adjustment_get_type
gtk_alignment_get_type
gtk_arrow_get_type
-
- </programlisting>
+]]></programlisting>
</example>
</para>
<para>
<example><title>主文档头部</title>
- <programlisting>
-
-<bookinfo>
- <title>MODULENAME Reference Manual</title>
- <releaseinfo>
+ <programlisting><![CDATA[
+<bookinfo>
+ <title>MODULENAME Reference Manual</title>
+ <releaseinfo>
for MODULENAME [VERSION]
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
- </releaseinfo>
-</bookinfo>
-
-<chapter>
- <title>[Insert title here]</title>
+ <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
+ </releaseinfo>
+</bookinfo>
- </programlisting>
+<chapter>
+ <title>[Insert title here]</title>
+]]></programlisting>
</example>
</para>
a set of sanity checks on your documentation. It is enabled by adding
these lines to the end of <filename>Makefile.am</filename>.
<example><title>Enable gtkdoc-check</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = \
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
TESTS = $(GTKDOC_CHECK)
endif
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect1>
<para>
<example><title>额外的配置检查</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
AC_ARG_ENABLE(man,
[AC_HELP_STRING([--enable-man],
[regenerate man pages from Docbook [default=no]])],enable_man=yes,
AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
<para>
<example><title>额外的配置检查</title>
- <programlisting>
-<![CDATA[
+ <programlisting><![CDATA[
man_MANS = \
meeper.1
BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml
-]]>
- </programlisting>
+]]></programlisting>
</example>
</para>
</sect2>
vertical-align: top;
}
-@media screen {
- sup a.footnote
- {
- position: relative;
- top: 0em ! important;
- }
- /* this is needed so that the local anchors are displayed below the naviagtion */
- div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name]
- {
- display: inline-block;
- position: relative;
- top:-5em;
- }
- /* this seems to be a bug in the xsl style sheets when generating indexes */
- div.index div.index
- {
- top: 0em;
- }
- /* make space for the fixed navigation bar and add space at the bottom so that
- * link targets appear somewhat close to top
- */
- body
- {
- padding-top: 5em;
- padding-bottom: 500px;
- max-width: 60em;
- }
- p
- {
- max-width: 60em;
- }
- /* style and size the navigation bar */
- table.navigation#top
- {
- position: fixed;
- background: #e2e2e2;
- border-bottom: solid 1px #babdb6;
- margin-top: 0;
- margin-bottom: 0;
- top: 0;
- left: 0;
- height: 3em;
- z-index: 10;
- }
- .navigation a, .navigation a:visited
- {
- /* tango:sky blue 3 */
- color: #204a87;
- }
- .navigation a:hover
- {
- /* tango:sky blue 2 */
- color: #3465a4;
- }
- td.shortcuts
- {
- /* tango:sky blue 2 */
- color: #3465a4;
- font-size: 80%;
- white-space: nowrap;
- }
- td.shortcuts .dim
- {
- color: #babdb6;
- }
-}
-@media screen and (min-width: 60em) {
- /* screen larger than 60em */
- body { margin: auto; }
-}
-@media screen and (max-width: 60em) {
- /* screen less than 60em */
- #nav_hierarchy { display: none; }
- #nav_interfaces { display: none; }
- #nav_prerequisites { display: none; }
- #nav_derived_interfaces { display: none; }
- #nav_implementations { display: none; }
- #nav_child_properties { display: none; }
- #nav_style_properties { display: none; }
- #nav_index { display: none; }
- #nav_glossary { display: none; }
- .gallery_image { display: none; }
- .property_flags { display: none; }
- .signal_flags { display: none; }
- .parameter_annotations { display: none; }
- .enum_member_annotations { display: none; }
- .struct_member_annotations { display: none; }
- .union_member_annotations { display: none; }
- /* now that a column is hidden, optimize space */
- col.parameters_name { width: auto; }
- col.parameters_description { width: auto; }
- col.struct_members_name { width: auto; }
- col.struct_members_description { width: auto; }
- col.enum_members_name { width: auto; }
- col.enum_members_description { width: auto; }
- col.union_members_name { width: auto; }
- col.union_members_description { width: auto; }
-}
-@media print {
- table.navigation {
- visibility: collapse;
- display: none;
- }
- div.titlepage table.navigation {
- visibility: visible;
- display: table;
- background: #e2e2e2;
- border: solid 1px #babdb6;
- margin-top: 0;
- margin-bottom: 0;
- top: 0;
- left: 0;
- height: 3em;
- }
-}
-
-.navigation .title
-{
- font-size: 120%;
-}
-
div.gallery-float
{
float: left;
div.informaltable table
{
border-collapse: separate;
- border-spacing: 20px 3px;
+ border-spacing: 1em 0.5em;
border: none;
}
color: #729fcf;
}
+td p
+{
+ margin: 0.25em;
+}
+
div.table table
{
border-collapse: collapse;
font-weight: normal;
}
+acronym,abbr
+{
+ border-bottom: 1px dotted gray;
+}
+
/* code listings */
-.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */
-.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */
-.listing_code .programlisting .function { color: #000000; font-weight: bold; }
-.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */
-.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */
+.listing_code .programlisting .normal,
+.listing_code .programlisting .normal a,
+.listing_code .programlisting .number,
+.listing_code .programlisting .cbracket,
+.listing_code .programlisting .symbol { color: #555753; }
+.listing_code .programlisting .comment,
.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */
-.listing_code .programlisting .normal { color: #000000; }
-.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */
+.listing_code .programlisting .function,
+.listing_code .programlisting .function a,
.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */
-.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */
-.listing_code .programlisting .type { color: #000000; }
-.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */
-.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */
+.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */
+.listing_code .programlisting .keyword,
+.listing_code .programlisting .usertype,
+.listing_code .programlisting .type,
+.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */
.listing_frame {
/* tango:sky blue 1 */
margin-bottom: 0px;
padding: 0.5em;
}
-.listing_lines {
- /* this just adds visual clutter and
- takes precious room from small screens */
- display: none;
-}
.listing_lines {
/* tango:sky blue 0.5 */
background: #a6c5e3;
margin: 0px;
}
+@media screen {
+ sup a.footnote
+ {
+ position: relative;
+ top: 0em ! important;
+ }
+ /* this is needed so that the local anchors are displayed below the naviagtion */
+ div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name]
+ {
+ display: inline-block;
+ position: relative;
+ top:-5em;
+ }
+ /* this seems to be a bug in the xsl style sheets when generating indexes */
+ div.index div.index
+ {
+ top: 0em;
+ }
+ /* make space for the fixed navigation bar and add space at the bottom so that
+ * link targets appear somewhat close to top
+ */
+ body
+ {
+ padding-top: 2.5em;
+ padding-bottom: 500px;
+ max-width: 60em;
+ }
+ p
+ {
+ max-width: 60em;
+ }
+ /* style and size the navigation bar */
+ table.navigation#top
+ {
+ position: fixed;
+ background: #e2e2e2;
+ border-bottom: solid 1px #babdb6;
+ border-spacing: 5px;
+ margin-top: 0;
+ margin-bottom: 0;
+ top: 0;
+ left: 0;
+ z-index: 10;
+ }
+ table.navigation#top td
+ {
+ padding-left: 6px;
+ padding-right: 6px;
+ }
+ .navigation a, .navigation a:visited
+ {
+ /* tango:sky blue 3 */
+ color: #204a87;
+ }
+ .navigation a:hover
+ {
+ /* tango:sky blue 2 */
+ color: #3465a4;
+ }
+ td.shortcuts
+ {
+ /* tango:sky blue 2 */
+ color: #3465a4;
+ font-size: 80%;
+ white-space: nowrap;
+ }
+ td.shortcuts .dim
+ {
+ color: #babdb6;
+ }
+ .navigation .title
+ {
+ font-size: 80%;
+ max-width: none;
+ margin: 0px;
+ font-weight: normal;
+ }
+}
+@media screen and (min-width: 60em) {
+ /* screen larger than 60em */
+ body { margin: auto; }
+}
+@media screen and (max-width: 60em) {
+ /* screen less than 60em */
+ #nav_hierarchy { display: none; }
+ #nav_interfaces { display: none; }
+ #nav_prerequisites { display: none; }
+ #nav_derived_interfaces { display: none; }
+ #nav_implementations { display: none; }
+ #nav_child_properties { display: none; }
+ #nav_style_properties { display: none; }
+ #nav_index { display: none; }
+ #nav_glossary { display: none; }
+ .gallery_image { display: none; }
+ .property_flags { display: none; }
+ .signal_flags { display: none; }
+ .parameter_annotations { display: none; }
+ .enum_member_annotations { display: none; }
+ .struct_member_annotations { display: none; }
+ .union_member_annotations { display: none; }
+ /* now that a column is hidden, optimize space */
+ col.parameters_name { width: auto; }
+ col.parameters_description { width: auto; }
+ col.struct_members_name { width: auto; }
+ col.struct_members_description { width: auto; }
+ col.enum_members_name { width: auto; }
+ col.enum_members_description { width: auto; }
+ col.union_members_name { width: auto; }
+ col.union_members_description { width: auto; }
+ .listing_lines { display: none; }
+}
+@media print {
+ table.navigation {
+ visibility: collapse;
+ display: none;
+ }
+ div.titlepage table.navigation {
+ visibility: visible;
+ display: table;
+ background: #e2e2e2;
+ border: solid 1px #babdb6;
+ margin-top: 0;
+ margin-bottom: 0;
+ top: 0;
+ left: 0;
+ height: 3em;
+ }
+}
+
<TITLE>GtkdocTester</TITLE>
GtkdocAnnotation
annotation_array_length
+annotation_allow_none
annotation_nullable
annotation_elementtype
annotation_elementtype_transfer
annotation_elementtype_returns
annotation_outparams
+annotation_outparams_nullable
+annotation_outparams_optional
+annotation_outparams_optional_nullable
annotation_skip
annotation_skip_return
annotation_scope
annotation_rename_to
+stability_unstable
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
/**
* SECTION:tester
* @short_description: module for gtk-doc unit test
+ * @stability: stable
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/
/**
- * annotation_nullable:
+ * annotation_allow_none:
* @uri: a uri
* @label: (allow-none): an optional string, which is used in ways too
* complicated to describe in a single line, making it necessary to wrap it
* free after use, whose description is also rather long
*/
gchar *
+annotation_allow_none (const gchar *uri,
+ const gchar *label)
+{
+ return NULL;
+}
+
+/**
+ * annotation_nullable:
+ * @uri: a uri
+ * @label: (nullable): an optional string, which is used in ways too
+ * complicated to describe in a single line, making it necessary to wrap it
+ *
+ * Document optional parameters.
+ *
+ * Returns: (transfer full) (nullable): Returns stuff which you have to
+ * free after use, whose description is also rather long
+ */
+gchar *
annotation_nullable (const gchar *uri,
const gchar *label)
{
return TRUE;
}
+/**
+ * annotation_outparams_optional:
+ * @list: (out) (transfer none) (optional): a pointer to take a list, or %NULL
+ *
+ * Document optional parameters.
+ *
+ * Returns: %TRUE for success
+ */
+gboolean
+annotation_outparams_optional (GList **list)
+{
+ return TRUE;
+}
+
+/**
+ * annotation_outparams_nullable:
+ * @list: (out) (transfer none) (nullable): a pointer to take a list; but %NULL
+ * may also be returned
+ *
+ * Document optional parameters.
+ *
+ * Returns: %TRUE for success
+ */
+gboolean
+annotation_outparams_nullable (GList **list)
+{
+ return TRUE;
+}
+
+/**
+ * annotation_outparams_optional_nullable:
+ * @list: (out) (transfer none) (optional) (nullable): a pointer to take a
+ * list, or %NULL; but %NULL may also be returned in @list — isn’t that cool?
+ *
+ * Document optional parameters.
+ *
+ * Returns: %TRUE for success
+ */
+gboolean
+annotation_outparams_optional_nullable (GList **list)
+{
+ return TRUE;
+}
+
/**
* annotation_skip: (skip)
* @list: a pointer to take a list
annotation_rename_to (void)
{
}
+
+/**
+ * stability_unstable:
+ *
+ * An experimental function.
+ *
+ * Stability: unstable
+ */
+void
+stability_unstable(void)
+{
+}
+
gpointer that;
};
-extern void annotation_array_length (GObject *list, gint n_columns, GType *types);
+void annotation_array_length (GObject *list, gint n_columns, GType *types);
-extern gchar * annotation_nullable (const gchar *uri, const gchar *label);
+gchar * annotation_allow_none (const gchar *uri, const gchar *label);
+gchar * annotation_nullable (const gchar *uri, const gchar *label);
-extern gboolean annotation_elementtype (const GList *list);
-extern gboolean annotation_elementtype_transfer (const GList *list);
-extern GList *annotation_elementtype_returns (void);
+gboolean annotation_elementtype (const GList *list);
+gboolean annotation_elementtype_transfer (const GList *list);
+GList *annotation_elementtype_returns (void);
-extern gboolean annotation_outparams (GList **list);
+gboolean annotation_outparams (GList **list);
+gboolean annotation_outparams_optional (GList **list);
+gboolean annotation_outparams_nullable (GList **list);
+gboolean annotation_outparams_optional_nullable (GList **list);
-extern void annotation_skip (GList *list);
-extern gboolean annotation_skip_return (GList *list);
+void annotation_skip (GList *list);
+gboolean annotation_skip_return (GList *list);
-extern void annotation_scope (GCallback *callback, gpointer user_data);
+void annotation_scope (GCallback *callback, gpointer user_data);
-extern void annotation_rename_to (void);
+void annotation_rename_to (void);
+
+void stability_unstable(void);
#endif // GTKDOC_TESTER_H
Bug642998
Bug644291
Bug000000Scope
+bug_411739_rettype
<SUBSECTION Functions>
bug_000000_va1
BUG_000000_VA2
GLIB_DEPRECATED
BUG_711598_DEPRECATED_FOR
bug_554833_new
+BUG_731417_DEPRECATED
+Bug730658
</SECTION>
*
* Returns: result
*/
-struct bug *
+struct bug_411739_rettype *
bug_411739 (void) {
return NULL;
}
GLIB_VAR guint64 (*bug_477532) (void);
-struct bug {
- int test;
-};
-
void bug_141869_a (unsigned pid);
void bug_141869_b (signed pid);
int bug_380824 (int arg);
-struct bug *
+
+/**
+ * bug_411739_rettype:
+ * @test: field
+ *
+ * http://bugzilla.gnome.org/show_bug.cgi?id=411739
+ */
+struct bug_411739_rettype {
+ int test;
+};
+
+struct bug_411739_rettype *
bug_411739 (void);
void bug_419997 (int const_values);
void deprecation_notice(void);
#endif
+/**
+ * BUG_731417_DEPRECATED:
+ *
+ * https://bugzilla.gnome.org/show_bug.cgi?id=731417
+ */
+#define BUG_731417_DEPRECATED 1
+
+/**
+ * Bug730658:
+ * @BUG_730658_CAN_READ: Can read
+ * @BUG_730658_CAN_WRITE: Can write
+ * @BUG_730658_IS_DEPRECATED: Is deprecated
+ *
+ * https://bugzilla.gnome.org/show_bug.cgi?id=730658
+ */
+typedef enum
+{
+ BUG_730658_CAN_READ = 1 << 0,
+ BUG_730658_CAN_WRITE = 1 << 1,
+ BUG_730658_IS_DEPRECATED = 1 << 2
+} Bug730658;
+
#endif // GTKDOC_TESTER_H
GtkdocEnum2
GtkdocPlainOldData
GtkdocBoxedPlainOldData
+GtkdocHelperEnum
+GtkdocHelperStruct
<SUBSECTION Standard>
GTKDOC_TYPE_ENUM
GTKDOC_TYPE_ENUM2
};
+/**
+ * GtkdocHelperStruct:
+ * @a: field
+ *
+ * GtkdocHelperStruct
+ */
struct GtkdocHelperStruct {
int a;
};
+/**
+ * GtkdocHelperEnum:
+ * @GTKDOC_HELPER_ENUM_A: enum a
+ * @GTKDOC_HELPER_ENUM_B: enum b
+ *
+ * GtkdocHelperEnum
+ */
enum GtkdocHelperEnum {
GTKDOC_HELPER_ENUM_A,
GTKDOC_HELPER_ENUM_B
projects / platform / upstream / gtk-doc.git / commitdiff