Skip to content

Commit

Permalink
docs/API_reference: use doxygen html instead of pdf
Browse files Browse the repository at this point in the history
Html is better than pdf to use API reference.
  • Loading branch information
sunghan-chang committed Nov 14, 2017
1 parent 105d01b commit e1fc8e2
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/API_Reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# API Reference

There are two types of API references, libs & env and public.
Extract zipped files, libs_env.tar.gz and public.tar.gz.
```
tar -xvzf libs_env.tar.gz
tar -xvzf public.tar.gz
```

These two topics are splitted temporarilliy and will be reorganized.

## Libs & Env

The libs & env has kernel APIs, file system APIs, network APIs and so on.
Please find it under *v1.1/libs_env/html* folder and execute index.html.

# Public

The public has framework APIs like database - arastorage, device management, iotbus, SmartThings Things SDK, audio and wifi manager.
Please find it under *v1.1/public/html* folder and execute index.html.
Binary file not shown.
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/API_Reference/v1.1/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/libs_env
/public
Binary file added docs/API_Reference/v1.1/libs_env.tar.gz
Binary file not shown.
Binary file added docs/API_Reference/v1.1/public.tar.gz
Binary file not shown.

0 comments on commit e1fc8e2

Please sign in to comment.