ஆவணமாக்க விமரிசனங்கள்

'*' இல் துவங்கும் பல்வரி விமர்சனம் ஜிடிகே டாக் கருவிகளால் ஒரு ஆவணமாக்கல் தொகுதியாக கையாளப்படும்.

Example 3-2ஜிடிகே டாக் விமரிசன தொகுப்பு
/**
 * identifier:
 * documentation ...
 */

          

'identifier' எனப்படும் இனம் காட்டி விமர்சனம் பொருந்தும் உருப்படியின் பெயருடன் கூடிய ஒரு வரி. உருப்படியை பொருத்து இலக்கணம் சற்று மாறலாம்.

ஆவண ( 'documentation') தொகுதி ஒவ்வொரு அடையாளத்துக்கும் கூட தனித் தனியாகும் .symbol type. Symbol types that get parameters such as functions or macros have the parameter description first followed by a blank line (just a '*'). Afterwards follows the detailed description. All lines (outside program- listings and CDATA sections) just containing a ' *' (blank-asterisk) are converted to paragraph breaks. If you don't want a paragraph break, change that into ' * ' (blank-asterisk-blank-blank).

When documenting code, describe two apsects:

  • What it is: The name for a class or function can sometimes be misleading for people coming from a different background.
  • What it does: Tell about common uses. Put it in releation with the other API.

ஜிடிகே டாக்

சிறப்பு குறிகளான '<', '>', '()', '@', '%', அல்லது '#' ஐ ஜிடிகே டாக் மாற்றாமல் அப்படியே ஆவணத்தில் பயன்படுத்த அவற்றுக்கான ஹெச்எம்எல் ஐ பயன்படுத்துக: "&lt;", "&gt;", "&lpar;", "&rpar;", "&commat;", "&percnt;" மற்றும் "&num;" அல்லது பின் சாய்வு கோடால் அவற்றை தனியாக்கலாம்.'\'.

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 --xml-mode or --sgml-mode in the variable MKDB_OPTIONS inside Makefile.am.

Since GTK-Doc-1.18 the tool supports a subset or the markdown language. 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 3-3GTK-Doc comment block using markdown
/**
 * identifier:
 *
 * documentation ...
 *
 * # Sub heading #
 *
 * more documentation:
 * - list item 1
 * - list item 2
 *
 * Even more docs.
 */

          

ஜிடிகே டாக்