Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

Obě strany předchozí revize Předchozí verze
Následující verze
Předchozí verze
public:doxygen [2016/04/28 09:41]
Roman Lacko [Dokumentace funkcí] in/out pre pointery
public:doxygen [2018/02/24 19:10] (aktuální)
Řádek 17: Řádek 17:
 ==== Dokumentace souborů ==== ==== Dokumentace souborů ====
  
-**Dokumentaci pište pouze do hlavičkových ​souborů ​''​%%*.h%%''​**, ​výjimkou je ''​%%main.c%%''​. V textu dokumentace používejte angličtinu.+**hlavičkových ​souborech** a **''​main.c''​** ​pište plnou dokumentaci funkcístruktur atd., ve všech souborech navíc pište tagy ''​@author''​ a ''​@file''​. 
 +V textu dokumentace používejte angličtinu. 
 + 
 +=== Ukázka hlavičkového souboru ===
  
 <code c> <code c>
Řádek 35: Řádek 38:
  
 #endif // MY_AWESOME_LIBRARY_H #endif // MY_AWESOME_LIBRARY_H
 +</​code>​
 +
 +=== Ukázka jiného (nehlavičkového) souboru ===
 +
 +<code c>
 +/**
 + * @author John Doe <​john.doe@example.com>​
 + * @file   ​list.c
 + */
 +
 +...
 </​code>​ </​code>​
 ==== Dokumentace struktur a výčtových typů ==== ==== Dokumentace struktur a výčtových typů ====
QR Code
QR Code public:doxygen (generated for current page)