nuget
Parser of the Project assembly
AnnotationDocs
01 Syntax
SMRUCC.Rsharp.Development.AnnotationDocs
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| GetAnnotations | 2 | |
| get_clr_xml_document | 1 | a helper function for get the xml comment document for a given dll file |
| PrintHelp | 1 | Print help information about the given R api method |
03 Members
GetAnnotations(
Type)get xml document of a given clr type
Parameters
| Name | Type | Description |
|---|---|---|
package | Type | - |
GetAnnotations(
MethodInfo, Boolean)Parameters
| Name | Type | Description |
|---|---|---|
func | MethodInfo | - |
requireNoneNull | Boolean | 默认当没有做注释的时候，这个函数会返回空值 反之这个参数为TRUE的时候会返回空文档对象实例 |
get_clr_xml_document(
Assembly)a helper function for get the xml comment document for a given dll file
Parameters
| Name | Type | Description |
|---|---|---|
assembly | Assembly | - |
Returns
the file path to the xml document file, could be nothing if not found
PrintHelp(RMethodInfo, RContentOutput)
Print help information about the given R api method
Parameters
| Name | Type | Description |
|---|---|---|
api | RMethodInfo | - |