Re: Document function declarations in header

[Stefan Sauer <ensonic hora-obscura de>]

On 01/29/2018 06:19 PM, Aleksandr Slobodeniuk wrote:

Hi everyone!

 

I'm trying to generate HTMLs from one .h file, that describes some API.

In result HTML I see there's no functions, only described structs and enums.

 

Is it possible to generate documentation, if "documentation comments" are written near declaration of functions (not definitions)?

It should be possible to have function doc-comments in the header. Can you put that header on some pastebin site?

Also are you manually writing the $(DOC_MODULE)-section.txt or do you let gtkdoc generate it? You can check the
$(DOC_MODULE)-decl-list.txt and $(DOC_MODULE)-decl.txt file to see if gtkdoc picked up your symbol.

 

P.S. it's ok to scan all the code, the issue is that I would like to keep the comments in header.

 

Thanks!

-- 

Atentamente,

Aleksandr Slobodeniuk

tel: +34 661 674 116

 

 

 

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list gnome org
https://mail.gnome.org/mailman/listinfo/gtk-doc-list