ஜிடிகே டாக் கையேடு
உருவாக்குவோருக்கான ஜிடிகே டாக்(GTK-Doc) பயன்பாட்டு பயனர் கையேடு

அறிமுகம்
இந்த அத்தியாயம் ஜிடிகே-டாக் குறித்த அறிமுகம் தருகிறது. மேலும் அது என்ன எப்படி பயன்படுத்துவது என மேலோட்டமாக சொல்லுகிறது.

ஜிடிகே டாக் என்பதென்ன?
ஜிடிகே டாக் சி குறியாக்கத்தை ஆவணப்படுத்துகிறது. இது எடுத்துக்காட்டாக ஜிடிகே+ மற்றும் க்னோம் நூலகங்கள் போன்ற நூலகங்களின் பொது ஏபிஐ களை ஆவணப்படுத்த பயன்படுகிறது. ஆனாலும் இது நிரல்களின் குறியாக்கத்தை ஆவணப்படுத்தக்கூட பயன்படுத்தலாம்.

ஜிடிகே டாக் எப்படி வேலை செய்கிறது?
ஜிடிகே டாக் வேலை செய்வதெப்படி எனில் சிறப்பு ஒழுங்கில் விமர்சன தொகுதிகளாக செயல்களின் ஆவணங்கள் மூல கோப்புகளில் வைக்கப்படும். அல்லது ஜிடிகே டாக் பயன்படுத்தும் டெம்ப் கோப்புகளுக்கு சேர்க்கபடும். (ஆயினும் ஜிடிகே டாக் தலைப்பு கோப்புகளில் அறுதியிட்ட பங்ஷன்களை மட்டுமே ஆவணப்படுத்தும். நிலையான பங்க்ஷன்களுக்கு வெளியீடு தராது)
GTK-Doc consists of a number of python scripts, each performing a different step in the process.
இந்த நடப்பில் ஐந்து படிகள் உள்ளன
ஆவணம் எழுதும் முறை. ஆசிரியர் மூல கோப்பை ஒவ்வொரு செயல், மேக்ரோ, இணைப்புக்கும் ஆவணங்களால் நிரப்புவார். (முன்னே விவரங்கள் உருவாக்கப்பட்ட வார்ப்புரு கோப்புக்களால் உள்ளிடப்பட்டது. அப்படி இனி செய்ய பரிந்துரைக்கவில்லை.)
Gathering information about the code. gtkdoc-scan scans the header files of the code looking for declarations of functions, macros, enums, structs, and unions. It creates the file <module>-decl-list.txt containing a list of the declarations, placing them into sections according to which header file they are in. On the first run this file is copied to <module>-sections.txt. The author can rearrange the sections, and the order of the declarations within them, to produce the final desired order. The second file it generates is <module>-decl.txt. This file contains the full declarations found by the scanner. If for some reason one would like some symbols to show up in the docs, where the full declaration cannot be found by the scanner or the declaration should appear differently, one can place entities similar to the ones in <module>-decl.txt into <module>-overrides.txt.
gtkdoc-scangobj can also be used to dynamically query a library about any GObject subclasses it exports. It saves information about each object's position in the class hierarchy and about any GObject properties and signals it provides.
gtkdoc-scanobj should not be used anymore. It was needed in the past when GObject was still GtkObject inside gtk+.
Generating the XML and HTML/PDF. gtkdoc-mkdb turns the template files into XML files in the xml/ subdirectory. If the source code contains documentation on functions, using the special comment blocks, it gets merged in here. If there are no tmpl files used it only reads docs from sources and introspection data.
gtkdoc-mkhtml turns the XML files into HTML files in the html/ subdirectory. Likewise gtkdoc-mkpdf turns the XML files into a PDF document called <package>.pdf.
Files in xml/ and html/ directories are always overwritten. One should never edit them directly.
ஆவணங்கள் இடையில் குறுக்கு தொடுப்புகளை சரி செய்தல் HTML கோப்புக்களை நிறுவிய பின்னர், பின் வரும் நிரலை இயக்கி gtkdoc-fixxref ஆவணங்கள் இடையில் குறுக்கு தொடுப்புகளை சரி செய்யலாம். உதாரணமாக ஜிடிகே+ ஆவணத்தில் ஜிலிப் கையேட்டில் ஆவணப்படுத்திய பல வகைகளுக்கு குறுக்கு தொடுப்புகள் இருக்கும். வினியோகிக்க டார் பால் செய்யும் போது gtkdoc-rebase எல்லா வெளி தொடுப்புக்களையும் வலை தொடுப்பாக மாற்றிவிடும். இதே நிரல் ஆவணங்கள் நிறுவப்படும்போது அவற்றை உள்ளமை தொடுப்புக்களாக மாற்றியமைக்கும். (மற்ற ஆவணங்கள் நிறுவப்பட்டு இருக்கும் பட்சத்தில்.)

ஜிடிகே டாக் ஐ பெறுதல்

முன் தேவைகள்
python 2/3 - the main scripts are written in python.
xsltproc - the xslt processor from libxslt xmlsoft.org/XSLT/
docbook-xsl - the docbook xsl stylesheets sourceforge.net/projects/docbook/files/docbook-xsl
One of source-highlight, highlight or vim - optional - used for syntax highlighting of examples

ஜிடிகே டாக் பற்றி
(FIXME)
(History, authors, web pages, mailing list, license, future plans, comparison with other similar systems.)

இந்த கையேடு பற்றி
(FIXME)
(இது யாருக்கு, உரிமம், எங்கு பெறுவது)