tomtom-international / asciidoxy

AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
Apache License 2.0
31 stars 10 forks source link

Properly defined group can't be inserted #34

Open r0ckarong opened 3 years ago

r0ckarong commented 3 years ago

I have a C++ codebase which contains a group that is defined properly for doxygen and is also exported to XML and HTML successfully. When I try to reference this exact group by its name from asciidoxy I get the error message Cannot find any hil_pslwip_api for any.

/** @defgroup hil_pslwip_api LwIP based IP Stack API
 *
 *  This group describes the application interface of the LwIP based IP stack
 * component.
 *
 * @{ */

[...]

This is the adoc file. I get the information for LWIP_MEMORY_POOL_CTG_T and LWIP_INIT_PARAM_T fine but the group is still eluding me.

= asciidoxy notes
:toc: left

elements are the content of the "innerclass" XML element

${insert("hil_pslwip_api", kind="group")}

${insert("LWIP_MEMORY_POOL_CFG_T")}

${insert("LWIP_INIT_PARAM_T")}

What am I doing wrong here?

Could you please add some more documentation or examples on how to reference elements from C structures? I have managed to reference single elements by looking for the innerclass element in the XML files but I doubt the idea behind this tool is to manually add all definitions to AsciiDoc files?!

I would think the groups and "pages" (for a lack of a better word) that come from the doxygen export would be reusable. Am I just misunderstanding how this is supposed to be used?

silvester747 commented 3 years ago

It looks like AsciiDoxy does not handle the group concept correctly yet. Some work to do here.