fix implementation of @slot

[tobias-verbeke]

The current implementation of @slot does not pass the Rd checks, primarily because
\section{Slots} should become \section{Slots}{...}. Some other improvements
are possible as well.

Current (erroneous) form

\section{Slots}
\itemize{
  \item{a}{Object of class \code{"numeric"}}
  \item{b}{Object of class \code{"character"}}
}

could become

\section{Slots}{
  \describe{
    \item{\code{a}:}{Object of class \code{"numeric"}.}
    \item{\code{b}:}{Object of class \code{"character"}.}
  }
}

[unDocUMeantIt]

the following seems to improve the situation (applied to the S4 branch), but i still get wierd errors, e.g. when trying to roxygenize() the XiMpLe package.

--- a/R/rd-tag-api.R
+++ b/R/rd-tag-api.R
@@ -33,7 +33,11 @@
 }

 #' @S3method format rd_tag
-format.rd_tag <- function(x, ...) stop("Unimplemented format")
+format.rd_tag <- function(x, ...) {
+  # somehow this gets triggered for format.slot_tag,
+  # this is only a workaround...
+  if(length(class(x)) == 1) stop("Unimplemented format")
+}

 #' @S3method merge rd_tag
 merge.rd_tag <- function(x, y, ...) {
@@ -126,11 +130,11 @@
 #' @S3method format slot_tag
 format.slot_tag <- function(x, ...) {
   names <- names(x$values)
-  items <- str_c("\\item{", names, "}{", x$values, "}", collapse = "\n\n")
-  str_c("\\section{Slots}\n\n",
-    "\\itemize{\n", 
+  items <- str_c("\\item{\\code{", names, "}:}{", x$values, "}", collapse = "\n\n")
+  str_c("\\section{Slots}{\n\n",
+    "\\describe{\n", 
     str_wrap(items, width = 60, exdent = 2, indent = 2),
-    "\n}\n")
+    "\n}}\n")
 }

[hadley]

See #85