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

what about @link? #19

Closed
yihui opened this issue Jul 27, 2011 · 3 comments
Closed

what about @link? #19

yihui opened this issue Jul 27, 2011 · 3 comments
Labels
feature a feature request or enhancement

Comments

@yihui
Copy link
Contributor

yihui commented Jul 27, 2011

I often write \code{\link[pkg]{function_name}} in the documentation, so I would love to see something like @link pkg:function_name in roxygen (when pkg is omitted, we just generate \code{\link{function_name}}). This is similar to @family but allows cross references to other packages. If @link is implemented, we may want it to be automatically put into \seealso{} as well.

Currently it is still not completely clear to me how to register a custom parser like this.

@hadley
Copy link
Member

hadley commented Jul 27, 2011

We talked about this a bit over email. I think it needs a slightly different syntax because it would be an inline tag, not a block tag. We couldn't think of any other use cases for inline tags, so we didn't make much progress on it.

@hadley
Copy link
Member

hadley commented Aug 16, 2011

An inline tag (borrowing the syntax from javadoc) would look like {@link pkg function}.

@hadley
Copy link
Member

hadley commented Sep 17, 2012

Moved to hadley/roxygen3#12

@hadley hadley closed this as completed Sep 17, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants