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

Invalid reference method error for standard words - possible to escape automatic cross-referencing? #348

Open
tyrin opened this issue May 3, 2013 · 5 comments
Labels

Comments

@tyrin
Copy link

tyrin commented May 3, 2013

I'm getting Invalid reference method errors when I use the word "object" or "error" in a class description. For example:
"ThisClass corresponds to the Resource object in the RESTful web service."
generates the error message:
WARN | Invalid [object resourcePath] reference found near ThisClass.h@12, unknown object : error !

I do not want to turn off automatic cross references. I just want a way to be able to use specific words without generating errors. This would also make sense for people who want to reference methods/objects (such as those in Cocoa or other frameworks), that they don't actually want to create cross references to.
(You'll see this is similar to issue #82, so this has come up previously).

@tomaz
Copy link
Owner

tomaz commented May 4, 2013

The warning you get is likely from using brackets like this: [object resourcePath]. Current version doesn't handle this too well, especially when inside code blocks (where it should ignore everything alltogether). Version 3 handles this much better, but is not yet ready for usage. This is likely linked with #72 too.

@tyrin
Copy link
Author

tyrin commented May 6, 2013

The reference was in standard markdown comment tags, not inside brackets. I was talking about automatic conversion of specific words into automatic cross references.

From: tomaz [mailto:notifications@github.com]
Sent: Saturday, May 04, 2013 2:52 AM
To: tomaz/appledoc
Cc: Tyrin Avery
Subject: Re: [appledoc] Invalid reference method error for standard words - possible to escape automatic cross-referencing? (#348)

The warning you get is likely from using brackets like this: [object resourcePath]. Current version doesn't handle this too well, especially when inside code blocks (where it should ignore everything alltogether). Version 3 handles this much better, but is not yet ready for usage. This is likely linked with #72#72 too.


Reply to this email directly or view it on GitHubhttps://github.com//issues/348#issuecomment-17428913.

This e-mail message and all attachments transmitted with it may contain privileged and/or confidential information intended solely for the use of the addressee(s). If the reader of this message is not the intended recipient, you are hereby notified that any reading, dissemination, distribution, copying, forwarding or other use of this message or its attachments is strictly prohibited. If you have received this message in error, please notify the sender immediately and delete this message, all attachments and all copies and backups thereof.

@tyrin
Copy link
Author

tyrin commented May 10, 2013

Would it be helpful for me to post examples?

@tomaz
Copy link
Owner

tomaz commented May 11, 2013

Yes, you can post example file (or fraction if it's long one).

@rsanchezsaez
Copy link
Contributor

A workaround for this issue is now possible on the referenced pull request.

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

No branches or pull requests

3 participants