Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Failed to find xref for custom objects #7

Open
red8888 opened this issue Feb 1, 2022 · 2 comments
Open

Failed to find xref for custom objects #7

red8888 opened this issue Feb 1, 2022 · 2 comments

Comments

@red8888
Copy link

red8888 commented Feb 1, 2022

I'm seeing a bunch of WARNINGs like this when using doxygenindex in my rst:

/Users/me/myapp/docs/index.rst:35: WARNING: Failed to find xref for: IActionResult, no objects found that end like this, searched in object types: ['class', 'struct', 'interface', 'function', 'var', 'event', 'enum']
/Users/me/myapp/docs/index.rst:35: WARNING: Failed to find xref for: CancellationToken, no objects found that end like this, searched in object types: ['class', 'struct', 'interface', 'function', 'var', 'event', 'enum']
/Users/me/myapp/docs/index.rst:35: WARNING: Failed to find xref for: ILogger, no objects found that end like this, searched in object types: ['class', 'struct', 'interface', 'function', 'var', 'event', 'enum']

Is this a doxygen issue or an issue with this sphinx plugin? Is it not able to find the libraries for these classes or something?

@rogerbarton
Copy link
Owner

rogerbarton commented Feb 2, 2022

It just means that IActionResult won't link to anything when you click on it. Generally, this is when the object has not been declared in your code, e.g. library code. Or it is because of some special case in the syntax, which isn't covered.

For library types you can specify external links in the conf.py, see https://github.com/rogerbarton/vr-modeling/blob/126ec548285ab639a9002235d7530c0e65b7688a/conf.py#L84-L115 for an example. If it is not clear you can ask me :)

I hope this clears up the issue

@rogerbarton
Copy link
Owner

@red8888 Did you find a solution? Can I close this issue now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants