Lines Matching full:doc
4 :ref:`Documentation/doc-guide/index.rst <doc_guide>`
9 Scrivere i commenti in kernel-doc
13 strutturanti secondo il formato kernel-doc. Essi possono descrivere funzioni,
16 .. note:: Il formato kernel-doc può sembrare simile a gtk-doc o Doxygen ma
18 contengono decine di migliaia di commenti kernel-doc. Siete pregati
21 La struttura kernel-doc è estratta a partire dai commenti; da questi viene
28 .. _`dominio Sphinx per il C`: http://www.sphinx-doc.org/en/stable/domains.html
32 kernel-doc. Quando l'intenzione è di utilizzarle nei moduli, anche le funzioni
34 kernel-doc.
37 secondo kernel-doc per le funzioni che sono visibili da altri file del kernel
39 inoltre, di fornire una documentazione kernel-doc anche per procedure private
46 Sicuramente la documentazione formattata con kernel-doc è necessaria per
50 Cerchiamo anche di fornire una documentazione formattata secondo kernel-doc
54 Raccomandiamo, inoltre, di fornire una documentazione formattata con kernel-doc
60 documentate utilizzando commenti formattati con kernel-doc.
62 Come formattare i commenti kernel-doc
65 I commenti kernel-doc iniziano con il marcatore ``/**``. Il programma
66 ``kernel-doc`` estrarrà i commenti marchiati in questo modo. Il resto
71 I commenti kernel-doc di funzioni e tipi dovrebbero essere posizionati
74 anche la documentazione. I commenti kernel-doc di tipo più generale possono
78 eseguire il programma ``kernel-doc`` con un livello di verbosità alto e senza
81 scripts/kernel-doc -v -none drivers/foo/bar.c
91 Generalmente il formato di un commento kernel-doc per funzioni e
146 dovrebbe essere scritta con la notazione kernel-doc::
203 Generalmente il formato di un commento kernel-doc per struct, union ed enum è::
314 qualsiasi altro commento kernel-doc::
348 Generalmente il formato di un commento kernel-doc per typedef è
374 All'interno dei commenti di tipo kernel-doc vengono riconosciuti i seguenti
379 kernel-doc, e **non** all'interno di documenti reStructuredText.
395 potrebbero assumere un significato diverso in kernel-doc o in reStructuredText
425 kernel-doc. Sarà sufficiente terminare i nomi di funzione con ``()``,
446 dei blocchi di documentazione kernel-doc con un formato libero invece
451 Questo s'ottiene utilizzando la parola chiave ``DOC:`` a cui viene associato
458 * DOC: Theory of Operation
469 Il titolo che segue ``DOC:`` funziona da intestazione all'interno del file
474 Includere i commenti di tipo kernel-doc
479 kernel-doc per Sphinx.
481 Le direttive kernel-doc sono nel formato::
483 .. kernel-doc:: source
495 Il campo *source-patter* è utile quando i commenti kernel-doc sono stati
501 .. kernel-doc:: lib/bitmap.c
504 .. kernel-doc:: include/net/mac80211.h
515 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
525 .. kernel-doc:: lib/bitmap.c
528 .. kernel-doc:: lib/idr.c
534 doc: *title*
535 Include la documentazione del paragrafo ``DOC:`` identificato dal titolo
544 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
545 :doc: High Definition Audio over HDMI and Display Port
547 Senza alcuna opzione, la direttiva kernel-doc include tutti i commenti di
550 L'estensione kernel-doc fa parte dei sorgenti del kernel, la si può trovare
552 lo script ``scripts/kernel-doc`` per estrarre i commenti di documentazione
555 Come utilizzare kernel-doc per generare pagine man
558 Se volete utilizzare kernel-doc solo per generare delle pagine man, potete
561 …$ scripts/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | scripts/split-man.pl…