Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support for overwriting <see cref> link text

See original GitHub issue

Feature request: Support for overwriting <see cref> link text

I’d like to be able to overwrite the link text generated by <see cref>s.

For example, I would like:

/// If the animal <see cref:AnimalType.IsDog>is a dog</see>...

To render as:

“If the animal is a dog…”

Issue Analytics

State:
Created 6 years ago
Reactions:3
Comments:9 (3 by maintainers)

Top GitHub Comments

1reaction

superyyrrzzcommented, Mar 11, 2019

IMO I do not want to extend the syntax as defined in documentation. By the way, you can use DFM’s syntax like [is a dog](xref:AnimalType.IsDog).

0reactions

stale[bot]commented, Jun 18, 2019

Closing this issue after a prolonged period of inactivity. If you still think this issue is relevant, please feel free to ping a maintainer or leave a comment.

Top Results From Across the Web

cleveref and customized refname

You asked,. Is it possible with cleveref to customize on the fly the name in the clickable link? Short answer: Yes.

Can I replace the value of the <see cref=""> documentation ...

I created a proposal over at the C# Language Design repository over at GitHub and a proposal for similar functionality can be found...

The cleveref package

Abstract. The cleveref package enhances LATEX's cross-referencing features, allowing the format of cross-references to be determined ...

Documentation comments

This chapter describes XML comments that are used to document your program.

Using the <inheritdoc /> Tag

cref ="link-ref". This optional attribute overrides the standard search method to allow documentation inheritance from an alternate user-specified member ...