boostorg / boostorg/website-v2-docs

Autogenerated docs: operators don't seem clickable in overload pages

Open
#399 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
14
Forks
60
Avg merge
12h 47m
Merged PRs (30d)
14

Description

I'm opening this as a continuation of https://github.com/cppalliance/mrdocs/issues/826. I'm generating docs using MrDocs (this is, Doxygen comments transformed to asciidoc files with MrDocs, then transformed to HTML with Antora. When an operator is overloaded (e.g. copy/move assignment), it generates an overload page that includes links to each of the individual overloads. The link spans the entire function name (that is, `operator=`), but only the `=` part of the name is formatted as a link (as opposed to the entire `operator=`). There seems to be some contention with syntax highlighting, where highlight.js identifies `operator` as a keyword, overriding the link style.

The impact is that links seem to be not clickable.

I'll provide as much info as I can. Please feel free to request any missing details:

* What it's rendered:

![Image](https://github.com/user-attachments/assets/c910ce31-0cb1-4893-8a89-11a7471bd3e7)

* What should ideally be rendered (old toolchain - notice how the link spans the entire `operator=`):

![Image](https://github.com/user-attachments/assets/dfd05e8b-f79d-45a8-9b20-aec413eb51bb)

* Generated HTML:

```html




boost::mysql::row::operator= :: Boost.MySQL documentation





var uiRootPath = '../../../../../_'


















boost::mysql::row::operator=





Copy assignment.






Synopsis




Declared in <boost/mysql/row.hpp>





constexpr

row&
operator=(row const& other) = default;






constexpr

row&
operator=(row&& other) = default;









Description




Exception safety



Basic guarantee. Internal allocations may throw.





Object lifetimes



*this lifetime will be independent of other's. Iterators and references (including row_view's and field_view's) to elements in *this are invalidated.





Complexity



Linear on this‐>size() and other.size().




Created with MrDocs













```

Thanks,
Ruben.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.