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

No brief description in detailed output for members if there is no detailed description #113

Closed
DmitriyMarin opened this issue Sep 6, 2024 · 0 comments

Comments

@DmitriyMarin
Copy link
Contributor

Hi! Thanks for the great package!

There is a possible copy/paste issue: if a member function, macros, etc. have a brief description done in doxygen but no detailed description then no brief description is added to the detailed output done using templates/memDef.jinja2 because the has function of the Brief class in Prperty checks for "detaileddescription" in XML instead of "briefdescription":

    class Brief:
        #...
        def has(self) -> bool:
            detaileddescription = self.xml.find("detaileddescription")
            return len(list(detaileddescription)) > 0

This can be overcome by customizing the memDef.jinja2 template by omitting the node.has_brief check, i.e. going from:

{% if configMemDef.get('brief') -%}
{% if node.has_brief -%}
{{node.brief + "\n"}}
{%- endif -%}
{%- endif -%}

to

{% if configMemDef.get('brief') -%}
{{node.brief + "\n"}}
{%- endif -%}
DmitriyMarin added a commit to DmitriyMarin/MkDoxy that referenced this issue Sep 11, 2024
This commit fixes the issue JakubAndrysek#113: No brief description in detailed output for members if there is no detailed description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants