che-server/docs/_docs/artik-ide-plugin/artik-api-docs.md

19 lines
881 B
Markdown

---
tags: [ "eclipse" , "che" ]
title: API Docs
excerpt: ""
layout: artik
permalink: /:categories/api-docs/
---
Artik IDE provides API docs for a particular SDK version installed in a developer workspace. Included in these documents are many useful code examples which are provide in ARTIK sample project **Workspace > Create Project > artik-samples** .
Docs are available in the right side tab or at **Artik > Show API Documentation** in the menu bar.
![artikapi.jpg]({{ base }}/assets/imgs/artikapi.jpg)
# Context Sensitive Help
Select any Artik specific keyword (function name, object etc) and press **Ctrl + Q**. A new tab will be opened (you may need to allow popups from Artik IDE in your browser) to display docs for a selected keyword. If nothing is found in a selected keyword, an error message will pop up.
![artikctrlq.jpg]({{ base }}/assets/imgs/artikctrlq.jpg)