Documentation text may be duplicated
OpenPublic

Description

a.cc:

#include "a.h"

void bar() {
}

a.h:

void bar();

/// This function calls `bar`.
void a();

b.cc:

#include "a.h"

The resulting index has two documentation nodes for a. They have the same raw text, but different links, since in a.cc the defn is visible and in a.h it is not.

Note that if we remove bar from a.h we will still get two documentation nodes, but one will have one link while the other will have no links. This means that simply merging doc nodes by comparing raw text won't work, since nodes we want to call equivalent will be bracketed differently.

zarko created this task.Via WebSep 16 2016, 2:22 PM
zarko claimed this task.
zarko added a project: API.
zarko added a subscriber: zarko.
zarko added a comment.Via WebSep 16 2016, 2:57 PM

I'm considering adding provenance information to documentation nodes; if we do that, we can group by provenance and then try to merge together links.

Add Comment