[clang-doc] --repository links don't work with github

[danakj]

The generated links are of the form https://repository/path.h#22

However github requires the URL fragmment to be L22 not 22, so it should be https://repository/path.h#L22

A configuration option to adjust the url fragment would be appreciated.

[hulxv]

@ilovepi Can I be assigned to this issue? Please give me more details about it also.

[hulxv]

As I read in 1a7e79b, we can parse the URL of the repo and detect if it's a host that has a prefix or not, such as GitHub or Gitlab (they also use L letter for lines as github). Is my approach correct?

[ilovepi]

@hulxv So the basic problem seems to be that the current implementation assumes how this will be spelled, which is problematic. To start, I'd suggest adding a configuration option to set this, via command line option, and then follow up with some kind of detection heuristic in a second patch.

[hulxv]

To start, I'd suggest adding a configuration option to set this, via command line option, and then follow up with some kind of detection heuristic in a second patch.

Do you mean adding an argument to change the line anchor manually from the user? like --repo-line-prefix=L

My first idea is doing something like that, and listing prefixes of each host. Is it not better?

static std::string getLineAnchor(const llvm::StringRef RepositoryUrl,
                                 int LineNumber) {

  const std::unordered_map<std::string, std::string> SpecialRepoAnchorMap = {
      {"github.com", "L"},
      {"gitlab.com", "L"},
      // etc....
  };

  for (const auto &entry : SpecialRepoAnchorMap) {
    if (RepositoryUrl.contains(entry.first))
      return "#" + entry.second + std::to_string(LineNumber);
  }

  return "#" + std::to_string(LineNumber); // default prefixe
}