如何使用 Core Plot 的 API 帮助文档

Core Plot 可是 iOS 下绝好的图表组件,虽说它的相关资料不甚丰富,特别是中文的,英文的还是有几篇不错的文章,不过 Core Plot 自身提供的 API 帮助文档,以及代码示例其实很有用的,不妨且在英文的(注意是英文的) Google 中输入 core plot, 即时搜索出的第一页里的链接很有价值的。

对于 Core Plot 中文资料的缺乏相信很快就会有改观的,譬如说不还有不少像敝人那样的工作者正努力着吗!

既然 Core Plot 为我们提供了文档,那我们就该好好利用好它内在的东西。都是在下载的 CorePlot_0.4.zip 解压后的 CorePlot_0.4 目录中的,Source/examples 下有周到的示例代码,Source/framework  中源代码; Documentation  中便是我们可以查阅的 Core Plot 的 API 帮助文档,有两种使用方式,导入到 Xcode 和浏览器阅读。

1. 集成到 Xcode 的 Organizer-Documentation

在 Mac OS X 中,如果你安装了 Xcode 的话,在 Finder 中看到的 Documentation 目录就是下面那样子:

CorePlot API Unmi

 我们可以看到有两个文件 com.CorePlot.Framework.docset 和 com.CorePlotTouch.framework.docset,假如双击打开它,用了 Xcode 的程序打开,也只能看到右边那个几本书的图标,那我们该如何阅读它呢,办法是把那两个文件拷入到 Xcode 的文档目录,一般是 /Developer/Documentation/DocSets/ 目录。完了之后就可以在 Xcode 的 Organizer-Documentation 窗口中查看 Core Plot 的 API 了。

CorePlot API Unmi

把帮助文档导入到了 Xcode 之后,可以结合 Xcode 功能快速定位到 API 帮助页面,如 Ctrl+Option+Command+/ 快捷键。

以后在 Mac OS X 下看到 docset 文件要多留份心了,它可能(也应该) 是 Xcode 的帮助文档集,而且从图中也能看到它可以用 doxygen 这个工作来制作生成。

2. 直接用浏览器浏览帮助文档

前面讲的当系统安装了 Xcode 之后,你看到的那两个 com.CorePlot.Framework.docset 和 com.CorePlotTouch.framework.docset 都是文件,其实它们是目录,反正你要信的,不信你就用 Windows 资源管理器来查看,保证它们目录的原形毕露,而且它们之下还有子目录 Contents/Resources/Documents,只要用浏览器打开 Contents/Resources/Documents 中的某一个 HTML 文件就可以看到这样的景象:

CorePlot API Unmi

这样就可以在浏览器中直接查看 API 了。

本文链接 https://yanbin.blog/how-to-use-coreplot-apidoc/, 来自 隔叶黄莺 Yanbin Blog

[版权声明] Creative Commons License 本文采用 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 进行许可。

Subscribe
Notify of
guest

0 Comments
Inline Feedbacks
View all comments