Fix bad anchors in v2

[EmilyBourne]

Fix bad anchors created for:

• operator() (missing from OVERLOAD_OPERATORS)
• Any operators containing - as this character is preserved in the anchor
• Sections with template syntax in the name (e.g. MyClass<Specialisation, Specialization>)
• Sections with long names truncated to end with ...
• Any operator which is also overridden in a private zone (where the documentation is not extracted by doxygen)

This fixes #131

Summary by Sourcery

Correct anchor generation for operators and other section names in Markdown output

Bug Fixes:

• Include operator() in the overload list to generate its anchor
• Exclude private and hyphenated operators from skewing anchor numbering
• Handle section names with template syntax, long names truncated with '...', and hyphens correctly

Enhancements:

• Improve name_url_safe to strip special characters (=, ~, ., ',', '<', '>') before slugification
• Introduce hyphen-aware stem logic for operator overload numbering

[sourcery-ai]

Reviewer's Guide

This PR corrects anchor generation for overloaded operators by extending constant lists, sanitizing section names, and enhancing numbering logic to handle hyphens, template markers, truncation ellipses, and private overloads.

Sequence Diagram for Node Anchor Property Logic

sequenceDiagram
    title Sequence Diagram for Node Anchor Property Logic
    participant N as Node
    N->>N: .anchor (read property)
    activate N
    alt self._name in OVERLOAD_OPERATORS (updated list)
        N->>N: .operator_num (read property with new logic)
        activate N
        N-->>N: num (calculated operator index)
        deactivate N
        N-->>N: anchor_string (formatted for operator)
    else self.is_overloaded
        N->>N: .name_url_safe (read property with new sanitization)
        activate N
        N-->>N: safe_name
        deactivate N
        N-->>N: anchor_string (formatted for overload)
    else
        N->>N: .name_url_safe (read property with new sanitization)
        activate N
        N-->>N: safe_name
        deactivate N
        N-->>N: anchor_string (formatted for basic name)
    end
    deactivate N

Loading

Updated Class Diagram for Node and ConstantsModule

classDiagram
    title Updated Class Diagram for Node and Constants
    class Node {
        +operator_num: int
        +name_url_safe: str
        +anchor: str
    }
    class ConstantsModule {
        <<module>>
        +OVERLOAD_OPERATORS: List~String~
    }
    Node ..> ConstantsModule : uses OVERLOAD_OPERATORS

Loading

File-Level Changes

Change	Details	Files
Include missing operators in the overload list	Add "operator()" to the OVERLOAD_OPERATORS constant	mkdoxy/constants.py
Refine operator counting and anchor logic to handle hyphens and private overloads	Introduce a stem based on hyphens in the operator name Replace simple membership check with conditions for list inclusion, prefix matching, hyphen exclusion, and visibility filtering Branch anchor formatting to distinguish operators with '-' prefixes	mkdoxy/node.py
Improve URL-safe name generation to strip special and truncation characters	Use regex to remove =, ~, ., , , <, > from section names Trim surrounding whitespace and convert remaining spaces to hyphens	mkdoxy/node.py

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#131	Fix broken links for operator()	✅
#131	Fix broken links for operators containing -	✅
#131	Fix broken links for templated variables	✅

Possibly linked issues

• Bad links in generated files #131: PR fixes anchors for operator(), operators with -, and templates mentioned in the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.