# ide.doc.library 库模块帮助文档

## ide.doc 成员列表 <a id="ide.doc" href="#ide.doc">&#x23;</a>

### ide.doc.library("库路径") <a id="ide.doc.library" href="#ide.doc.library">&#x23;</a>
解析参数 @1 指定库源码包含的智能提示数据，  
返一个表对象，包含了生成库参考文档的结构信息。  

注意返回的表结构中一些返回对象名称进行了调整，  
例如 `!` 前缀的对象会移除`!` 并转换为小驼峰命名风格，然后添加 `Object` 后缀。  
返回对象名称前面的 std 前缀通常也会被移除。  

如果需要直接获取 Markdown 格式文档请改用 ide.doc.libraryMd 。  
ide.doc.libraryMd 内部调用  ide.doc.library 并将解析结果转换为 Markdown 格式。

### ide.doc.library() <a id="ide.doc.library" href="#ide.doc.library">&#x23;</a>
[返回对象:libDocumentObject](#libDocumentObject)

## libDocumentObject 成员列表 <a id="libDocumentObject" href="#libDocumentObject">&#x23;</a>

### libDocumentObject.const <a id="libDocumentObject.const" href="#libDocumentObject.const">&#x23;</a>
::开头的全局函数列表

### libDocumentObject.define <a id="libDocumentObject.define" href="#libDocumentObject.define">&#x23;</a>
智能提示中配置自动完成为字面值的全局常量列表  
一律为下划线开始,并大写的常量名

### libDocumentObject.details <a id="libDocumentObject.details" href="#libDocumentObject.details">&#x23;</a>
补充文档

### libDocumentObject.detailsSummary <a id="libDocumentObject.detailsSummary" href="#libDocumentObject.detailsSummary">&#x23;</a>
补充文档标题

### libDocumentObject.documentPath <a id="libDocumentObject.documentPath" href="#libDocumentObject.documentPath">&#x23;</a>
以"/library-reference/"开始的库参考文档路径

### libDocumentObject.fileName <a id="libDocumentObject.fileName" href="#libDocumentObject.fileName">&#x23;</a>
移除后缀名的库文件相对路径

### libDocumentObject.filePath <a id="libDocumentObject.filePath" href="#libDocumentObject.filePath">&#x23;</a>
库文件路径

### libDocumentObject.guide <a id="libDocumentObject.guide" href="#libDocumentObject.guide">&#x23;</a>
库使用指南链接

### libDocumentObject.libPath <a id="libDocumentObject.libPath" href="#libDocumentObject.libPath">&#x23;</a>
命名空间路径

### libDocumentObject.sections <a id="libDocumentObject.sections" href="#libDocumentObject.sections">&#x23;</a>
智能提示数据  
键为命名空间,值是一个名值对组成的表
