ஆவணப்படுத்தும் தொகுதிகள்

ஆவணத்தில் ஒவ்வொரு பிரிவும் ஒரு வகுப்பு அல்லது கூறு குறித்து தகவலைப்பெற்றிருக்கும். ஒரு பாகத்தை அறிமுகம் செய்ய ஒரு தொகுதியை எழுதலாம். குறுகிய விவரணம் உள்ளடக்க பட்டியலில் கூட பயன்படுத்தப்படும். எல்லா @ புலங்களூம் தேர்வுக்குரியன.

Example 3-4பிரிவு விமரிசன தொகுதி
/**
 * SECTION:meepapp
 * @short_description: the application class
 * @title: Meep application
 * @section_id:
 * @see_also: #MeepSettings
 * @stability: Stable
 * @include: meep/app.h
 * @image: application.png
 *
 * The application class handles ...
 */

          

SECTION:<பெயர்>

பகுதி ஆவணத்தை பெயர் <package>-sections.txtகோப்புக்கு இணைக்கிறது. கொடுக்கப்பட்ட பெயர் <package>-sections.txt கோப்பில் <FILE> குறிப்புடன் பொருந்த வேண்டும்.

@short_description

பகுதி பக்கத்தின் மேலே உள்ளடக்க பட்டியலுக்கான தொடுப்புகளுக்குப்பின் காணும் ஒரு வரி விவரம்.

@title

இந்த தொகுதி SECTION சாற்றுரையிலிருந்து <name> க்கு முன்னிருப்பாக செல்லும். இதை உதாசீனப்படுத்த @title புலத்தை பயன்படுத்துக.

@section_id

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>.

@see_also

A list of symbols that are related to this section.

@stability

A informal description of the stability level this API has. We recommend the use of one of these terms:

  • Stable - நிலையான- எனில் இடைமுகம் நிலையானது. மூன்றாம் நபர்கள் இவற்றை ஒட்டி நிரல்களை எழுதி வெளியிடலாம்; எந்த பெரிய வெளியீட்டுக்குள் அவை வெளியிடப்பட்டதோ அதன் சிறிய வெளியீட்டுகளுக்குள் அவை சரியாக வேலை செய்யும் என நம்பலாம். பெரிய வெளியீடில் கூட இசைவு இல்லாமல் போவது துர்லபம்.
  • Unstable - 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.
  • Private - தனிப்பயன் எனில் க்னோம் இல் மட்டும் பயன்படும் இடைமுகம். ஆயின் இறுதி பயனருக்கு ஆவணப்படுத்தவில்லை. அப்படிப்பட்ட செயல்கள் குறீப்பிட்ட ஆவணப்படுத்தப்பட்ட வழியில் மட்டுமே பயன்படுத்தப்பட வேண்டும்.
  • 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.

@include

The #include files to show in the section synopsis (a comma separated list), overriding the global value from the section file or command line. This item is optional.

@image

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 a class or a diagram of its relationship to other classes. This item is optional.

To avoid unnecessary recompilation after doc-changes put the section docs into the c-source where possible.