Appledoc无法在Xcode中运行

时间:2014-12-02 21:39:51

标签: ios xcode bash shell appledoc

所以我按照本教程进行appledoc生成(http://objcsharp.wordpress.com/2013/09/24/how-to-generate-beautiful-apple-style-documentation-in-xcode-5/)。构建后没有任何事情发生。这是脚本:

#if [ ${CONFIGURATION} == "Release" ]; then
APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \
--project-name ${PRODUCT_NAME} \
--project-company "Your Name" \
--company-id "com.yourcompany" \
--output ${PRODUCT_NAME}Docs \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
${PROJECT_DIR}/${PRODUCT_NAME}
fi;
#fi; 

为了确保我正确安装appledoc,我在终端上执行了以下操作,文档显示正常。

appledoc --project-name BabelCPP --project-company "My Name" --company-id com.mycompany --no-create-docset --output ./doc/ ./CaterpillarCount/CaterpillarCount

我是否错过了Xcode中的任何关键步骤或设置?看起来以下部分没有正确执行,它终止了这个运行脚本:

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \

1 个答案:

答案 0 :(得分:2)

OSX上的默认路径为/usr/bin:/bin:/usr/sbin:/sbin,如果您按照说明操作,则会将其复制到/usr/local/bin

XCode不会考虑您在.bash_profile文件等中添加的更改,因此从其中启动的任何内容都不会有路径(包括运行脚本)你发布了。)

您可以在PATH=$PATH:/usr/local/bin行之前的行上添加APPLEDOC_PATH=...,这样就可以找到它。

其次,您需要进行适当的测试:

if [ -n "$APPLEDOC_PATH" -a -x "$APPLEDOC_PATH" ]; then

即。测试该变量是否已设置,以及该文件是否可由其确定。

所以,总之:

PATH=$PATH:/usr/local/bin
APPLEDOC_PATH=`which appledoc`
if [ -n "$APPLEDOC_PATH" -a -x "$APPLEDOC_PATH" ]; then