This task demonstrates how to build the SDK API documentation from the
checked out source code.
You need to install AppleDoc if you want to build the stand-alone API Reference
documentation.
This task shows you how to build the SDK API documentation. Note the documentation is
usually built by default, unless you use the --no-docs option when using
build_package.sh.
- From the directory you checked out the SDK source to, change into the SkyVaultSDK directory.
-
Run the shell script ./scripts/build_appledoc.sh.
The script will parse the source code and generate API documentation.
- Load ./build/Help/html/index.html into your web browser to read the documentation.
You have now built the SDK API documentation.