libc a __DOXYGEN__

[Adam Heinrich]

V sekci pro Doxygen jsou definovány důležité konstanty a komentáře k nim 
pro generování dokumentace, "ostrá" sekce !Doxygen pak obsahuje samotná 
makra. Je to nejspíš proto, aby se programátorům lépe a přehledněji 
psala dokumentace. V Javě/C/PHP je jednoduché definovat si všechny 
důležité proměnné nahoře a napsat k nim pro přehlednost dokumentační 
komentář (javadoc, phpdoc, ..), ale udělat to s konstantami by tak 
jednoduché nebylo - dají se definovat pouze jednou a komentáře by pak 
musely být rozesety různě po hlavičkovém souboru, což by vedlo k jisté 
nepřehlednosti (obzvláště při použití různých if-konstrukcí :-) ).

Adam Heinrich
www.adamh.cz



Luboš Melichar napsal(a):
> jj nastroj na dokumentaci to je urcite a tak nejak to funguje, ale
> proc je napr. v setbaudrate.h (include/util/) vyse zminena konstrukce?
>
> #if defined(__DOXYGEN__)
> ..
> #else /* !__DOXYGEN__ */
> ..
> #endif /* __DOXYGEN__ */
>
>
> 2009/8/30 Lukas Burda <burdal1@post.cz>:
>   
>> Dobry den,
>> i kdyz jsem to nikdy sam ve svych zdrojacich nepouzival, vzdycky jsem
>> si myslel, ze prozenete nejakym "doxygen nastrojem" zdrojaky a ono to
>> vyrobi soubory s dokumentaci... viz treba zdrojaky I2C master a online
>> dokumentace na tom webu http://homepage.hispeed.ch/peterfleury/avr-software.html
>>
>> Lukas Burda
>>
>>
>>
>> Sunday, August 30, 2009, 11:54:08 AM, you wrote:
>>
>>     
>>> Doxygen by podle googlu měl být nástroj na tvorbu dokumentace z
>>> komentářů, něco jako javadoc... Proč by ale někdo rozděloval kód podle toho jestli je
>>> použit nebo ne mi není jasné.
>>>       
>>> ---------
>>> Adam Heinrich
>>> www.adamh.cz
>>>       
>>> -původní zpráva-
>>> Předmět: libc a __DOXYGEN__
>>> Od: Luboš Melichar <lubos.melichar@gmail.com>
>>> Datum: 30.08.2009 11.32
>>>       
>>> Docela casto nachazim v avr libc konstrukci...
>>>       
>>> #if defined(__DOXYGEN__)
>>> ..
>>> #else /* !__DOXYGEN__ */
>>> ..
>>> #endif /* __DOXYGEN__ */
>>>       
>>> k cemu to slouzi?
>>> diky.
>>> _______________________________________________
>>> HW-list mailing list  -  sponsored by www.HW.cz
>>> Hw-list@list.hw.cz
>>> http://list.hw.cz/mailman/listinfo/hw-list
>>>       
>>> _______________________________________________
>>> HW-list mailing list  -  sponsored by www.HW.cz
>>> Hw-list@list.hw.cz
>>> http://list.hw.cz/mailman/listinfo/hw-list
>>>       
>> _______________________________________________
>> HW-list mailing list  -  sponsored by www.HW.cz
>> Hw-list@list.hw.cz
>> http://list.hw.cz/mailman/listinfo/hw-list
>>
>>     
>
>
>
>