# GTK-Doc પુસ્તિકા

1.15

GTK-Doc વપરાશની સૂચનાઓ સાથે ડેવલપરો માટે વપરાશકર્તા પુસ્તિકા.

ક્રીસ લિટ્લે

                chris@wilddev.net

Dan મૂએથ

                d-mueth@uchicago.edu

સ્ટેફાન કોસ્ટ

                ensonic@users.sf.net

GTK-Doc પ્રોજેક્ટ

    gtk-doc-list@gnome.org

2000, 2005, 2007-2009 ડૅમ મૂએથ અને ક્રીસ લિટ્લે અને સ્ટેફાન કોસ્ટ

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.

1.17
26 Feb 2011
sk urgent bug fix update
1.16
14 Jan 2011
sk bugfixes, layout improvements
1.15
21 May 2010
sk bug and regression fixes
1.14
28 March 2010
sk bugfixes and performance improvements
1.13
18 ડિસેમ્બર 2009
sk તૂટેલ ટારબોલ સુધારા
1.12
18 ડિસેમ્બર 2009
sk નવા સાધન લક્ષણો અને ભૂલ સુધારાઓ
1.11
16 નવેમ્બર 2008
mal GNOME doc-utils સ્થળાંતર

## પરિચય

આ પ્રકરણ GTK-Doc ને રજૂ કરે છે અને તે શું છે અને તેને કેવી રીતે વપરાયેલ છે તેની ઝાંખી આપે છે.

### GTK-Doc શું છે?

GTK-Doc એ દસ્તાવેજ C કોડ માટે વપરાયેલ છે. તે લાઇબ્રેરીઓનાં સાર્વજનિક API નાં દસ્તાવેજ માટે વપરાયેલ છે, જેવું કે GTK+ અને GNOME લાઇબ્રેરીઓ. પરંતુ તે પણ દસ્તાવેજ કાર્યક્રમ કોડ માટે વપરાયેલ છે.

### GTK-Doc કામ કેવી રીતે કરે છે?

GTK-Doc એ વિશિષ્ટ રીતે માળખુ થયેલ ટિપ્પણી બ્લોકોમાં સ્ત્રોત ફાઇલોની અંદર સ્થિત થયેલ વિધેયોનાં દસ્તાવેજીકરણની મદદથી કામ કરે છે, અથવા દસ્તાવેજીકરણ ટેમ્પલેટ ફાઇલોમાં ઉમેરાયેલ છે કે જે GTK-Doc વાપરે છે (છતાંપણ નોંધો કે GTK-Doc એ પણ દસ્તાવેજ વિધેયો હશે કે જે શીર્ષક ફાઇલોમાં જાહેર થયેલ છે; તે સ્થિર વિધેયો માટે આઉટપુટ ઉત્પન્ન કરતુ નથી).

GTK-Doc એ perl સ્ક્રિપ્ટોની સંખ્યાને સમાવે છે, પ્રક્રિયામાં દરેક વિવિધ પગલું કરે છે.

ત્યાં પ્રક્રિયામાં મુખ્ય ૫ પગલાંઓ છે:

1. દસ્તાવેજીકરણને લખી રહ્યા છે. લેખક એ દરેક વિધેયને, મેક્રો, યુનિયન વગેરે માટે દસ્તાવેજીકરણ સાથે સ્ત્રોત ફાઇલોમાં ભરે છે. (ઉત્પન્ન થયેલ ટેમ્પલેટ ફાઇલમાં ભૂતકાળની જાણકારી દાખલ થયેલ હતી, કે જે કોઇપણ રીતે અગ્રહણીય થયેલ નથી)

2. 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` containg 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 enties similar to the ones in `<module>-decl.txt` into `<module>-overrides.txt`. gtkdoc-scanobj can also be used to dynamically query a library about any GtkObject subclasses it exports. It saves information about each object's position in the class hierarchy and about any GTK Args and Signals it provides.

3. "template" ફાઇલોને ઉત્પન્ન કરી રહ્યા છે.gtkdoc-mktmpl એ પહેલાં પગલામાં ભેગી થયેલ જાણકારીની મદદથી `tmpl/` ઉપડિરેક્ટરીમાં ફાઇલોની સંખ્યાને બનાવે છે. (નોંધો કે જે આ વારંવાર ચલાવી શકાય છે. તે ખાતરી કરવા માટે પ્રયત્ન કરશે કે જે દસ્તાવેજીકરણ હંમેશ માટે ગુમ થઇ જતો નથી.)

   જ્યાં સુધી GTK-Doc 1.9 નાં ટેમ્પલેટને અવગણી શકાય છે ત્યાં સુધી. આપણે કોડમાં દસ્તાવેજીકરણ ને રાખવા માટે લોકોને પ્રોત્સાહિત કરો. gtkdocize એ હવે `--flavour no-tmpl` વિકલ્પને આધાર આપે છે કે જે makefile ને પસંદ કરે છે કે જે સંપૂર્ણપણે tmpl વપરાશને છોડી દે છે. જો તમે પોતાની જાતે tmpl માં ફાઇલને કદી બદલો નહિં તો, મહેરબાની કરીને dir ને દૂર કરો (દા.ત. આવૃત્તિ નિયંત્રણ સિસ્ટમ માંથી).

4. Generating the SGML/XML and HTML/PDF. gtkdoc-mkdb turns the template files into SGML or XML files in the `sgml/` or `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. We recommend to use Docbook XML.

   gtkdoc-mkhtml turns the SGML/XML files into HTML files in the `html/` subdirectory. Likewise gtkdoc-mkpdf turns the SGML/XML files into a PDF document called `<package>.pdf`.

   `sgml/` અથવા `xml/` માં ફાઇલો અને `html/` ડિરેક્ટરીઓ એ હંમેશા ઉપલ લખાયેલ છે. એક એ સીધુ જ તેઓને કદી સુધારતુ હોવુ જોઇએ નહિં.

5. Fixing up cross-references between documents. After installing the HTML files, gtkdoc-fixxref can be run to fix up any cross-references between separate documents. For example, the GTK+ documentation contains many cross-references to types documented in the GLib manual. When creating the source tarball for distribution, gtkdoc-rebase turns all external links into web-links. When installing distributed (pregenerated) docs the same application will try to turn links back to local links (where those docs are installed).

### GTK-Doc ને મેળવી રહ્યા છે

#### જરૂરિયાતો

Perl v5 - મુખ્ય સ્ક્રિપ્ટો એ Perl માં છે.

DocBook DTD v3.0 - આ DocBook SGML DTD છે. http://www.ora.com/davenport

Jade v1.1 - આ વિવિધ માળખાઓમાં SGML ને રૂપાંતર કરવા માટે DSSSL પ્રોસેસર છે. http://www.jclark.com/jade

Modular DocBook Stylesheets આ DocBook ને HTML માં રૂપાંતરિત કરવા માટે DSSSL કોડ છે (અને થોડા બીજા બંધારણો). તે jade સાથે ભેગા વાપરેલ છે. મેં DSSSL કોડને કાર્યક્રમ કોડની યાદીઓ/ જાહેરાતોને રંગ આપવા માટે, અને ઉત્પન્ન થયેલ HTML માં વૈશ્ર્વિક પ્રતિનિર્દેશ સૂચિને આધાર આપવા માટે gtk-doc.dsl માં જરાક DSSSL કોડને વૈવિધ્યપૂર્ણ બનાવેલ છે. http://nwalsh.com/docbook/dsssl

docbook-to-man - જો તમે DocBook માંથી મુખ્ય પાનાંઓને બનાવવાનું ઇચ્છતા હોય તો, મેં થોડુ 'translation spec' ને વૈવિધ્યપૂર્ણ બનાવેલ છે, વિભાગનાં શીર્ષકનાં મોટા અક્ષર કરવા માટે અને પાનાંઓના ઊંચે 'GTK Library' શીર્ષકને ઉમેરો અને નીચે પૂનરાવર્તિત તારીખને ઉમેરો. ત્યાં http://www.ora.com/davenport પર આની કડી છે નોંધો: આ હજુ કામ કરતુ નથી.

#### સ્થાપન

ત્યાં મૂળભૂત સ્થાન નથી કે જ્યાં DocBook Modular Stylesheets એ સ્થાપિત થયેલ હોય.

GTK-Doc ની રૂપરેખાંકિત સ્ક્રિપ્ટ એ આ 3 ડિરેક્ટરીઓને આપમેળે શોધે છે:

`/usr/lib/sgml/stylesheets/nwalsh-modular` (RedHat દ્દારા વપરાયેલ છે)

`/usr/lib/dsssl/stylesheets/docbook` (Debian દ્દારા વપરાયેલ છે)

`/usr/share/sgml/docbkdsl` (SuSE દ્દારા વપરાયેલ છે)

જો તમે ગમે ત્યાં સ્ટાઇલશીટો સ્થાપિત કરેલ હોય તો, તમે વિકલ્પની મદદથી GTK-Doc ને રૂપરેખાંકિત કરવા માટે જરૂ છે, `--with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR>`

### GTK-Doc વિશે

(FIXME)

(ઇતિહાસ, લેખકો, વેબ પાનાંઓ, લાઇસન્સ, ભવિષ્યનાં પ્લાનો, સરખી સિસ્ટમો સાથે સરખામણી.)

### આ પુસ્તિકા વિશે

(FIXME)

(who it is meant for, where you can get it, license)

## તમારા પ્રોજેક્ટને સુયોજિત કરી રહ્યા છે

The next sections describe what steps to perform to integrate GTK-Doc into your project. Theses sections assume we work on a project called 'meep'. This project contains a library called 'libmeep' and an end-user app called 'meeper'.

### સ્કેલેટન દસ્તાવેજીકરણને સુયોજિત કરી રહ્યા છે

Under your top-level project directory create folders called docs/reference (this way you can also have docs/help for end-user documentation). It is recommended to create another subdirectory with the name of the doc-package. For packages with just one library this step is not necessary.

This can then look as shown below:

ઉદાહરણ ડિરેક્ટરી બંધારણ

    meep/
      docs/
        reference/
          libmeep/
          meeper/
      src/
        libmeep/
        meeper/

### autoconf સાથે એકત્રિકરણ

ઘણું સરળ છે! ફક્ત તમારી `configure.ac` સ્ક્રિપ્ટમાં એક વાક્ય ને ઉમેરો.

autoconf સાથે એકત્રિકરણ

    # check for gtk-doc
    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

This will require all developers to have gtk-doc installed. If it is okay for your project to have optional api-doc build setup, you can solve this as below. Keep it as is, as gtkdocize is looking for `GTK_DOC_CHECK` at the start of a line.

Keep gtk-doc optional

    # check for gtk-doc
    m4_ifdef([GTK_DOC_CHECK], [
    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
    ],[
    AM_CONDITIONAL([ENABLE_GTK_DOC], false)
    ])

પહેલી દલીલ રૂપરેખાંકિત સમયે gtkdocversion માટે ચકાસવા વપરાયેલ છે. બીજી, વૈકલ્પિક દલીલ એ gtkdocize દ્દારા વપરાયેલ છે. GTK_DOC_CHECK મેક્રો પણ ઘણીબધા રૂપરેખાંકિત ફેરબદલોને ઉમેરે છે:

1. --with-html-dir=PATH : સ્થાપિત થયેલ દસ્તાવેજોનો પાથ

2. --enable-gtk-doc : દસ્તાવેજીકરણ ને બિલ્ડ કરવા માટે gtk-doc ને વાપરો [default=no]

3. --enable-gtk-doc-html : html બંધારણમાં દસ્તાવેજીકરણ બિલ્ડ કરો [default=yes]

4. --enable-gtk-doc-pdf : pdf બંધારણમાં દસ્તાવેજીકરણને બિલ્ડ કરો [default=no]

GTK-Doc એ મૂળભૂત રીતે નિષ્ક્રિય થયેલ છે! આગળનાં `configure` ને ચલાવવા માટે `'--enable-gtk-doc'` ને પસાર કરવાનું યાદ રાખો. નહિં તો પહેલીથી ઉત્પન્ન થયેલ દસ્તાવેજીકરણ સ્થાપિત થયેલ છે (કે જે વપરાશકર્તાઓ માટેનો અર્થ બને છે પરંતુ ડેવલપરો માટે નહિં).

આગળ વધારે તે અગ્રહણીય થયેલ છે કે જે તમારી પાસે તમારી `configure.ac` સ્ક્રિપ્ટની અંદર નીચેનું વાક્ય છે. આ તમારા પ્રોજેક્ટમાં `GTK_DOC_CHECK` માટે મેક્રો વ્યાખ્યાને આપમેળે નકલ કરવા માટે પરવાનગી આપે છે.

gtkdocize માટે તૈયારી

    AC_CONFIG_MACRO_DIR(m4)

### automake સાથે એકત્રિકરણ

તમારા પ્રોજેક્ટની API દસ્તાવેજીકરણ ડિરેક્ટરી ( `./docs/reference/<package>`) માં gtkdoc-સ્ત્રોતોની ઉપડિરેક્ટરીઓનાં ઉદાહરણો માંથી `Makefile.am` ની પહેલી નકલ કરો. જો તમારી પાસે દરેક એક માટે ઘણાબધા ફરી આવતા દસ્તાવેજ-પેકેજો છે.

The next step is to edit the settings inside the `Makefile.am`. All the settings have a comment above that describes their purpose. Most settings are extra flags passed to the respective tools. Every tool has a variable of the form `<TOOLNAME>_OPTIONS`. All the tools support `--help` to list the supported parameters.

You may also want to enable GTK-Doc for the distcheck make target. Just add the one line shown in the next example to your top-level `Makefile.am`:

distcheck ને બનાવવા દરમ્યાન GTK-Doc ને સક્રિય કરો

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### autogen સાથે એકત્રિકરણ

મોટાભાગનાં પ્રોજેક્ટો પાસે આવૃત્તિ નિયંત્રણ સિસ્ટમ (જેવી કે cvs/svn/git) માંથી ચેકઆઉટ પછી ઇન્ફ્રાસ્ટ્રક્ચરને બિલ્ડ કરવાનું સુયોજિત કરવા માટે `autogen.sh` સ્ક્રિપ્ટ હશે. GTK-Doc એ સાધન gtkdocize તરીકે કહેવાતા સાધન સાથે આવે છે કે જે આવી સ્ક્રિપ્ટમાં વાપરી શકાય છે. તે autoheader, automake અથવા autoconf પહેલાં ચાલવુ જોઇએ.

autogen.sh માંથી gtkdocize ને ચલાવી રહ્યા છે

    gtkdocize || exit 1

When running gtkdocize it copies `gtk-doc.make` to your project root (or any directory specified by the `--docdir` option). It also checks you configure script for the `GTK_DOC_CHECK` invocation. This macro can be used to pass extra parameters to gtkdocize.

Historically GTK-Doc was generating template files where developers entered the docs. This turned out to be not so good (e.g. the need for having generated files under version control). Since GTK-Doc 1.9 the tools can get all the information from source comments and thus the templates can be avoided. We encourage people to keep documentation in the code. gtkdocize supports now a `--flavour no-tmpl` option that chooses a makefile that skips tmpl usage totally. Besides adding the option directly to the command invocation, they can be added also to an environment variable called GTKDOCIZE_FLAGS or set as a 2nd parameter in GTK_DOC_CHECK macro in the configure script. If you have never changed file in tmpl by hand and migrating from older gtkdoc versions, please remove the dir (e.g. from version control system).

### દસ્તાવેજ બિલ્ડને ચલાવી રહ્યા છે

પહેલાનાં પગલાઓ પછી બિલ્ડ ને ચલાવવા માટે સમય થઇ ગયો છે. પહેલાં આપણે `autogen.sh` પુન:ચલાવવાની જરૂર છે. નહિં તો પછીથી આ વિકલ્પ સાથે `configure` ને જાતે જ ચલાવો.

પહેલું ચલાવવાનું બનાવવા doc-dirs માં ઘણીબધી વધારાની ફાઇલોને ઉત્પન્ન કરે છે. મહત્વનાં છે: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

દસ્તાવેજ બિલ્ડને ચલાવી રહ્યા છે

    ./autogen.sh --enable-gtk-doc
    make

હવે તમે `docs/reference/<package>/index.html` માટે તમારા બ્રાઉઝર પર આંગળી ચીંધી શકો છો. હાં, તે થોડુ હજુ નિરાશ કરે તેવુ છે. પરંતુ આગળનામ વિષય માટે આપણે તને કહીએ છે કે જીદંગી સાથે પાનાંઓને કેવી રીતે ભરવા તે દરમ્યાન થોડા સમય માટે અટકી જાય છે

### આવૃત્તિ નિયંત્રણ સિસ્ટમો સાથે એકત્રિકરણ

અંગૂઠાનાં નિયમ પ્રમાણે, તે તે ફાઇલો છે જે તમારે સુધારવાની છે, કે જે આવૃત્તિ નિયંત્રણ હેઠળ જવી જોઇએ. વિશિષ્ટ પ્રોજેક્ટો માટે તે આ ફાઇલો છે: `<package>.types``<package>-docs.sgml``<package>-sections.txt`

## કોડને દસ્તાવેજ કરી રહ્યા છે

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.

દસ્તાવેજીકરણ નિયુક્તિ

In the past most documentation had to be filled into files residing inside the `tmpl` directory. This has the disadvantages that the information is often not updated and also that the file tend to cause conflicts with version control systems.

The avoid the aforementioned problems we suggest putting the documentation inside the sources. This manual will only describe this way of documenting code.

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.

GTK-Doc ટિપ્પણી બ્લોક

    #ifndef __GTK_DOC_IGNORE__
    /* unparseable code here */
    #endif

### દસ્તાવેજીકરણ ટિપ્પણીઓ

ઘણીબધા વાક્યની ટિપ્પણીઓ કે જે વધારાનાં '*' ચિહ્ન દસ્તાવેજીકરણ બ્લોક સાથે શરૂ થાય છે કે જે GTK-Doc સાધનો દ્દારા પ્રક્રિયા થયેલ હશે.

GTK-Doc ટિપ્પણી બ્લોક

    /**
     * identifier:
     * documentation ...
     */

The 'identifier' is one line with the name of the item the comment is related to. The syntax differs a little depending on the item. (TODO add table showing identifiers)

The 'documentation' block is also different for each 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).

One advantage of hyper-text over plain-text is the ability to have links in the document. Writing the correct markup for a link can be tedious though. GTK-Doc comes to help by providing several useful abbreviations.

- વિધેયો અથવા મેક્રોનો સંદર્ભ લેવા માટે function() ને વાપરો કે જે દલીલોને લે છે.

- પરિમાણોનો સંદર્ભ લેવા માટે @param ને વાપરો. બીજા વિધેયોનાં પરિમાણો માટે જ્યારે સંદર્ભ કરી રહ્યા હોય ત્યારે આને પણ વાપરો, વર્ણવવા માટે એકને સંબંધિત છે.

- કૉન્સ્ટન્ટ નો સંદર્ભ લેવા માટે %constant ને વાપરો, દા.ત. %G_TRAVERSE_LEAFS.

- સંકેતનાં બીજા પ્રકારોનો સંદર્ભ લેવા માટે #symbol ને વાપરો, દા.ત. structs અને enums અને macros કે જે દલીલો લેતુ નથી.

- #Object ને વાપરો::GObject સંકેતનો સંદર્ભ લેવા માટે સંકેત

- #Object ને વાપરો:GObject ગુણધર્મનો સંદર્ભ લેવા માટે ગુણધર્મ

- બંધારણની અંદર ક્ષેત્રનો સંદર્ભ લેવા માટે #Struct.field ને વાપરો.

જો તમારે તેઓને બદલ્યા વગર GTK-Doc વગર તમારાં દસ્તાવેજીકરણમાં વિશિષ્ટ અક્ષરો '<', '>', '()', '@', '%', or '#' ને વાપરવાનું ઇચ્છતા હોય તો તમે XML વસ્તુઓ "&lt;", "&gt;", "&lpar;", "&rpar;", "&commat;", "&percnt;" અને "&num;" ને વાપરી શકો છો અથવા બેકસ્લેશ '\' સાથે તેઓમાંથી બહાર નીકળી જાઓ.

DocBook can do more that just links. One can also have lists, tables and examples. To enable the usage of SGML/XML tags inside doc-comments you need to have `--xml-mode` or `--sgml-mode` in the variable MKDB_OPTIONS inside `Makefile.am`.

પહેલાનાં GTK-Doc માં પહેલેથી જણાવેલ પ્રમાણે સાર્વજનિક API દસ્તાવેજીકરણ માટે છે. છતાં એક એ સ્થિર સંકેતો માટે દસ્તાવેજીકરણ ને લખી શકતુ નથી. તેમ છતાં તે પેલાં સંકેતો પર ટિપ્પણી કરવા માટે સારુ છે. આ તમારાં કોડને સમજવા માટે બીજાને મદદ કરે છે. માટે આપણે સામાન્ય ટિપ્પણીઓની મદદથી આ ટિપ્પણી એ અગ્રહણીય કરેલ છે (પહેલાં વાક્યમાં બીજા '*' વગર). જો પછી વિધેયને સાર્વજનિક બનાવવાની જરૂર છે, ટિપ્પણી બ્લોકમાં બીજા '*' ઉમેરવા માટે બધાને કરવાની જરૂર છે અને ફાઇલ વિભાગોની અંદર જમણી જગ્યા પર સંકેત નામને દાખલ કરો.

### વિભાગોનું દસ્તાવેજ કરી રહ્યા છે

દસ્તાવેજીકરણનો દરેક વિભાગ એ એર વર્ગ અથવા મોડ્યુલ વિશે જાણકારીને સમાવે છે. એક ઘટક એ વિભાગ બ્લોક લખી શકે છે તે રજૂ કરવા માટે. ટૂંકુ વર્ણન એ સમાવિષ્ટોનાં કોષ્ટકની અંદર પણ વપરાયેલ છે. બધી @fields વૈકલ્પિક છે.

વિભાગ ટિપ્પણી બ્લોક

    /**
     * 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>

  The name links the section documentation to the respective part in the `<package>-sections.txt` file. The name give here should match the <FILE> tag in the `<package>-sections.txt` file.

@shortdescription (_d)

  વિભાગનું એક વાક્યનું વર્ણન, કે જે પછી TOC માં અને વિભાગ પાનાંની ટોચે કડીઓ પછી દેખાશે.

@title

  વિભાગનું શીર્ષક એ SECTION રજૂઆતમાંથી <name> માટે મૂળભૂત કરેલ છે. તે @title ક્ષેત્ર સાથે અવગણી શકાય છે.

@sectionid (_i)

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

@seealso (_a)

  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 - The intention of a Stable interface is to enable arbitrary third parties to develop applications to these interfaces, release them, and have confidence that they will run on all minor releases of the product (after the one in which the interface was introduced, and within the same major release). Even at a major release, incompatible changes are expected to be rare, and to have strong justifications.

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

  - ખાનગી - ઇન્ટપફેસ કે જે GNOME સ્ટેક પોતામાં વાપરી શકાય છે, પરંતુ અંતિમ વપરાશકર્તાઓ માટે દસ્તાવેજ થયેલ નથી. જેવા કે વિધેયો એ સ્પષ્ટ થયેલ અને દસ્તાવેજ પ્રમાણે પમ વાપરવુ જોઇએ.

  - આંતરિક - ઇન્ટરફેસ કે જે મોડ્યુલ માટે આંતરિક છે અને અંતિમ-વપરાશકર્તાનાં દસ્તાવેજીકરણની જરૂર નથી. વિધેયો કે જે દસ્તાવેજ થયેલ નથી તે આંતરિક કરવા માટે ધારેલ છે.

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

### સંકેતોનું દસ્તાવેજ કરી રહ્યા છે

Each symbol (function, macro, struct, enum, signal and property) is documented in a separate block. The block is best placed close to the definition of the symbols so that it is easy to keep them in sync. Thus functions are usually documented in the c-source and macros, structs and enums in the header file.

#### સામાન્ય ટેગ

You can add versioning information to all documentation elements to tell when an api was introduced, or when it was deprecated.

Versioning Tags

જ્યાં સુધી:

  વર્ણન જ્યાં સુધી API કોડનું કઇ આવૃત્તિ ઉપલ્બધ છે.

અપ્રચલિત થયેલ:

  ફકરાને સૂચિત કરી રહ્યા છે કે જે આ વિધેયને વધારે વાપરવુ જોઇએ નહિં. વર્ણનએ નવા API માટે વાંચનારને ધ્યાન લેવુ જોઇએ.

(FIXME : સ્થિરતા જાણકારી)

સામાન્ય ટેગ

    /**
     * foo_get_bar:
     * @foo: some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: @foo's bar
     *
     * Since: 2.6
     * Deprecated: 2.12: Use foo_baz_get_bar() instead.
     **/
    Bar *
    foo_get_bar(Foo *foo)
    {
    ...

#### વિધેય ટિપ્પણી બ્લોક

મહેરબાની કરીને યાદ રાખો:

- Document whether returned objects, lists, strings, etc, should be freed/unrefed/released.

- દસ્તાવેજ ક્યાંતો પરિમાણો એ NULL હોઇ શકે છે, અને શું થશે જો તેઓ છે તો.

- Mention interesting pre-conditions and post-conditions where appropriate.

Gtk-doc એ '_' સાથે શરૂ થતા બધા સંકેતો (મેક્રો, વિધેયો) ને ખાનગી ધારે છે. તેઓ સ્થિર વિધેયો જેવું વર્ણતૂક કરે છે.

Also, take a look at gobject introspection annotation tags: http://live.gnome.org/GObjectIntrospection/Annotations

વિધેય ટિપ્પણી બ્લોક

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     * @...: a %NULL-terminated list of bars
     *
     * The function description goes here. You can use @par1 to refer to parameters
     * so that they are highlighted in the output. You can also use %constant
     * for constants, function_name2() for functions and #GtkWidget for links to
     * other declarations (which may be documented elsewhere).
     *
     * Returns: an integer.
     *
     * Since: 2.2
     * Deprecated: 2.18: Use other_function() instead.
     */

વિધેય ટૅગો

પાછુ આવે છે:

  ફકરો પાછુ મળેલ પરિણામને વર્ણવી રહ્યા છે.

@...:

  In case the function has variadic arguments, you should use this tag (@Varargs: does also work for historic reasons).

#### ગુણધર્મ ટિપ્પણી બ્લોક

ગુણધર્મ ટિપ્પણી બ્લોક

    /**
     * SomeWidget:some-property:
     *
     * Here you can document a property.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);

#### સંકેત ટિપ્પણા બ્લોક

મહેરબાની કરીને યાદ રાખો:

- Document when the signal is emitted and whether it is emitted before or after other signals.

- Document what an application might do in the signal handler.

સંકેત ટિપ્પણા બ્લોક

    /**
     * FooWidget::foobarized:
     * @widget: the widget that received the signal
     * @foo: some foo
     * @bar: some bar
     *
     * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
     */
    foo_signals[FOOBARIZE] =
      g_signal_new ("foobarize",
                    ...

#### Struct ટિપ્પણી બ્લોક

Struct ટિપ્પણી બ્લોક

    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      /*< private >*/
      GtkWidget parent;

      /*< public >*/
      gboolean bar;
    } FooWidget;

Use `/*< private >*/` before the private struct fields you want to hide. Use `/*< public >*/` for the reverse behaviour.

Struct comment blocks can also be used for GObjects and GObjectClasses. It is usualy a good idea to add a comment blco for a class, if it has vmethods (as this is how they can be documented). For the GObject itself one can use the related section docs, having a separate block for the instance struct would be useful if the instance has public fields. One disadvantage here is that this creates two index entries of the same name (the structure and the section).

#### Enum ટિપ્પણી બ્લોક

Enum ટિપ્પણી બ્લોક

    /**
     * Something:
     * @SOMETHING_FOO: something foo
     * @SOMETHING_BAR: something bar
     *
     * Enum values used for the thing, to specify the thing.
     *
     **/
    typedef enum {
      SOMETHING_FOO,
      SOMETHING_BAR,
      /*< private >*/
      SOMETHING_COUNT
    } Something;

Use `/*< private >*/` before the private enum values you want to hide. Use `/*< public >*/` for the reverse behaviour.

### ઉપયોગી DocBook ટૅગ

અહિંયા અમુક DocBook ટૅગ છે કે જે મોટાભાગનાં ઉપયોગી છે જ્યારે કોડનું દસ્તાવેજ કરી રહ્યા છે.

To link to another section in the GTK docs:

    <link linkend="glib-Hash-Tables">Hash Tables</link>

The linkend is the SGML/XML id on the top item of the page you want to link to. For most pages this is currently the part ("gtk", "gdk", "glib") and then the page title ("Hash Tables"). For widgets it is just the class name. Spaces and underscores are converted to '-' to conform to SGML/XML.

બહારનાં વિધેયનો સંદર્ભ લેવા માટે, દા.ત. મૂળભૂત C વિધેય:

    <function>...</function>

To include example code:

    <example>
      <title>Using a GHashTable.</title>
      <programlisting>
          ...
      </programlisting>
    </example>

or possibly this, for very short code fragments which don't need a title:

    <informalexample>
      <programlisting>
      ...
      </programlisting>
    </informalexample>

For the latter GTK-Doc also supports an abbreviation: |[ ... ]|

બુલેટ થયેલ યાદીઓને સમાવવા માટે:

    <itemizedlist>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
    </itemizedlist>

To include a note which stands out from the text:

    <note>
      <para>
        Make sure you free the data after use.
      </para>
    </note>

પ્રકારનો સંદર્ભ લેવા માટે:

    <type>unsigned char</type>

બહારનાં બંધારણનો સંદર્ભ લેવા માટે (GTK દસ્તાવેજોમાં વર્ણવેલ નથી):

    <structname>XFontStruct</structname>

બંધારણનાં ક્ષેત્રનો સંદર્ભ લેવા માટે:

    <structfield>len</structfield>

To refer to a class name, we could possibly use:

    <classname>GtkWidget</classname>

but you'll probably be using #GtkWidget instead (to automatically create a link to the GtkWidget page - see the abbreviations).

લખાણ પર ભાર મૂકવા માટે:

    <emphasis>This is important</emphasis>

ફાઇલનામો વાપરવા માટે:

    <filename>/home/user/documents</filename>

કીઓ વાપરવાનું સંદર્ભ લેવા માટે:

    <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>

## વધારાની ફાઇલોને ભરી રહ્યા છે

ત્યાં વધારાની ફાઇલોની જોડી છે, કે જે ઇનલાઇન સ્ત્રોત કોડ ટિપ્પણીઓની સાથે સાથે વ્યવસ્થિત રાખવા માટેની જરૂર છે: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

### ફાઇલોનાં પ્રકારોને સુધારી રહ્યા છે

જો તમે લાઇબ્રેરી અથવા કાર્યક્રમ એ GtkObjects/GObjects ને સમાવે તો, તમે દસ્તાવેજીકરણમાં બતાવેલ શ્રેણીમાં તેનાં સંકેતો, દલીલો/પરિમાણો અને સ્થાનને ઇચ્છો તો. `<package>.types` ફાઇલ ની અંદર તેનાં સમાવેશ સાથે `xxx_get_type` વિધેયોની ભેગી યાદીમાં તમારે બધાને કરવાની જરૂર છે.

Example types file snippet

    #include <gtk/gtk.h>

    gtk_accel_label_get_type
    gtk_adjustment_get_type
    gtk_alignment_get_type
    gtk_arrow_get_type

જ્યાં સુધી GTK-Doc 1.8 gtkdoc-scan એ તમારા માટે આ યાદી ઉત્પન્ન કરી શકે, `Makefile.am` માં SCAN_OPTIONS માટે "--rebuild-types" ને ખાલી ઉમેરો. જો તમે આ હેતુ થી વાપરો તો તમારે ફાઇલનાં પ્રકારોની યાદી કરવી જોઇએ નહિ અથવા આવૃત્તિ નિયંત્રણ હેઠળ તે હોવુ જોઇએ નહિં.

### મુખ્ય દસ્તાવેજને સુધારી રહ્યા છે

GTK-Doc produces documentation in DocBook SGML/XML. When processing the inline source comments, the GTK-Doc tools generate one documentation page per class or module as a separate file. The master document includes them and place them in an order.

While GTK-Doc creates a template master document for you, later run will not touch it again. This means that one can freely structure the documentation. That includes grouping pages and adding extra pages. GTK-Doc has now a test suite, where also the master-document is recreated from scratch. Its a good idea to look at this from time to time to see if there are some new goodies introduced there.

Do not create tutorials as extra documents. Just write extra chapters. The benefit of directly embedding the tutorial for your library into the API documentation is that it is easy to link for the tutorial to symbol documentation. Apart chances are higher that the tutorial gets updates along with the library.

So what are the things to change inside the master document? For a start is only a little. There are some placeholders (text in square brackets) there which you should take care of.

મુખ્ય દસ્તાવેજ મથાળુ

    <bookinfo>
      <title>MODULENAME Reference Manual</title>
      <releaseinfo>
        for MODULENAME [VERSION]
        The latest version of this documentation can be found on-line at
        <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
      </releaseinfo>
    </bookinfo>

    <chapter>
      <title>[Insert title here]</title>

### વિભાગ ફાઇલને સુધારી રહ્યા છે

The section file is used to organise the documentation output by GTK-Doc. Here one specifies which symbol belongs to which module or class and control the visibility (public or private).

The section file is a plain test file with xml like syntax (using tags). Blank lines are ignored and lines starting with a '#' are treated as comment lines.

The <FILE> ... </FILE> tag is used to specify the file name, without any suffix. For example, using '<FILE>gnome-config</FILE>' will result in the section declarations being output in the template file `tmpl/gnome-config.sgml`, which will be converted into the DocBook SGML/XML file `sgml/gnome-config.sgml` or .DocBook XML file `xml/gnome-config.xml`. (The name of the html file is based on the module name and the section title, or for gobjects it is based on the gobjects class name converted to lower case).

The <TITLE> ... </TITLE> tag is used to specify the title of the section. It is only useful before the templates (if used) are initially created, since the title set in the template file overrides this. Also if one uses SECTION comment in the sources, this is obsolete.

You can group items in the section by using the <SUBSECTION> tag. Currently it outputs a blank line between subsections in the synopsis section. You can also use <SUBSECTION Standard> for standard GObject declarations (e.g. the functions like g_object_get_type and macros like G_OBJECT(), G_IS_OBJECT() etc.). Currently these are left out of the documentation. You can also use <SUBSECTION Private> for private declarations which will not be output (It is a handy way to avoid warning messages about unused declarations.). If your library contains private types which you don't want to appear in the object hierarchy and the list of implemented or required interfaces, add them to a Private subsection. Wheter you would place GObject and GObjectClass like structs in public or Standard section depends if they have public entries (variables, vmethods).

You can also use <INCLUDE> ... </INCLUDE> to specify the #include files which are shown in the synopsis sections. It contains a comma-separate list of #include files, without the angle brackets. If you set it outside of any sections, it acts for all sections until the end of the file. If you set it within a section, it only applies to that section.

## પરિણામને નિયંત્રણ કરી રહ્યા છે

A GTK-Doc run generates report files inside the documentation directory. The generated files are named: `<package>-undocumented.txt`, `<package>-undeclared.txt` and `<package>-unused.txt`. All those are plain text files that can be viewed and postprocessed easily.

The `<package>-undocumented.txt` file starts with the documentation coverage summary. Below are two sections divided by blank lines. The first section lists undocumented or incomplete symbols. The second section does the same for section docs. Incomplete entries are those, which have documentation, but where e.g. a new parameter has been added.

`<package>-sections.txt` માં આપેલ સંકેતોને `<package>-undeclared.txt` એ યાદી કરે છે પરંતુ સ્ત્રોતોમાં મળ્યુ નથી. ચકાસો જો તેઓને દૂર કરી દેવામાં આવી રહ્યુ છે અથવા જો તેઓની જોડણી થયેલ નથી.

`<package>-unused.txt` ફાઇલ એ સંકેત નામોની યાદી કરે છે, જ્યાં GTK-Doc સ્કેનર એ દસ્તાવેજીકરણને શોધ્યુ હતુ, પરંતુ જાણતા નથી ક્યાં તેને મૂકવાનું. આનો મતલબ એ કે સંકેતને હજુ `<package>-sections.txt` ફાઇલ માં ઉમેરી દેવામાં આવ્યા નથી.

સક્રિય કરો અથવા Makefile.am માં `TESTS=$(GTKDOC_CHECK)` વાક્ય ને ઉમેરો. જો ઓછામાં ઓછુ GTK-Doc 1.9 સ્થાપિત થયેલ હોય તો, આ `make check` ને ચલાવવા દરમ્યાન સેનિટિ ચકાસણીને ચલાવશે.

One can also look at the files produced by the source code scanner: `<package>-decl-list.txt` and `<package>-decl.txt`. The first one can be compared with the section file if that is manualy maintained. The second lists all declarations fromt he headers If a symbol is missing one could check if this file contains it.

જો પ્રોજેક્ટ એ GObject આધારિત હોય તો, એક ઓબ્જેક્ટ સ્કેનર દ્દારા ઉત્પન્ન થયેલ ફાઇલોમાં પણ જોઇ શકો છો: `<package>.args.txt`, `<package>.hierarchy.txt`, `<package>.interfaces.txt`, `<package>.prerequisites.txt` અને `<package>.signals.txt`. જો ત્યાં પેલાનાં કોઇપણમાં ગુમ થયેલ સંકેતો છે તો, આગળ પૃથ્થકરણ માટે અંતર્માધ્યમ સ્કેનર ફાઇલને રાખવા માટે એકજણ gtkdoc ને પૂછી શકે છે, પરંતુ `GTK_DOC_KEEP_INTERMEDIATE=1 make` તરીકે તેને ચલાવી રહ્યા છે.

## Documenting other interfaces

So far we have been using GTK-Doc to document the API of code. The next sections contain suggestions how the tools can be used to document other interfaces too.

### Commandline options and man pages

As one can generate man pages for a docbook refentry as well, it sounds like a good idea to use it for that purpose. This way the interface is part of the reference and one gets the man-page for free.

#### Document the tool

Create one refentry file per tool. Following our example we would call it `meep/docs/reference/meeper/meep.xml`. For the xml tags that should be used and can look at generated file in the xml subdirectory as well as examples e.g. in glib.

#### Adding the extra configure check

Extra configure checks

    AC_ARG_ENABLE(man,
                  [AC_HELP_STRING([--enable-man],
                                  [regenerate man pages from Docbook [default=no]])],enable_man=yes,
                  enable_man=no)

    AC_PATH_PROG([XSLTPROC], [xsltproc])
    AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)

#### Adding the extra makefile rules

Extra configure checks

    man_MANS = \
           meeper.1

    if ENABLE_GTK_DOC
    if ENABLE_MAN

    %.1 : %.xml
            @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<

    endif
    endif

    BUILT_EXTRA_DIST = $(man_MANS)
    EXTRA_DIST += meep.xml

### DBus interfaces

(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)

## Frequently asked questions

પ્રશ્ર્ન જવાબ
- વર્ગની શ્રેણી નથી. ઓબ્જેક્ટો એ ફાઇલ `xxx_get_type()` માં દાખલ કરી દેવામાં આવ્યુ નથી `<package>.types`
- હજુ વર્ગ શ્રેણી નથી. `<package>-sections.txt` ફાઇલમાં ગુમ થયેલ અથવા ખોટુ નામ (જુઓ વિગતવાર).
- Damn, I have still no class hierarchy. Is the object name (name of the instance struct, e.g. GtkWidget) part of the normal section (don't put this into Standard or Private subsections).
- સંકેત અનુક્રમણિકા નથી. Does the `<package>-docs.{xml,sgml}` contain a index that xi:includes the generated index?
- સંકેતો એ તેનાં દસ્તાવેજ-વિભાગમાં કડી થયેલ નથી. Is the doc-comment using the correct markup (added #,% or ())? Check if the gtkdoc-fixxref warns about unresolvable xrefs.
- નવો વર્ગ એ દસ્તાવેજોમાં દેખાતો નથી. શું તે નવુ પાનું xi છે: `<package>-docs.{xml,sgml}` માંથી સમાવેલ છે.
- નવો સંકેત એ દસ્તાવેજોમાં દેખાતુ નથી. Is the doc-comment properly formatted. Check for spelling mistakes in the begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable xrefs. Check if the symbol is correctly listed in the `<package>-sections.txt` in a public subsection.
- પ્રકાર એ વર્ગ શ્રેણામાંથી ગુમ થયેલ છે. If the type is listed in `<package>.hierarchy` but not in `xml/tree_index.sgml` then double check that the type is correctly placed in the `<package>-sections.txt`. If the type instance (e.g. GtkWidget) is not listed or incidentialy makred private it will not be shown.
- બધા gobject ઍનોટેશન માટે foldoc કડીઓ મને મળે છે. ચકાસો કે જે `xml/annotation-glossary.xml` એ xi છે: `<package>-docs.{xml,sgml}` માંથી સમાવેલ છે.
- સ્ત્રોત કોડ ટિપ્પણી બ્લોકમાં પરિમાણ વર્ણવેલ છે પરંતુ અસ્તિત્વ ધરાવતુ નથી ચકાસો જો મથાળામાં પ્રોટોટાઇપ પાસે સ્ત્રોતમાં વિવિધ પરિમાણ નામો છે.
- multiple "IDs" for constraint linkend: XYZ સંકેત XYZ એ `<package>-sections.txt` ફાઇલમાં બે વાર દેખાય છે.
- Element typename in namespace '' encountered in para, but no template matches.

## Tools related to gtk-doc

GtkDocPlugin - a Trac GTK-Doc integration plugin, that adds api docs to a trac site and integrates with the trac search.

Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since tags in the api to determine the minimum required version.

Version 1.1, March 2000
2000 Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street, Suite 330, Boston, MA02110-1301USA

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

## GNU Free Documentation License

### 0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other written document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of copyleft, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

### 1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The Document, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as you.

A Modified Version of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A Secondary Section is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (For example, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The Invariant Sections are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License.

The Cover Texts are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License.

A Transparent copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A copy that is not Transparent is called Opaque.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML designed for human modification. Opaque formats include PostScript, PDF, proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML produced by some word processors for output purposes only.

The Title Page means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, Title Page means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

### 2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

### 3. COPYING IN QUANTITY

If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

### 4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

- A

  Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

- B

  List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has less than five).

- C

  State on the Title Page the name of the publisher of the Modified Version, as the publisher.

- D

  દસ્તાવેજ ની કોપીરાઇટ બધી સૂચનાઓને સાચવો.

- E

  Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

- F

  Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

- G

  Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

- H

  આ લાઇસન્સની ચેતવણી ન થયેલ નકલને સમાવો.

- I

  Preserve the section entitled History, and its title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section entitled History in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

- J

  Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the History section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

- K

  In any section entitled Acknowledgements or Dedications, preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

- L

  Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

- M

  Delete any section entitled Endorsements. Such a section may not be included in the Modified Version.

- N

  Do not retitle any existing section as Endorsements or to conflict in title with any Invariant Section.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section entitled Endorsements, provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version .

### 5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections entitled History in the various original documents, forming one section entitled History; likewise combine any sections entitled Acknowledgements, and any sections entitled Dedications. You must delete all sections entitled Endorsements.

### 6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and dispbibute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

### 7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an aggregate, and this License does not apply to the other self-contained works thus compiled with the Document , on account of their being thus compiled, if they are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.

### 8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.

### 9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

### 10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License or any later version applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

### Addendum

તમે લખેલ છે તે દસ્તાવેજમાં આ લાઇસન્સને વાપરવા માટે, દસ્તાવેજમાં લાઇસન્સની નકલને સમાવો અને નીચેનાં કોપીરાઇટ અને લાઇસન્સ સૂચનાઓને શીર્ષક પાનાં પછી મૂકો:

> Copyright YEAR YOUR NAME.

> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled GNU Free Documentation License.

If you have no Invariant Sections, write with no Invariant Sections instead of saying which ones are invariant. If you have no Front-Cover Texts, write no Front-Cover Texts instead of Front-Cover Texts being LIST; likewise for Back-Cover Texts.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.