குறியாக்கத்தை ஆவணப்படுத்துதல்
GTK-Doc uses source code comment with a special syntax for code documentation. Further it retrieves information about your project structure from other sources. During the next section you will find all information about the syntax of the comments.
முன் காலத்தில் பெரும்பாலான ஆவணங்கள் tmpl அடைவில் இருக்கும் கோப்புகளில் நிரப்பப்பட வேண்டி இருந்தது. இதில் நஷ்டமாக தகவல்கள் அவ்வப்போது புதுப்பிக்கப்படவில்லை. மேலும் இவை வெர்ஷன் கட்டுப்பாடு அமைப்புகளுடன் பொருந்தவில்லை
மேற்கூறிய காரணங்களால் நாங்கள் ஆவணங்களை மூலத்துடன் வைக்கு மாறூ சொல்கிறோம். இந்த கையேடு இந்த முறையை மட்டுமே விவாதிக்கும்.
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.
#ifndef __GTK_DOC_IGNORE__ /* unparseable code here */ #endif
Note, that GTK-Doc's supports #ifndef(__GTK_DOC_IGNORE__) but not #if !defined(__GTK_DOC_IGNORE__) or other combinations.
- 3.1. ஆவணமாக்க விமரிசனங்கள்
- 3.2. ஆவணப்படுத்தும் தொகுதிகள்
- 3.3. சிம்பல்களை ஆவணப் படுத்தல்
- 3.4. Useful DocBook tags