Skip to content

Commit 01769db

Browse files
ReadMe file for generating API documentation (#260)
* readme * readme updated * folder named changed to docs
1 parent 645b319 commit 01769db

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Generate API Documentation
2+
### Steps
3+
* Download [doxygen]( http://www.stack.nl/~dimitri/doxygen/download.html) and open it.
4+
* Move Doxygen.app to /Applications folder.
5+
* Open Doxygen from Launchpad.
6+
* Select **/Applications** folder in working directory.
7+
* Select SDK root directory in source code directory.
8+
* Select **objective-c-sdk/API Docs** in Destination Directory.
9+
* Navigate to **RUN** tab and press **Run doxygen**.
10+
* This will generate HTML documentation in **objective-c-sdk/API Docs** directory.
11+
* Browse **objective-c-sdk/API Docs/HTML/index.html** in browser.

0 commit comments

Comments
 (0)