Re: [lwip-users] Documentaton - Doxygen

[Laurent BIERGE]

Hi again,

Actually i'm pretty sure that i found the cause.
All the files that are displayed have something like:
/**
 * @file
 * This file (together with sockets.h) aims to provide structs and functions 
from
 * - arpa/inet.h
 * - netinet/in.h
 *
 */
at the begining of the file.
I tried to add this in netif.h (with just "netif" after @file) and i 
regenerated the documentation with doxygen but it didn't work.
But, i'm pretty sure that it's the cause anyway. Maybe i tried the use doxygen 
too soon after the save.

In the doxyfile you can add an option to put the code in the documentation. 
When you view the code in the doxygen interface you won't see the /** @file... 
*/ part but when you open it with a text editor you will see it.
Doxygen must interpret this part to add the file in the documentation. (at 
least i'm almost sure) 

Laurent

----- Mail original -----
De: "Laurent BIERGE" <address@hidden>
À: "lwip-users" <address@hidden>
Envoyé: Mardi 24 Mai 2016 13:33:18
Objet: Re: [lwip-users] Documentaton - Doxygen

Yep, that's it !

I've tried to look into different configuration for the doxyfile but i didn't 
manage the get all the header files.
I also compared the lwip doxyfile with the fnet doxyfile (another stack) but i 
didn't manage to see the difference that could make doxygen work better with 
lwip.
Actually like you said it should take all the files in src, i don't understand 
why some header are include and why some other are not. (e.g: in lwip file 
inet.h is included but netif.h isn't)

It's not a big issue but it's a bit bothersome. 

Laurent

Ps: i've tested to empty "FILE_PATTERNS = ", and did other tries but that was 
just wild guess. ,(nothing worked).
Maybe the documentation in those files aren't done in the same way that those 
which are display by doxygen. 

----- Mail original -----
De: "Simon Goldschmidt" <address@hidden>
À: "lwip-users" <address@hidden>
Envoyé: Mardi 24 Mai 2016 11:00:37
Objet: Re: [lwip-users] Documentaton - Doxygen

Simon Goldschmidt wrote:
> Laurent BIERGE wrote:
>> Perfect ! Even if all the files are not inclued at least it works !
> [..]
> Can you tell us which files you think are missing?

Running doxygen I do see that some header files are missing, which results in 
some types not showing up...
Is it that you are missing?


Simon

_______________________________________________
lwip-users mailing list
address@hidden
https://lists.nongnu.org/mailman/listinfo/lwip-users

_______________________________________________
lwip-users mailing list
address@hidden
https://lists.nongnu.org/mailman/listinfo/lwip-users