Skip to content

Commit

Permalink
added index file to API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
PrimaryFeather committed Jul 4, 2014
1 parent e71b36f commit 7385c6a
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions sparrow/doc/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,27 @@

# This script creates a nice API reference documentation for the Sparrow source
# and installs it in Xcode.
#
# To execute it, you need the "AppleDoc"-tool. Download it here:
#
# To execute it, you need the "AppleDoc"-tool. Download it here:
# http://www.gentlebytes.com/home/appledocapp/

echo "Please enter the version number (like '1.0'), followed by [ENTER]:"
read version
if [ $# -ne 1 ]
then
echo "Usage: `basename $0` [version]"
echo " (version like '1.0')"
exit 1
fi

version=$1
index_file=index.md

# write temporary index file

echo "**The Open Source Game Engine for iOS, v$version**" > $index_file
echo "" >> $index_file
echo "* Homepage: [www.sparrow-framework.org](http://www.sparrow-framework.org)" >> $index_file
echo "* Forum: [forum.sparrow-framework.org](http://forum.sparrow-framework.org)" >> $index_file
echo "* Wiki: [wiki.sparrow-framework.org](http://wiki.sparrow-framework.org)" >> $index_file

appledoc \
--project-name "Sparrow Framework" \
Expand All @@ -17,6 +32,7 @@ appledoc \
--explicit-crossref \
--ignore ".m" \
--ignore "_Internal.h" \
--index-desc "index.md" \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
Expand All @@ -33,5 +49,7 @@ appledoc \
--output . \
../src/Classes

rm $index_file

echo
echo "Finished."

0 comments on commit 7385c6a

Please sign in to comment.