On 01/31/2018 04:45 PM, Aleksandr Slobodeniuk wrote:
> > It should be possible to have function doc-comments in the header.
>  
> Yes, thanls, I've found the reason of problem.
>  
> All function declarations had macro first, which is actually empty. Like:
> _MACRO_ int my_function();
>  
> Gtk-doc 1.25 didn't include that functions to sections.txt/xml/html .
> But if I write enter after macro, like this:
>  
> _MACRO_
> int my_function();
>  
> Then it works, no matter where I'm writing the "documentation
> comments" (in header or code).
>  
> Looks like a bug in a parser.

The parser parses 'C'. Before the preprocessor runs a c/h file is not
necessarily valid. For non standard macros, you can tell gtkdoc to
ignore them. Use e.g. SCAN_OPTIONS="--ignore-decorators=_MACRO_" in
Makefile.am.

Stefan
> -- 
> Atentamente,
> Aleksandr Slobodeniuk
> tel: +34 661 674 116
>  
>  
>  
>  
>  
> 31.01.2018, 18:32, "Stefan Sauer" <enso...@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 <mailto:gtk-doc-list@gnome.org>
>>> https://mail.gnome.org/mailman/listinfo/gtk-doc-list
>>
>>  
>>
>> ,
>>
>> _______________________________________________
>> gtk-doc-list mailing list
>> gtk-doc-list@gnome.org <mailto:gtk-doc-list@gnome.org>
>> https://mail.gnome.org/mailman/listinfo/gtk-doc-list
>>
>
>
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@gnome.org
> https://mail.gnome.org/mailman/listinfo/gtk-doc-list


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

Reply via email to