@eagleoutice/flowr - v2.13.14
Preparing search index...
src/linter/rules/roxygen-arguments
ROXYGEN_ARGS
Variable ROXYGEN_ARGS
Const
ROXYGEN_ARGS
:
{
createSearch
:
()
=>
FlowrSearchBuilderOut
<
"all"
,
[
"filter"
]
,
ParentInformation
,
"with"
,
>
;
info
:
{
certainty
:
BestEffort
;
defaultConfig
:
{}
;
description
:
"Checks whether a function has undocumented or overdocumented parameters"
;
name
:
"Roxygen Arguments"
;
tags
:
readonly
[
Smell
,
Documentation
,
Style
]
;
}
;
prettyPrint
:
{
full
:
(
result
:
RoxygenArgsResult
)
=>
string
;
query
:
(
result
:
RoxygenArgsResult
)
=>
string
;
}
;
processSearchResult
:
(
elements
:
FlowrSearchElements
<
ParentInformation
,
FlowrSearchElement
<
(...)
>
[]
,
>
,
_config
:
MergeableRecord
,
)
=>
{
".meta"
:
{}
;
results
:
Writable
<
(...)
>
[]
}
;
}
= ...
Type Declaration
Readonly
createSearch
:
()
=>
FlowrSearchBuilderOut
<
"all"
,
[
"filter"
]
,
ParentInformation
,
"with"
>
Readonly
info
:
{
certainty
:
BestEffort
;
defaultConfig
:
{}
;
description
:
"Checks whether a function has undocumented or overdocumented parameters"
;
name
:
"Roxygen Arguments"
;
tags
:
readonly
[
Smell
,
Documentation
,
Style
]
;
}
Readonly
prettyPrint
:
{
full
:
(
result
:
RoxygenArgsResult
)
=>
string
;
query
:
(
result
:
RoxygenArgsResult
)
=>
string
;
}
Readonly
processSearchResult
:
(
elements
:
FlowrSearchElements
<
ParentInformation
,
FlowrSearchElement
<
(...)
>
[]
,
>
,
_config
:
MergeableRecord
,
)
=>
{
".meta"
:
{}
;
results
:
Writable
<
(...)
>
[]
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@eagleoutice/flowr - v2.13.14
Loading...