పత్రికీకరణ విభాగములు

పత్రికీకరణ యొక్క ప్రతి విభాగము వొక క్లాస్ లేదా మాడ్యూల్ గురించిన సమాచారమును కలిగివుంటుంది. మూలకాన్ని పరిచయం చేయుటకు వొకరు విభాగపు బ్లాక్‌ను వ్రాయవచ్చును. పొట్టి వివరణ అనునది పట్టిక యొక్క సారముల లోపలకూడా వుపయోగించబడును. అన్ని @fields ఐచ్చికమైనవి.

ఉదాహరణ 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:<name>

నామము అనునది విభాగపు పత్రికీకరణను <package>-sections.txt ఫైలునందలి సంభందిత భాగమునకు లింకుచేయును. ఇక్కడ యిచ్చిన నామము <package>-sections.txt ఫైలునందలి <FILE> టాగ్‌తో సరిపోలవలెను.

@short_description

విభాగము యొక్క వివరణ వొక్క వరుసలో, తరువాత అది TOC నందు లింక్సు తరువాత మరియు విభాగపు పేజీ పైన కనిపించును.

@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

ఈ API కలిగివున్న స్థిరత్వపు స్థాయి యొక్క సాధారణ వివరణ. ఈ పదములలో వొక దానిని వుపయోగించుట మేము సిఫార్సు చేయుచున్నాము:

  • స్థిరమైన - స్థిరమైన యింటర్ఫేస్ ముఖ్యోద్దేశం మూడోవ్యక్తి అనువర్తనములను యీ యింటర్ఫేసులకు కొరకు అభివృద్దిపరచుట, విడుదల చేయుట, మరియు ఆ వుత్పాదన యొక్కఅన్ని చిన్న విడుదలలనందు(పెద్ద విడుదల క్రిందన విడుదలగునవి) నడుచునట్లు చూచుకొనుటను చేతన పరచుట. ముఖ్య విడుదలనందు కూడా, సారూప్యతా మార్పులు అనునవి తగ్గించుటకు, ఖచ్చితమైన నిర్ధారణలను కలిగివుండుట.
  • అస్థిరమైన - అస్థిరమైన యింటర్ఫేస్‌లు ప్రయోగాత్మకమైనవి లేదా బదలీకరణ పొందునవి. అవి ముఖ్యంగా బయటి అభివృద్దికారులకు కొత్తవి లేదా వేగంగా మారుతున్న సాంకేతికతపై యాక్సెస్ యిచ్చుటకు వుపయోగించబడును, లేదా వొక సమస్య కొరకు యెక్కువ సహజమైన పరిష్కారము కొరకు యెదురు చూడబడుతోందో అక్కడ మధ్యంతర పరిష్కారము యిచ్చుటకు. ఒక చిన్న విడుదలనుండి తర్వాత దానికి యెటువంటి క్లైమ్స్ సోర్స్ గురించికాని లేదా బైనరీ సారూప్యత గురించికాని చేయబడవు.
  • వ్యక్తిగత - GNOME స్టాక్ లోపలే వుపయోగించగల యింటర్ఫేస్, అయితే అది అంత్య-వినియోగదారుల కొరకు పత్రికీకరణ చేయబడదు. అటువంటి ఫంక్షన్లు తెలుపబడిన మరియు పత్రికీకరణ మార్గములలోనే వుపయోగించాలి.
  • అంతర్గత - మాడ్యూల్‌కు అంతర్గతమైన మాడ్యూల్ మరియు అంత్య-వినియోగదారి పత్రికీకరణ అవసరములేనిది. పత్రికీకరణ చేయని ఫంక్షన్లు అంతర్గతమైనవిగా పరిగణించాలి.

@include

విభాగపు సారాంశము నందు చూపుటకు #include ఫైళ్ళు (కామాతో వేరుచేయబడిన జాబితా), విభాగపు ఫైలు లేదా ఆదేశ వరుసనుండి గ్లోబల్ విలువను దిద్దివ్రాయుట. ఈ అంశము ఐచ్చికము.

@image

ఈ విభాగము కొరకు సూచనపేజీ పైన ప్రదర్శించుటకు ప్రతిబింబము. ఇది తరుచుగా వొక క్లాస్ యొక్క విజువల్ అప్పియరెన్స్ వివరించుటకు డయాగ్రమ్ వంటిది లేదా యితర క్లాసులతో దాని సంభందాన్ని తెలిపే డయాగ్రమ్. ఈ అంశము ఐచ్చికము.

అనవసరపు రికంపైలేషన్‌ను విసర్జించుటకు doc-changes తర్వాత విభాగపు పత్రములను c-source నందు వీలైనచోట వుంచుము.