more than one grouped free functions doesn't render

Open
#90 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, python, xml
Domain
documentation

Research direction

Start by reproducing the supplied C++ example in docca and inspect the generated documentation for both grouped blocks. Compare it with the behavior when the second group markers are removed. Done means the second function in each group renders its associated Javadoc.

Written by the indexing model from the issue text.

Description

If you group 2 friends, it works. But if you try to group another 2 friends, it stops working.

struct T {
  friend void f1a();
  friend void f1b();
  friend void f2a();
  friend void f2b();
  friend void f3a();
  friend void f3b();
  };

///@{
/** First group
*/
void f1a();

void f1b();
///@}

///@{
/** Second group
*/
void f2a();

void f2b();
///@}

/** Third single function
*/
void f3a();

/** Third single function
*/
void f3b();

Result: The 2nd element of each group doesn't have a javadoc. If you remove the 2nd group markings, then the 2nd element of the first group renders. If you can't repro this I can show you in the actual library where it happens, in case it is contextual.

Dominant language
Python
Stars
20
Forks
25
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/docca

All issues in boostorg/docca

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.