Lines Matching full:doc
4 :ref:`Documentation/doc-guide/index.rst <doc_guide>`
6 .. title:: Commenti in kernel-doc
11 Scrivere i commenti in kernel-doc
15 strutturanti secondo il formato kernel-doc. Essi possono descrivere funzioni,
18 .. note:: Il formato kernel-doc può sembrare simile a gtk-doc o Doxygen ma
20 contengono decine di migliaia di commenti kernel-doc. Siete pregati
23 La struttura kernel-doc è estratta a partire dai commenti; da questi viene
30 .. _`dominio Sphinx per il C`: http://www.sphinx-doc.org/en/stable/domains.html
34 kernel-doc. Quando l'intenzione è di utilizzarle nei moduli, anche le funzioni
36 kernel-doc.
39 secondo kernel-doc per le funzioni che sono visibili da altri file del kernel
41 inoltre, di fornire una documentazione kernel-doc anche per procedure private
48 Sicuramente la documentazione formattata con kernel-doc è necessaria per
52 Cerchiamo anche di fornire una documentazione formattata secondo kernel-doc
56 Raccomandiamo, inoltre, di fornire una documentazione formattata con kernel-doc
62 documentate utilizzando commenti formattati con kernel-doc.
64 Come formattare i commenti kernel-doc
67 I commenti kernel-doc iniziano con il marcatore ``/**``. Il programma
68 ``kernel-doc`` estrarrà i commenti marchiati in questo modo. Il resto
73 I commenti kernel-doc di funzioni e tipi dovrebbero essere posizionati
76 anche la documentazione. I commenti kernel-doc di tipo più generale possono
80 eseguire il programma ``kernel-doc`` con un livello di verbosità alto e senza
83 scripts/kernel-doc -v -none drivers/foo/bar.c
93 Generalmente il formato di un commento kernel-doc per funzioni e
148 dovrebbe essere scritta con la notazione kernel-doc::
205 Generalmente il formato di un commento kernel-doc per struct, union ed enum è::
316 qualsiasi altro commento kernel-doc::
350 Generalmente il formato di un commento kernel-doc per typedef è
376 All'interno dei commenti di tipo kernel-doc vengono riconosciuti i seguenti
381 kernel-doc, e **non** all'interno di documenti reStructuredText.
397 potrebbero assumere un significato diverso in kernel-doc o in reStructuredText
427 kernel-doc. Sarà sufficiente terminare i nomi di funzione con ``()``,
448 dei blocchi di documentazione kernel-doc con un formato libero invece
453 Questo s'ottiene utilizzando la parola chiave ``DOC:`` a cui viene associato
460 * DOC: Theory of Operation
471 Il titolo che segue ``DOC:`` funziona da intestazione all'interno del file
476 Includere i commenti di tipo kernel-doc
481 kernel-doc per Sphinx.
483 Le direttive kernel-doc sono nel formato::
485 .. kernel-doc:: source
497 Il campo *source-patter* è utile quando i commenti kernel-doc sono stati
503 .. kernel-doc:: lib/bitmap.c
506 .. kernel-doc:: include/net/mac80211.h
517 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
527 .. kernel-doc:: lib/bitmap.c
530 .. kernel-doc:: lib/idr.c
536 doc: *title*
537 Include la documentazione del paragrafo ``DOC:`` identificato dal titolo
546 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
547 :doc: High Definition Audio over HDMI and Display Port
549 Senza alcuna opzione, la direttiva kernel-doc include tutti i commenti di
552 L'estensione kernel-doc fa parte dei sorgenti del kernel, la si può trovare
554 lo script ``scripts/kernel-doc`` per estrarre i commenti di documentazione
557 Come utilizzare kernel-doc per generare pagine man
560 Se volete utilizzare kernel-doc solo per generare delle pagine man, potete
563 …$ scripts/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | scripts/split-man.pl…