Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properly defined group can't be inserted #34

Open
r0ckarong opened this issue Apr 14, 2021 · 1 comment
Open

Properly defined group can't be inserted #34

r0ckarong opened this issue Apr 14, 2021 · 1 comment
Labels
Improvement New feature or request
Milestone

Comments

@r0ckarong
Copy link
Contributor

r0ckarong commented Apr 14, 2021

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 silvester747 added the Improvement New feature or request label May 29, 2021
@silvester747
Copy link
Collaborator

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

@silvester747 silvester747 added this to the 0.9.x Delilah milestone Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants