.. | .. |
---|
107 | 107 | * Context: Describes whether the function can sleep, what locks it takes, |
---|
108 | 108 | * releases, or expects to be held. It can extend over multiple |
---|
109 | 109 | * lines. |
---|
110 | | - * Return: Describe the return value of foobar. |
---|
| 110 | + * Return: Describe the return value of function_name. |
---|
111 | 111 | * |
---|
112 | 112 | * The return value description can also have multiple paragraphs, and should |
---|
113 | 113 | * be placed at the end of the comment block. |
---|
.. | .. |
---|
515 | 515 | .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c |
---|
516 | 516 | :internal: |
---|
517 | 517 | |
---|
| 518 | +identifiers: *[ function/type ...]* |
---|
| 519 | + Include la documentazione per ogni *function* e *type* in *source*. |
---|
| 520 | + Se non vengono esplicitamente specificate le funzioni da includere, allora |
---|
| 521 | + verranno incluse tutte quelle disponibili in *source*. |
---|
| 522 | + |
---|
| 523 | + Esempi:: |
---|
| 524 | + |
---|
| 525 | + .. kernel-doc:: lib/bitmap.c |
---|
| 526 | + :identifiers: bitmap_parselist bitmap_parselist_user |
---|
| 527 | + |
---|
| 528 | + .. kernel-doc:: lib/idr.c |
---|
| 529 | + :identifiers: |
---|
| 530 | + |
---|
| 531 | +functions: *[ function ...]* |
---|
| 532 | + Questo è uno pseudonimo, deprecato, per la direttiva 'identifiers'. |
---|
| 533 | + |
---|
518 | 534 | doc: *title* |
---|
519 | 535 | Include la documentazione del paragrafo ``DOC:`` identificato dal titolo |
---|
520 | 536 | (*title*) all'interno del file sorgente (*source*). Gli spazi in *title* sono |
---|
.. | .. |
---|
527 | 543 | |
---|
528 | 544 | .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c |
---|
529 | 545 | :doc: High Definition Audio over HDMI and Display Port |
---|
530 | | - |
---|
531 | | -functions: *function* *[...]* |
---|
532 | | - Dal file sorgente (*source*) include la documentazione per le funzioni |
---|
533 | | - elencate (*function*). |
---|
534 | | - |
---|
535 | | - Esempio:: |
---|
536 | | - |
---|
537 | | - .. kernel-doc:: lib/bitmap.c |
---|
538 | | - :functions: bitmap_parselist bitmap_parselist_user |
---|
539 | 546 | |
---|
540 | 547 | Senza alcuna opzione, la direttiva kernel-doc include tutti i commenti di |
---|
541 | 548 | documentazione presenti nel file sorgente (*source*). |
---|