File: strip_doc_comment_leads.Rd

package info (click to toggle)
r-cran-parsetools 0.1.3-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 780 kB
  • sloc: sh: 13; makefile: 2
file content (17 lines) | stat: -rw-r--r-- 553 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comments.R
\name{strip_doc_comment_leads}
\alias{strip_doc_comment_leads}
\title{Remove the characters identifying a documentation comment.}
\usage{
strip_doc_comment_leads(comment, rm.space = TRUE)
}
\arguments{
\item{comment}{The text of the comments or parse data.}

\item{rm.space}{should the space at the beginning of the line be removed.}
}
\description{
Remove the characters identifying a documentation comment as a
document comment leaving only the relevant text.
}