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

How to write tags and where to look for existing (non standard) ones? #878

Closed
mamueller opened this issue Jul 10, 2019 · 1 comment
Closed

Comments

@mamueller
Copy link

As a concrete project, I would like to extend the functionality of the documentation for R4 classes and methods a little bit, if only to document my own code.

Use cases are for example:

  • a list of constructors for a certain class automatically linked to the class
  • automatic links to methods that are documented separately both from the class and the generic
    ...
    From a first glance at the roxygen2 code I assume that writing my own 'tags' would be a fairly nonintrusive way to achieve this.
    If this is indeed the case it seems reasonable that other people had similar ideas and wrote their own tags. But I could not find any.
    Are there any resources about how to find or make one's own tags apart from the source code of the implemented tags?

Thanks for your time and the huge amount of work already done

@hadley
Copy link
Member

hadley commented Jul 21, 2019

There isn't currently, but I just filed an issue so we eventually write something about this: #882

@hadley hadley closed this as completed Jul 21, 2019
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