Skip to content

Commit

Permalink
Fix latex documentation in sournce R files.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbjones committed Feb 23, 2024
1 parent cbb0a6c commit cb51231
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 40 deletions.
8 changes: 4 additions & 4 deletions R/redland/R/Model.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
#' @keywords classes
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Model-initialize}}}{: Initialize a Model object}
#' \item{\code{\link{addStatement}}}{: Add a Statement object to the Model}
#' \item{\code{\link{freeModel}}}{: Free memory used by a librdf model object}
#' \code{\link{Model-initialize}}: Initialize a Model object
#' \code{\link{addStatement}}: Add a Statement object to the Model
#' \code{\link{freeModel}}: Free memory used by a librdf model object
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @export
#' @examples
#' world <- new("World")
Expand Down
10 changes: 5 additions & 5 deletions R/redland/R/Node.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
#' @export
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Node-initialize}}}{: Initialize a Node object.}
#' \item{\code{\link{getNodeType}}}{: Determine the node type and return as a string.}
#' \item{\code{\link{getNodeValue}}}{: Determine the node type and return as a string.}
#' \item{\code{\link{getBlankNodeId}}}{: Get the value of the node as a string.}
#' \code{\link{Node-initialize}}: Initialize a Node object.
#' \code{\link{getNodeType}}: Determine the node type and return as a string.
#' \code{\link{getNodeValue}}: Determine the node type and return as a string.
#' \code{\link{getBlankNodeId}}: Get the value of the node as a string.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' # a blank node is created with a unique identifier generated by librdf
Expand Down
8 changes: 4 additions & 4 deletions R/redland/R/Parser.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@
#' @export
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Parser-initialize}}}{: Initialize a Parser object.}
#' \item{\code{\link{parseFileIntoModel}}}{: Parse the contents of a file into a model.}
#' \item{\code{\link{freeParser}}}{: Free memory used by a librdf parser.}
#' \code{\link{Parser-initialize}}: Initialize a Parser object.
#' \code{\link{parseFileIntoModel}}: Parse the contents of a file into a model.
#' \code{\link{freeParser}}: Free memory used by a librdf parser.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' storage <- new("Storage", world, "hashes", name="", options="hash-type='memory'")
Expand Down
16 changes: 8 additions & 8 deletions R/redland/R/Query.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@
#' @references www.example.com
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Query-initialize}}}{: Initialize a Query object.}
#' \item{\code{\link{executeQuery}}}{: Execute a query.}
#' \item{\code{\link{setQueryResultLimit}}}{: Set limit on returned query results.}
#' \item{\code{\link{getQueryResultLimit}}}{: Get the query result limit.}
#' \item{\code{\link{getResults}}}{: Return all query results.}
#' \item{\code{\link{writeResults}}}{: Write query results to a file.}
#' \item{\code{\link{freeParser}}}{: Free memory used by a librdf query.}
#' \code{\link{Query-initialize}}: Initialize a Query object.
#' \code{\link{executeQuery}}: Execute a query.
#' \code{\link{setQueryResultLimit}}: Set limit on returned query results.
#' \code{\link{getQueryResultLimit}}: Get the query result limit.
#' \code{\link{getResults}}: Return all query results.
#' \code{\link{writeResults}}: Write query results to a file.
#' \code{\link{freeParser}}: Free memory used by a librdf query.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' storage <- new("Storage", world, "hashes", name="", options="hash-type='memory'")
Expand Down
6 changes: 3 additions & 3 deletions R/redland/R/QueryResults.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@
#' @export
#' @section Methods:
#' \itemize{
#' \item{\code{\link{QueryResults-initialize}}}{: Initialize a QueryResults object.}
#' \item{\code{\link{freeQueryResults}}}{: Free memory used by a librdf query result.}
#' \code{\link{QueryResults-initialize}}: Initialize a QueryResults object.
#' \code{\link{freeQueryResults}}: Free memory used by a librdf query result.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
setClass("QueryResults", slots = c(librdf_query_results = "_p_librdf_query_results"))

#' Initialize the QueryResults object.
Expand Down
12 changes: 6 additions & 6 deletions R/redland/R/Serializer.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@
#' @export
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Serializer-initialize}}}{: Initialize a Serializer object.}
#' \item{\code{\link{setNameSpace}}}{: Set a namespace for the serializer.}
#' \item{\code{\link{serializeToCharacter}}}{: Serialize a model to a character vector.}
#' \item{\code{\link{serializeToFile}}}{: Serialize a model to a file.}
#' \item{\code{\link{freeSerializer}}}{: Free memory used by a librdf serializer.}
#' \code{\link{Serializer-initialize}}: Initialize a Serializer object.
#' \code{\link{setNameSpace}}: Set a namespace for the serializer.
#' \code{\link{serializeToCharacter}}: Serialize a model to a character vector.
#' \code{\link{serializeToFile}}: Serialize a model to a file.
#' \code{\link{freeSerializer}}: Free memory used by a librdf serializer.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' storage <- new("Storage", world, "hashes", name="", options="hash-type='memory'")
Expand Down
8 changes: 4 additions & 4 deletions R/redland/R/Statement.R
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@
#' \code{objectType} parameters can be specified to explicitly set the RDF types.
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Statement-initialize}}}{: Initialize a Statement object.}
#' \item{\code{\link{getTermType}}}{: Return the redland node type for the specified RDF term in a statement.}
#' \item{\code{\link{freeStatement}}}{: Free memory used by a librdf statement.}
#' \code{\link{Statement-initialize}}: Initialize a Statement object.
#' \code{\link{getTermType}}: Return the redland node type for the specified RDF term in a statement.
#' \code{\link{freeStatement}}: Free memory used by a librdf statement.
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' # Create nodes manually and add to the statment
Expand Down
6 changes: 3 additions & 3 deletions R/redland/R/Storage.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
#' @keywords classes
#' @section Methods:
#' \itemize{
#' \item{\code{\link{Storage-initialize}}}{: Initialize a Storage object}
#' \item{\code{\link{freeStorage}}}{: Free memory used by a librdf storage object}
#' \code{\link{Storage-initialize}}: Initialize a Storage object
#' \code{\link{freeStorage}}: Free memory used by a librdf storage object
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @export
#' @examples
#' world <- new("World")
Expand Down
6 changes: 3 additions & 3 deletions R/redland/R/World.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
#' @useDynLib redland, .registration = TRUE
#' @section Methods:
#' \itemize{
#' \item{\code{\link{World-initialize}}}{: Initialize a World object}
#' \item{\code{\link{freeWorld}}}{: Free memory used by a librdf world object}
#' \code{\link{World-initialize}}: Initialize a World object
#' \code{\link{freeWorld}}: Free memory used by a librdf world object
#' }
#' @seealso \code{\link{redland}}{: redland package}
#' @seealso \code{\link{redland}}: redland package
#' @examples
#' world <- new("World")
#' @import methods
Expand Down

0 comments on commit cb51231

Please sign in to comment.