Skip to content
This repository has been archived by the owner on Oct 20, 2022. It is now read-only.

C union are missing in classes/ output #22

Closed
markand opened this issue Dec 2, 2020 · 1 comment
Closed

C union are missing in classes/ output #22

markand opened this issue Dec 2, 2020 · 1 comment

Comments

@markand
Copy link

markand commented Dec 2, 2020

Given a following example of doxygen documentation:

#ifndef TEST_H
#define TEST_H

/**
 * \file test.h
 */

/**
 * \brief The foo struct.
 */
struct foo {
	int fa; /*!< Field 1. */
	int fb; /*!< Field 2. */
};

/**
 * \brief The baz union.
 */
union baz {
	int ba; /*!< Field 1. */
	int bb; /*!< Field 2. */
};

#endif

Using a plain default Doxyfile (just setting GENERATE_XML to Yes) and invoking doxybook2, it looks like union are missing from the output.

$ doxybook2 -i xml -o docs
Using lookup template path: ''
Parsing template: 'meta' from default
Parsing template: 'header' from default
Parsing template: 'breadcrumbs' from default
Parsing template: 'class_members_tables' from default
Parsing template: 'class_members_inherited_tables' from default
Parsing template: 'details' from default
Parsing template: 'member_details' from default
Parsing template: 'class_members_details' from default
Parsing template: 'footer' from default
Parsing template: 'kind_class' from default
Parsing template: 'kind_page' from default
Parsing template: 'index' from default
Parsing template: 'index_pages' from default
Parsing template: 'nonclass_members_tables' from default
Parsing template: 'nonclass_members_details' from default
Parsing template: 'kind_file' from default
Parsing template: 'index_namespaces' from default
Parsing template: 'index_files' from default
Parsing template: 'index_examples' from default
Parsing template: 'kind_nonclass' from default
Parsing template: 'index_groups' from default
Parsing template: 'index_classes' from default
Loading...
Loading xml/structfoo.xml
Loading xml/test_8h.xml
Loading xml/unionbaz.xml
Finalizing...
Rendering...
Parsing xml/structfoo.xml
Rendering docs/Classes/structfoo.md
Parsing xml/test_8h.xml
Rendering docs/Files/test_8h.md
Rendering docs/index_classes.md
Rendering docs/index_namespaces.md
Rendering docs/index_groups.md
Rendering docs/index_files.md
Rendering docs/index_pages.md
Rendering docs/index_examples.md

It properly loads xml/unionbaz.xml from Doxygen and listed correctly in the files list:

$ grep baz docs/Files/test_8h.md 
| union | **[baz](Classes/unionbaz.md)** <br>The baz union.  |

But there is no files Classes/unionbaz.md generated though.

$ stat docs/Classes/structfoo.md 
16777224 16931640 -rw-r--r-- 1 markand wheel 0 595 "Dec  2 09:27:18 2020" "Dec  2 09:29:08 2020" "Dec  2 09:29:08 2020" "Dec  2 09:27:18 2020" 4096 8 0 docs/Classes/structfoo.md
$ stat docs/Classes/unionbaz.md
stat: docs/Classes/unionbaz.md: stat: No such file or directory
@matusnovak
Copy link
Owner

Thanks for spotting this bug.

It was only generating unions that belong to some class or namespace, not global ones.

Fixed in the new release releases/tag/v1.3.0

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants