inst/example/R/example.R

#' @title Documentation example for `maxygen`
#'
#' @description
#' Note that you explicitly need to use `@@title`, `@@description` and
#' also `@@details`.
#'
#' @details
#' We test each feature here.
#'
#' @section Simple markup:
#' This is **strong** and there are *both* _emphasized_, probably as
#' italic.
#'
#' @section List:
#' Bulleted list:
#' * First item.
#' * Second item.
#'
#' Numbered list:
#' 1. Fist item.
#' 1. Second item.
#'
#' Nested lists:
#' * Bulleted item containing
#'     1. a numbered
#'     1. list.
#' * Another bulleted item.
#'
#' Nested lists of the same kind:
#' * Bulleted first
#'     * containing
#'     * another bulleted
#' * Bulleted second.
#'
#' 1. Numbered first,
#'     1. containing
#'     1. another numbered.
#' 1. Numbered second.
#'
#' @section Code:
#'
#' Inline code is simple like `2 times 2`. Code blocks are also easy:
#' ```
#' markdown <- function(text, tags) {
#'   md <- markdown_xml(text, hardbreaks = TRUE)
#'   xml <- read_xml(md)
#'   trim(markdown_rparse(xml, tags))
#' }
#' ```
#'
#' @section Links:
#' Link to another manual page: [](::MD2).
#' Link to a manual page from another package: [](maxygen::macument).
#'
#' This is a link in the text. Look at [this function](::=MD2).
#' Also look at [this function in maxygen](maxygen::macument).
#'
#' It is possible to make text links verbatim, [`like this`](::=MD2).
#' Even if they refer to another package,
#' [`like this`](maxygen::macument).
#' With quotes: [`"like this"`](maxygen::macument).
#'
#' This is just a hyperlink: [http://igraph.org]().
#' This is another hyperlink: [igraph](http://igraph.org).
#'
#' @param x Markdown is **allowed** for parameters _as well_.
#' @return This is a _return value_.
#'
#' @note
#' Markdown can be used within a _note_, **of course**.
#'
#' @author
#' This was written by _Bugs Bunny_, so don't blame me.
#'
#' @export
#' @family maxygen examples
#' @seealso Don't forget to read _Writing R extensions_. Here is a link:
#'   [https://cran.r-project.org/doc/manuals/r-release/R-exts.html]().

MD <- function(x) {
  "Keep Cool and MarkDown!"
}

#' Another example, to have a family
#'
#' @param x This is ignored, sorry.
#'
#' @family maxygen examples
#' @export

MD2 <- function(x) {
  "Still looking cool!"
}
gaborcsardi/maxygen documentation built on May 16, 2019, 4:11 p.m.